BREAKING_CHANGE(api): Remove deprecated methods and enhance documentation

- Remove deprecated getChangeScoreForString() and getClosestMatchForString() methods
- Improve type safety with correct return types (string | null)
- Add comprehensive documentation with performance guide, error handling, and real-world examples
- Include browser compatibility info, troubleshooting, and API reference sections
- Modernize developer experience with current best practices
This commit is contained in:
2025-08-05 13:42:40 +00:00
parent afbeb7456f
commit 58109bd7e0
6 changed files with 1875 additions and 500 deletions

View File

@@ -1,6 +1,6 @@
{
"name": "@push.rocks/smartfuzzy",
"version": "1.1.10",
"version": "2.0.0",
"private": false,
"description": "A library for fuzzy matching strings against word dictionaries or arrays, with support for object and article searching.",
"main": "dist_ts/index.js",
@@ -14,9 +14,9 @@
"buildDocs": "tsdoc"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.27",
"@git.zone/tsbuild": "^2.6.4",
"@git.zone/tsrun": "^1.3.3",
"@git.zone/tstest": "^1.0.57",
"@git.zone/tstest": "^2.3.2",
"@push.rocks/tapbundle": "^6.0.3",
"@types/node": "^22.15.17"
},