\r\n Fast, Tiny, & Good fuzzy search for JavaScript.\r\n
\r\n\r\n
\r\n Fast:<1ms to search 13,000 files.\r\n \r\n Tiny:1 file, 0 dependencies, 5kb.\r\n \r\n Good: clean api + sorts results well.\r\n
\r\n\r\n\r\n## [Demo](https://rawgit.com/farzher/fuzzysort/master/test/test.html)\r\n\r\nhttps://rawgit.com/farzher/fuzzysort/master/test/test.html\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n## Installation Node / Bun / Deno\r\n\r\n```sh\r\nnpm i fuzzysort\r\n```\r\n```js\r\nimport fuzzysort from 'fuzzysort'\r\n```\r\n```js\r\nconst fuzzysort = require('fuzzysort')\r\n```\r\n\r\n\r\n\r\n## Installation Browser\r\n\r\n```html\r\n\r\n```\r\n\r\n\r\n## Usage\r\n\r\n### `fuzzysort.go(search, targets, options=null)`\r\n\r\n```js\r\nconst mystuff = [{file: 'Apple.cpp'}, {file: 'Banana.cpp'}]\r\nconst results = fuzzysort.go('a', mystuff, {key: 'file'})\r\n// [{score: 0.81, obj: {file: 'Apple.cpp'}}, {score: 0.59, obj: {file: 'Banana.cpp'}}]\r\n```\r\n\r\n### Options\r\n\r\n```js\r\nfuzzysort.go(search, targets, {\r\n threshold: 0, // Don't return matches worse than this\r\n limit: 0, // Don't return more results than this\r\n all: false, // If true, returns all results for an empty search\r\n\r\n key: null, // For when targets are objects (see its example usage)\r\n keys: null, // For when targets are objects (see its example usage)\r\n scoreFn: null, // For use with `keys` (see its example usage)\r\n})\r\n```\r\n\r\n\r\n\r\n\r\n## What's a `result`\r\n\r\n```js\r\nconst result = fuzzysort.single('query', 'some string that contains my query.')\r\nresult.score // .80 (1 is a perfect match. 0.5 is a good match. 0 is no match.)\r\nresult.target // 'some string that contains my query.'\r\nresult.obj // reference to your original obj when using options.key\r\nresult.indexes // [29, 30, 31, 32, 33]\r\n\r\nresult.highlight('', '')\r\n// 'some string that contains my query.'\r\n\r\nresult.highlight((m, i) => {m})\r\n// ['some string that contains my ', query, '.']\r\n```\r\n\r\n### Advanced Usage\r\n\r\nSearch a list of objects, by multiple complex keys, with custom weights.\r\n\r\n```js\r\nlet objects = [{\r\n title: 'Liechi Berry',\r\n meta: {desc: 'Raises Attack when HP is low.'},\r\n tags: ['berries', 'items'],\r\n bookmarked: true,\r\n}, {\r\n title: 'Petaya Berry',\r\n meta: {desc: 'Raises Special Attack when HP is low.'},\r\n}]\r\n\r\nlet results = fuzzysort.go('attack berry', objects, {\r\n keys: ['title', 'meta.desc', obj => obj.tags?.join()],\r\n scoreFn: r => r.score * r.obj.bookmarked ? 2 : 1, // if the item is bookmarked, boost its score\r\n})\r\n\r\nvar keysResult = results[0]\r\n// When using multiple `keys`, results are different. They're indexable to get each normal result\r\nkeysResult[0].highlight() // 'Liechi Berry'\r\nkeysResult[1].highlight() // 'Raises Attack when HP is low.'\r\nkeysResult.score // .84\r\nkeysResult.obj.title // 'Liechi Berry'\r\n```\r\n\r\n\r\n\r\n## How To Go Fast · Performance Tips\r\n\r\n```js\r\nlet targets = [{file: 'Monitor.cpp'}, {file: 'MeshRenderer.cpp'}]\r\n\r\n// filter out targets that you don't need to search! especially long ones!\r\ntargets = targets.filter(t => t.file.length < 1000)\r\n\r\n// if your targets don't change often, provide prepared targets instead of raw strings!\r\ntargets.forEach(t => t.filePrepared = fuzzysort.prepare(t.file))\r\n\r\n// don't use options.key if you don't need a reference to your original obj\r\ntargets = targets.map(t => t.filePrepared)\r\n\r\nconst options = {\r\n limit: 100, // don't return more results than you need!\r\n threshold: .5, // don't return bad results\r\n}\r\nfuzzysort.go('gotta', targets, options)\r\nfuzzysort.go('go', targets, options)\r\nfuzzysort.go('fast', targets, options)\r\n```\r\n\r\n\r\n### Gotcha\r\n`result.score` is implemented as a getter/setter and stored different internally\r\n`r.score = .3; // r.score == 0.30000000000000004`\r\n\r\n\r\n\r\n\r\n\r\n## Star History\r\n\r\n[](https://star-history.com/#farzher/fuzzysort)\r\n\r\n\r\n\r\n### Changelog\r\n\r\n#### v3.1.0\r\n- Automatically handle diacritics / accents / ligatures\r\n\r\n#### v3.0.0\r\n- Added new behavior when using `keys` and your search contains spaces!\r\n- Added `options.key` can now be a function `{key: obj => obj.tags.join()}`\r\n- Removed `fuzzysort.indexes` & Added `result.indexes` (as a getter/setter for GC perf)\r\n- Removed `fuzzysort.highlight()` & Added `result.highlight()`\r\n- Changed scoring: score is now a number from 0 to 1 instead of from -Infinity to 0\r\n- Changed scoring: substring matches are even more relevant\r\n- Changed scoring: `straw berry` now matches great against `strawberry`\r\n- Changed scoring: tweaked the scoring quite a bit\r\n- `result.score` is behind a getter/setter for performance reasons\r\n- Fixed minor issues\r\n\r\n#### v2.0.0\r\n- Added new behavior when your search contains spaces!\r\n- Added fuzzysort.min.js\r\n- Now depends on ES6 features\r\n- Removed `result.indexes` & Added `fuzzysort.indexes` (improved GC performance)\r\n- Completely Removed `options.allowTypo`\r\n- Completely Removed `fuzzysort.goAsync`\r\n- Completely Removed `fuzzysort.new`\r\n- Rewrote the demo\r\n\r\n#### v1.9.0\r\n- Even faster\r\n- Added `options.all`\r\n- Deprecated/Removed `options.allowTypo`\r\n- Deprecated/Removed `fuzzysort.goAsync`\r\n- Changed scoring: boosted substring matches\r\n- Changed scoring: targets with too many beginning indexes lose points for being a bad target\r\n- Changed scoring: penality for not starting near the beginning\r\n- Changed scoring: penality for more groups\r\n- Fixed \"Exponential backtracking hangs browser\"\r\n\r\n#### v1.2.0\r\n- Added `fuzzysort.highlight(result, callback)`\r\n\r\n#### v1.1.0\r\n- Added `allowTypo` as an option\r\n\r\n#### v1.0.0\r\n\r\n- Inverted scores; they're now negative instead of positive, so that higher scores are better\r\n- Added ability to search objects by `key`/`keys` with custom weights\r\n- Removed the option to automatically highlight and exposed `fuzzysort.highlight`\r\n- Removed all options from `fuzzysort` and moved them into `fuzzysort.go` optional params\r\n\r\n#### v0.x.x\r\n\r\n- init\r\n","readmeFilename":"README.md","users":{"rexpan":true,"nguyenvanhoang26041994":true}}
![\"fuzzysort\"](\"https://i.imgur.com/axkOMVs.png\")
\r\n