kentcdodds/match-sorter
Match Sorter
match-sorter is a JavaScript string matching and array filtering utility designed to rank and sort lists based on search string relevance. It functions as a deterministic best-match sorting library and fuzzy search engine for filtering object arrays.
The tool prioritizes results using weighted match heuristics that favor exact matches, acronyms, and string containment. It employs a deterministic ranking system to ensure consistent ordering and supports diacritic-insensitive normalization to match characters regardless of accents.
The library covers match criteria specification via key-path property extraction, match threshold configuration for adjusting search strictness, and the extraction of ranking metadata. It also provides customizable sorting logic through external comparison functions to override default tie-breaking.
Features
- Client-Side Search Filtering - Provides a specialized utility for implementing search boxes and list filtering in JavaScript applications.
- Fuzzy Matching - Implements fuzzy matching to help users find results despite slight typos or partial entries.
- Exact Match Prioritizers - Prioritizes exact matches, acronyms, and string containment using a weighted ranking hierarchy.
- Best-Match Sorting Libraries - Provides a deterministic library for ordering list items by prioritizing exact matches and acronyms.
- Deterministic Ranking Systems - Implements a deterministic scoring system to ensure search results are ordered consistently and predictably.
- Real-time List Filtering - Enables real-time filtering and ordering of large data arrays as the user types.
- Search Result Ranking - Assigns numerical scores to items based on match quality to determine the final order of search results.
- Fuzzy Search Libraries - Ships a JavaScript-based fuzzy search engine with customizable match thresholds.
- JavaScript Search and Sort Libraries - Offers a deterministic ranking and sorting library for filtering JavaScript arrays based on search relevance.
- Multi-Stage Ranking Pipelines - Utilizes a tiered sorting process that filters by match thresholds before applying primary ranks and tie-breakers.
- Array Filtering - Functions as a utility for filtering object arrays based on specified keys and match criteria.
- Search Result Filtering - Allows restricting results to items that meet specific ranking thresholds, such as requiring a start-with match.
- Comparison Function Injection - Provides the ability to override default sorting results using external comparison functions.
- Dynamic Key-Path Extraction - Allows locating searchable text within nested object arrays using dot-notation key paths.
- Configurable Matching Strategies - Provides configurable matching strategies to adjust search strictness from exact equality to simple containment.
- Accent-Insensitive Matchers - Supports diacritic-insensitive matching by stripping accents and special marks from strings.
- Custom Sort Comparators - Supports custom comparison functions to override default tie-breaking or final result ordering.
- Custom Match Criteria Specification - Enables the definition of which object keys or nested paths are used to determine search matches.
