![\"FlexSearch.js:](\"doc/flexsearch-logo-glass-animated.svg\"){kind=logo}
\r\n ![\"Ask](\"https://devin.ai/assets/deepwiki-badge.png\"){kind=icon}
](https://deepwiki.com/nextapps-de/flexsearch)\r\n\r\n\r\n\r\n ![](\"https://img.shields.io/npm/v/flexsearch.svg\")
\r\n![](\"https://img.shields.io/badge/build-passing-brightgreen\"){kind=icon}
\r\n![](\"https://img.shields.io/badge/coverage-84%25-yellow\"){kind=icon}
\r\n![](\"https://img.shields.io/badge/typed-75%25-yellow\"){kind=icon}
\r\n![](\"https://img.shields.io/npm/l/flexsearch.svg\")
\r\n\r\n[Basic Start](#load-library) • \r\n[API Reference](#api-overview) • \r\n[Encoder](doc/encoder.md) • \r\n[Document Search](doc/document-search.md) • \r\n[Persistent Indexes](doc/persistent.md) • \r\n[Using Worker](doc/worker.md) • \r\n[Tag Search](doc/document-search.md#tag-search) • \r\n[Highlighting](doc/result-highlighting.md) • \r\n[Resolver](doc/resolver.md) • \r\n[Changelog](CHANGELOG.md)\r\n\r\n## Please Support this Project\r\n\r\nFlexSearch has been helping developers around the world build powerful, efficient search functionalities for years. Maintaining and improving the library requires significant time and resources. If you’ve found this project valuable and you're interested in supporting the project, please consider donating. Thanks a lot for your continued support!\r\n\r\n![\"Donate](\"doc/opencollective.png\")
\r\n![\"Donate](\"doc/github-sponsors.png\")
\r\n![\"Donate](\"doc/liberapay.svg\")
\r\n![\"Donate](\"doc/patron.png\")
\r\n![\"Donate](\"doc/bountysource.svg\")
\r\n![\"Donate](\"doc/paypal.png\")
\r\n\r\n### FlexSearch Sponsors\r\n\r\n\r\n ![\"Donate](\"doc/antithesis_logo.svg\"){kind=logo}
| Library | \r\nMemory | \r\nQuery: Single | \r\nQuery: Multi | \r\nQuery: Large | \r\nQuery: Not Found | \r\n
|---|---|---|---|---|---|
| flexsearch | \r\n16 | \r\n50955718 | \r\n11912730 | \r\n13981110 | \r\n51706499 | \r\n
| jsii | \r\n2188 | \r\n13847 | \r\n949559 | \r\n1635959 | \r\n3730307 | \r\n
| wade | \r\n980 | \r\n60473 | \r\n443214 | \r\n419152 | \r\n1239372 | \r\n
| js-search | \r\n237 | \r\n22982 | \r\n383775 | \r\n426609 | \r\n994803 | \r\n
| minisearch | \r\n4777 | \r\n30589 | \r\n191657 | \r\n5849 | \r\n304233 | \r\n
| orama | \r\n5355 | \r\n29445 | \r\n170231 | \r\n4454 | \r\n225491 | \r\n
| elasticlunr | \r\n3073 | \r\n14326 | \r\n48558 | \r\n101206 | \r\n95840 | \r\n
| lunr | \r\n2443 | \r\n11527 | \r\n51476 | \r\n88858 | \r\n103386 | \r\n
| ufuzzy | \r\n13754 | \r\n2799 | \r\n7788 | \r\n58544 | \r\n9557 | \r\n
| bm25 | \r\n33963 | \r\n3903 | \r\n4777 | \r\n12657 | \r\n12471 | \r\n
| fuzzysearch | \r\n300147 | \r\n148 | \r\n229 | \r\n455 | \r\n276 | \r\n
| fuse | \r\n247107 | \r\n422 | \r\n321 | \r\n337 | \r\n329 | \r\n
| Feature | \r\nflexsearch.bundle.js | \r\nflexsearch.compact.js | \r\nflexsearch.light.js | \r\n
| \r\n Presets\r\n | \r\n✓ | \r\n✓ | \r\n✓ | \r\n
| \r\n Async Processing\r\n | \r\n✓ | \r\n✓ | \r\n- | \r\n
| \r\n Workers (Web + Node.js)\r\n | \r\n✓ | \r\n- | \r\n- | \r\n
| \r\n Context Search\r\n | \r\n✓ | \r\n✓ | \r\n✓ | \r\n
| \r\n Document Search\r\n | \r\n✓ | \r\n✓ | \r\n- | \r\n
| \r\n Document Datastore\r\n | \r\n✓ | \r\n✓ | \r\n- | \r\n
| \r\n Partial Matching\r\n | \r\n✓ | \r\n✓ | \r\n✓ | \r\n
| \r\n Auto-Balanced Cache by Popularity/Last Queries\r\n | \r\n✓ | \r\n✓ | \r\n- | \r\n
| \r\n Tag Search\r\n | \r\n✓ | \r\n✓ | \r\n- | \r\n
| \r\n Suggestions\r\n | \r\n✓ | \r\n✓ | \r\n✓ | \r\n
| \r\n Phonetic Search (Fuzzy Search)\r\n | \r\n✓ | \r\n✓ | \r\n- | \r\n
| Encoder | \r\n✓ | \r\n✓ | \r\n✓ | \r\n
| Export / Import Indexes | \r\n✓ | \r\n✓ | \r\n- | \r\n
| Resolver | \r\n✓ | \r\n- | \r\n- | \r\n
| Result Highlighting | \r\n✓ | \r\n✓ | \r\n- | \r\n
| Persistent Index (IndexedDB) | \r\n✓ | \r\n- | \r\n- | \r\n
| File Size (gzip) | \r\n16.3 kb | \r\n11.4 kb | \r\n4.5 kb | \r\n
| Option | \r\nValues | \r\nDescription | \r\nDefault | \r\n
| preset | \r\n\r\n \"memory\" \r\n \"performance\" \r\n \"match\" \r\n \"score\" \r\n \"default\"\r\n | \r\n \r\n The configuration profile as a shortcut or as a base for your custom settings. \r\n | \r\n \"default\" | \r\n
| tokenize | \r\n\r\n \"strict\" / \"exact\" \r\n \"tolerant\" \r\n \"forward\" \r\n \"reverse\" / \"bidirectional \r\n \"full\"\r\n | \r\n \r\n Indicates how terms should be indexed by tokenization.\r\n | \r\n\"strict\" | \r\n
| resolution | \r\n\r\n Number\r\n | \r\nSets the scoring resolution | \r\n9 | \r\n
| encoder | \r\n\r\n new Encoder(options) \r\n Charset.Exact \r\n Charset.Default \r\n Charset.Normalize \r\n Charset.LatinBalance \r\n Charset.LatinAdvanced \r\n Charset.LatinExtra \r\n Charset.LatinSoundex \r\n Charset.CJK \r\n false\r\n | \r\n Choose one of the built-in encoder Read more about Encoder | \r\n \"default\" | \r\n
| encode | \r\n\r\n function(string) => string[]\r\n | \r\nPass a custom encoding function Read more about Encoder | \r\n \"default\" | \r\n
| context | \r\n\r\n Boolean \r\n Context Options\r\n | \r\n Enable/Disable context index. When passing \"true\" as a value will use the defaults for the context. | \r\nfalse | \r\n
| cache | \r\n\r\n Boolean \r\n Number\r\n | \r\n Enable/Disable and/or set capacity of cached entries. The cache automatically balance stored entries related to their popularity. | \r\n false | \r\n
| fastupdate | \r\n\r\n Boolean\r\n | \r\nAdditionally add a fastupdate index which boost any replace/update/remove task to a high performance level by also increasing index size by ~30%. | \r\nfalse | \r\n
| priority | \r\n\r\n Number\r\n | \r\nSets the task execution priority (1 low priority - 9 high priority) when using the async methods | \r\n4 | \r\n
| score | \r\n\r\n function(string) => number\r\n | \r\nUse a custom score function | \r\n\r\n |
| keystore | \r\n\r\n Number\r\n | \r\nIncrease available size for In-Memory-Index by additionally using uniform balanced registers (Keystore). You can apply values from 1 to 64. | \r\nfalse | \r\n
| \r\n Persistent Options:\r\n | \r\n|||
| db | \r\n\r\n StorageInterface\r\n | \r\nPass an instance of a persistent adapter | \r\n\r\n |
| commit | \r\n\r\n Boolean\r\n | \r\nWhen disabled any changes won't commit, instead it needs calling index.commit() manually to make modifications to the index (add, update, remove) persistent. | \r\n true | \r\n
| Option | \r\nValues | \r\nDescription | \r\nDefault | \r\n
| limit | \r\nnumber | \r\nSets the limit of results | \r\n100 | \r\n
| offset | \r\nnumber | \r\nApply offset (skip items) | \r\n0 | \r\n
| resolution | \r\nnumber | \r\nLimit the resolution (score) of the results | \r\n\r\n |
| suggest | \r\nBoolean | \r\nEnables Suggestions in results | \r\nfalse | \r\n
| cache | \r\nBoolean | \r\nUse a Query Cache | \r\nfalse | \r\n
| resolve | \r\nBoolean | \r\nWhen set to false, an instance of a Resolver is returned to apply further operations | \r\n true | \r\n
| Option | \r\nDescription | \r\nExample | \r\nMemory Factor (n = length of term) | \r\n
\"strict\"\"exact\"\"default\" | \r\n index the full term | \r\nfoobar | \r\n 1 | \r\n
\"forward\" | \r\n index term in forward direction (supports right-to-left by Index option rtl: true) | \r\n foobarfoobar | \r\n n | \r\n
\"reverse\"\"bidirectional\" | \r\n index term in both directions | \r\nfoobarfoobarfoob arfo obar | \r\n 2n - 1 | \r\n
\"tolerant\" | \r\n index the full term by also being tolerant against typos like swapped letters and missing letters | \r\nfoobrafoboarfoobrfooba | \r\n 2(n - 2) + 2 | \r\n
\"full\" | \r\n index every consecutive partial | \r\nfoobarf oobar | \r\n n * (n - 1) | \r\n
| Option | \r\nDescription | \r\nCharset Type | \r\nCompression Ratio | \r\n
Exact | \r\n Bypass encoding and take exact input | \r\nUniversal (multi-lang) | \r\n0% | \r\n
NormalizeDefault | \r\n Case in-sensitive encoding Charset normalization Letter deduplication | \r\n Universal (multi-lang) | \r\n~ 7% | \r\n
LatinBalance | \r\n Case in-sensitive encoding Charset normalization Letter deduplication Phonetic basic transformation | \r\n Latin | \r\n~ 30% | \r\n
LatinAdvanced | \r\n Case in-sensitive encoding Charset normalization Letter deduplication Phonetic advanced transformation | \r\n Latin | \r\n~ 45% | \r\n
LatinExtra | \r\n Case in-sensitive encoding Charset normalization Letter deduplication Soundex-like transformation | \r\n Latin | \r\n~ 60% | \r\n
LatinSoundex | \r\n Full Soundex transformation | \r\nLatin | \r\n~ 70% | \r\n
function(str) => [str] | \r\n Pass a custom encoding function to the Encoder | \r\n \r\n | \r\n |
| Encoder: | \r\nExact | \r\n Normalize (Default) | \r\n LatinBalance | \r\n LatinAdvanced | \r\n LatinExtra | \r\n LatinSoundex | \r\n
|---|---|---|---|---|---|---|
| Index Size | \r\n3.1 Mb | \r\n1.9 Mb | \r\n1.7 Mb | \r\n1.6 Mb | \r\n1.1 Mb | \r\n0.7 Mb | \r\n
| Struldbrugs | \r\n✓ | \r\n✓ | \r\n✓ | \r\n✓ | \r\n✓ | \r\n✓ | \r\n
| strũlldbrųĝgs | \r\n\r\n | ✓ | \r\n✓ | \r\n✓ | \r\n✓ | \r\n✓ | \r\n
| strultbrooks | \r\n\r\n | \r\n | ✓ | \r\n✓ | \r\n✓ | \r\n✓ | \r\n
| shtruhldbrohkz | \r\n\r\n | \r\n | \r\n | ✓ | \r\n✓ | \r\n✓ | \r\n
| zdroltbrykz | \r\n\r\n | \r\n | \r\n | \r\n | ✓ | \r\n✓ | \r\n
| struhlbrogger | \r\n\r\n | \r\n | \r\n | \r\n | \r\n | ✓ | \r\n
\r\n ![](\"doc/context-index.svg\")
\r\n
| Option | \r\nValues | \r\nDescription | \r\nDefault | \r\n
| resolution | \r\n\r\n Number\r\n | \r\nSets the scoring resolution for the context. | \r\n3 | \r\n
| depth | \r\n \r\n false \r\n Number\r\n | \r\n Enable/Disable context index and also sets the maximum initial distance of related terms. | \r\n1 | \r\n
| bidirectional | \r\n\r\n Boolean\r\n | \r\nIf enabled the context direction (aka \"context chain\") can move bidirectional. You should ony disable this options when you need a more exact match with fewer results. | \r\ntrue | \r\n