Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 815 Bytes

README.md

File metadata and controls

30 lines (22 loc) · 815 Bytes

Fuzz

Study of a simple fuzzy string matcher, inspired by TextMate, Atom and Sublime searching

Usage

Create a new instance of Fuzz by passing an array of strings

var fuzz = new Fuzz(['String', 'str', 'match']);

To make a search use the match method. The results are ordered by it's relevance according to the matching string.

fuzz.match('str');
// ["str", "String"]

The result will have a meta array with detailed info about the search results. Each ResultItem will have a weight and an Item (with name and mainIndex, which is the index of the result on the main collection).

// Getting the first result, for example
fuzz.match('str').meta[0];
// ResultItem {
//   item: Item { name: 'str', mainIndex: 2, ... },
//   weight: 167
// }