Getting instant help by the DeepWiki AI assistant:

Next-Generation full-text search library for Browser and Node.js

Basic Start  •  API Reference  •  Encoder  •  Document Search  •  Persistent Indexes  •  Using Worker  •  Tag Search  •  Highlighting  •  Resolver  •  Changelog

Please Support this Project

FlexSearch 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!

FlexSearch Sponsors

    <img src="https://github.com/nextapps-de/flexsearch/raw/0.8.2/doc/antithesis_logo.svg" width="200" alt="Donate using Open Collective">


    Antithesis Operations LLC

FlexSearch performs queries up to 1,000,000 times faster compared to other libraries by also providing powerful search capabilities like multi-field search (document search), phonetic transformations, partial matching, tag-search, result highlighting or suggestions.

Bigger workloads are scalable through workers to perform any updates or queries to the index in parallel through dedicated balanced threads.

The latest generation v0.8 introduce Persistent Indexes, well optimized for scaling of large datasets and running in parallel. All available features was natively ported right into the database engine of your choice.

FlexSearch was nominated by the GitNation for the "Best Technology of the Year".

Supported Platforms: - Browser - Node.js

Supported Database: - InMemory (Default) - IndexedDB (Browser) - Redis - SQLite - Postgres - MongoDB - Clickhouse

Supported Charsets: - Latin - Chinese, Korean, Japanese (CJK) - Hindi - Arabic - Cyrillic - Greek and Coptic - Hebrew

Common Code Examples:

• Node.js: Module (ESM)
• Node.js: CommonJS
• Browser: Module (ESM)
• Browser: Legacy Script

Demos: - Auto-Complete

Benchmarks: - Performance Benchmark - Matching Benchmark

Latest Benchmark Results

The benchmark was measured in terms per seconds, higher values are better (except the test "Memory"). The memory value refers to the amount of memory which was additionally allocated during search.

Run Comparison: Performance Benchmark "Gulliver's Travels"

Extern Projects & Plugins: - React: https://github.com/angeloashmore/react-use-flexsearch - Vue: https://github.com/Noction/vue-use-flexsearch - Gatsby: https://www.gatsbyjs.org/packages/gatsby-plugin-flexsearch/ - Nikola: https://plugins.getnikola.com/v8/flexsearch_plugin/

Table of contents

[!TIP] Understanding those 3 elementary things about FlexSearch will improve your results significantly: Tokenizer, Encoder and Suggestions

• Load Library (Node.js, ESM, Legacy Browser)
• Non-Module Bundles (ES5 Legacy)
• Module (ESM)
• Node.js
• Basic Usage and Variants
• Index Options
• Search Options
• Common Code Examples (Browser, Node.js)
• API Overview
• Presets
• Context Search
• Context Options
• Fast-Update Mode
• Suggestions
• Document Search (Multi-Field Search)
• Document Index Options
• Document Descriptor
• Document Search Options
• Multi-Tag Search
• Result Highlighting
  • Highlighting Options
  • Boundary Options
  • Ellipsis Options
• Phonetic Search (Fuzzy Search)
• Tokenizer (Partial Search)
• Charset Collection
• Encoder
• Encoder Options
• Universal Charset Collection
• Latin Charset Encoder Presets
• Language Specific Preset
• Custom Encoder
• Async Non-Blocking Runtime Balancer
• Worker Indexes
• Worker Index Options
• Resolver (Complex Queries)
• Resolver Options
• Boolean Operations (and, or, xor, not)
• Boost
• Limit / Offset
• Resolve
• Auto-Balanced Cache by Popularity/Last Query
• Export / Import Indexes
• Fast-Boot Serialization
• Persistent Indexes
• Persistent Index Options
• IndexedDB (Browser)
• Postgres
• Redis
• MongoDB
• SQLite
• Clickhouse
• Custom Score Function
• Custom Builds
• Extended Keystores (In-Memory Index)
• Best Practices
• Page-Load / Fast-Boot
• Prefer numeric typed IDs

Load Library (Node.js, ESM, Legacy Browser)

npm install flexsearch

The dist folder is located in: node_modules/flexsearch/dist/

It is not recommended to use the /src/ folder of this repository as it requires some kind of conditional compilation to resolve the build flags. The /dist/ folder contains every version you might need including unminified ES6 modules. When none of the /dist/ folder versions works for you please open an issue. Alternatively you can read more about Custom Builds.

Download Builds