Fast, tiny, good fuzzy search for JavaScript.
<1ms for 13,000 files · 0 dependencies · clean ranking
## [Demo](https://farzher.github.io/fuzzysort/test/test.html)
[https://farzher.github.io/fuzzysort/test/test.html](https://farzher.github.io/fuzzysort/test/test.html)
## Install
```sh
npm i fuzzysort
```
```js
import fuzzysort from 'fuzzysort'
```
Browser:
```html
```
## Quick start
```js
const files = [
{file: 'Guide.cpp'},
{file: 'UserInterface.cpp'},
]
const results = fuzzysort.go('ui', files, {key: 'file'})
results[0].obj.file // 'UserInterface.cpp'
```
```js
fuzzysort.go(search, targets, {
limit : 10, // Max results; 0 = unlimited
threshold : .5, // Minimum score; 0 = any match
key : null, // Search one property
keys : null, // Search multiple properties
scoreFn : null, // Override result scoring
})
```
## Results
```js
const result = fuzzysort.single('query', 'some string that contains my query.')
result.score // .80 (1 is a perfect match. 0.5 is a good match. 0 is no match.)
result.target // 'some string that contains my query.'
result.indexes // [29, 30, 31, 32, 33]
result.obj // reference to your original obj when using options.key
result.highlight('