A small lib for matching text searches by relevance.
npm install does-match
var doesMatch = ;;
Matching songs names to match a search and order by relevance:
var doesMatch = ;var search = 'somebody to love';; // 64; // 24; // 16; // 0
Explanation of each option:
false, the return of the function will be only the relevance score.
true, the return of the function will be an object containing the relevance and the original text with the matched parts highlighted.
match: '<strong>Some</strong>body To <strong>Love</strong>'relevance: 16
The token to be used in the start of each highlighted part.
The token to be used in the end of each highlighted part.
Minimum word length to take in account in words match.
true, the text
'Québec' will be matched both by
false, the text
'Québec' will be matched only by
How does it work
doesMatch will try to match your query in 3 ways and return the one with the highest relevance score:
- whole match: will try to find the whole exact query inside the text
- words match: will try to find as much words from the query as possible inside the text, in any order
- lookahead match: something like what text editors do when looking for a file, it will try to find all chars from the query, in order. Something like finding "dos mtch" inside "does match"
This software is licensed under the MIT license