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:
21
changelog.md
21
changelog.md
@@ -1,5 +1,26 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-08-05 - 2.0.0 - BREAKING_CHANGE(api)
|
||||
Major API cleanup and comprehensive documentation overhaul
|
||||
|
||||
### BREAKING CHANGES
|
||||
- **Removed deprecated methods**: `getChangeScoreForString()` and `getClosestMatchForString()` are no longer available
|
||||
- **Use modern API instead**: `calculateScores()` and `findClosestMatch()` respectively
|
||||
- **Improved type safety**: `findClosestMatch()` now correctly returns `string | null`
|
||||
|
||||
### Features
|
||||
- **Comprehensive documentation**: Complete readme overhaul with professional examples
|
||||
- **New sections added**: Quick Start, Performance Guide, Error Handling, Troubleshooting, API Reference
|
||||
- **Real-world examples**: Search-as-you-type, data deduplication, e-commerce search, recommendations
|
||||
- **Browser compatibility info**: Environment requirements and bundle size details
|
||||
- **Advanced configuration**: Fuse.js customization guidance
|
||||
|
||||
### Improvements
|
||||
- **Enhanced error handling**: Better graceful degradation patterns
|
||||
- **Performance guidance**: Time complexity analysis and optimization tips
|
||||
- **Modern developer experience**: Updated examples with current best practices
|
||||
- **Type-safe APIs**: Consistent null handling across all methods
|
||||
|
||||
## 2025-05-13 - 1.1.10 - fix(documentation)
|
||||
Update documentation and migration guide with standardized method names and deprecation notices.
|
||||
|
||||
|
Reference in New Issue
Block a user