FlexSearch

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

nextapps-de/flexsearch flexsearch

README

Web's fastest and most memory-flexible full-text search library with zero dependencies.

Basic Start • API Reference • Document Indexes • Using Worker • Changelog

FlexSearch v0.7.0

The new version is finally available. FlexSearch v0.7.0 is a modern re-implementation and was newly developed from the ground up. The result is an improvement in every single aspect and covers tons of enhancements and improvements which was collected over the last 3 years.

This new version has a good compatibility with the old generation, but it might require some migrations steps in your code.

Read the documentation of new features and changes:
https://github.com/nextapps-de/flexsearch/blob/master/doc/0.7.0.md

Read the documentation of new language encoding features:
https://github.com/nextapps-de/flexsearch/blob/master/doc/0.7.0-lang.md

When it comes to raw search speed FlexSearch outperforms every single searching library out there and also provides flexible search capabilities like multi-field search, phonetic transformations or partial matching.

Depending on the used options it also provides the most memory-efficient index. FlexSearch introduce a new scoring algorithm called "contextual index" based on a pre-scored lexical dictionary architecture which actually performs queries up to 1,000,000 times faster compared to other libraries.

FlexSearch also provides you a non-blocking asynchronous processing model as well as web workers to perform any updates or queries on the index in parallel through dedicated balanced threads.

<!--

FlexSearch Server is available here:

https://github.com/nextapps-de/flexsearch-server.

-->

Supported Platforms:

- Browser

- Node.js

<!--

Demos:

- Auto-Complete

-->

Library Comparison "Gulliver's Travels":

- Performance Benchmark- Scoring Benchmark- Memory Consumption

Plugins (extern projects):

- https://github.com/angeloashmore/react-use-flexsearch

- https://www.gatsbyjs.org/packages/gatsby-plugin-flexsearch/

Get Latest Stable Build (Recommended)


Build	File	CDN
flexsearch.bundle.js	Download	https://rawcdn.githack.com/nextapps-de/flexsearch/0.7.31/dist/flexsearch.bundle.js
flexsearch.light.js	Download	https://rawcdn.githack.com/nextapps-de/flexsearch/0.7.31/dist/flexsearch.light.js
flexsearch.compact.js	Download	https://rawcdn.githack.com/nextapps-de/flexsearch/0.7.31/dist/flexsearch.compact.js
flexsearch.es5.js *	Download	https://rawcdn.githack.com/nextapps-de/flexsearch/0.7.31/dist/flexsearch.es5.js
ES6 Modules	Download	The /dist/module/ folder of this Github repository

* The bundle "flexsearch.es5.js" includes polyfills for EcmaScript 5 Support.

Get Latest (NPM)

```cmd
npm install flexsearch
```

Get Latest Nightly (Do not use for production!)

Just exchange the version number from the URLs above with "master", e.g.: "/flexsearch/__0.7.31__/dist/" into "/flexsearch/__master__/dist".

Compare Web-Bundles

The Node.js package includes all features from flexsearch.bundle.js.


Feature	flexsearch.bundle.js	flexsearch.compact.js	flexsearch.light.js
Presets	✓	✓	-
Async Search	✓	✓	-
Workers (Web + Node.js)	✓	-	-
Contextual Indexes	✓	✓	✓
Index Documents (Field-Search)	✓	✓	-
Document Store	✓	✓	-
Partial Matching	✓	✓	✓
Relevance Scoring	✓	✓	✓
Auto-Balanced Cache by Popularity	✓	-	-
Tags	✓	-	-
Suggestions	✓	✓	-
Phonetic Matching	✓	✓	-
Customizable Charset/Language (Matcher, Encoder, Tokenizer, Stemmer, Filter, Split, RTL)	✓	✓	✓
Export / Import Indexes	✓	-	-
File Size (gzip)	6.8 kb	5.3 kb	2.9 kb

Performance Benchmark (Ranking)

Run Comparison: Performance Benchmark "Gulliver's Travels"

Operation per seconds, higher is better, except the test "Memory" on which lower is better.


Rank	Library	Memory	Query (Single Term)	Query (Multi Term)	Query (Long)	Query (Dupes)	Query (Not Found)
1	FlexSearch	17	7084129	1586856	511585	2017142	3202006
2	JSii	27	6564	158149	61290	95098	534109
3	Wade	424	20471	78780	16693	225824	213754
4	JS Search	193	8221	64034	10377	95830	167605
5	Elasticlunr.js	646	5412	7573	2865	23786	13982
6	BulkSearch	1021	3069	3141	3333	3265	21825569
7	MiniSearch	24348	4406	10945	72	39989	17624
8	bm25	15719	1429	789	366	884	1823
9	Lunr.js	2219	255	271	272	266	267
10	FuzzySearch	157373	53	38	15	32	43
11	Fuse	7641904	6	2	1	2	3

Contextual Search

__Note:__ This feature is disabled by default because of its extended memory usage. Read <a href="#contextual_enable">here</a> get more information about and how to enable.

FlexSearch introduce a new scoring mechanism called __Contextual Search__ which was invented by Thomas Wilkerling, the author of this library. A Contextual Search incredibly boost up queries to a complete new level but also requires some additional memory (depending on ___depth___).

The basic idea of this concept is to limit relevance by its context instead of calculating relevance through the whole distance of its corresponding document.

This way contextual search also improves the results of relevance-based queries on a large amount of text data.

Load Library

There are 3 types of indexes:

1. Index is a flat high performance index which stores id-content-pairs.

2. Worker / WorkerIndex is also a flat index which stores id-content-pairs but runs in background as a dedicated worker thread.

3. Document is multi-field index which can store complex JSON documents (could also exist of worker indexes).

The most of you probably need just one of them according to your scenario.

ES6 Modules (Browser):

``` js
import Index from "./index.js";
import Document from "./document.js";
import WorkerIndex from "./worker/index.js";
const index = new Index(options);
const document = new Document(options);
const worker = new WorkerIndex(options);
```

Bundle (Browser)

``` html
<html>
<head>
<script src="js/flexsearch.bundle.js"></script>
</head>
...
```

Or via CDN:

``` html
<script src="https://cdn.jsdelivr.net/gh/nextapps-de/flexsearch@0.7.31/dist/flexsearch.bundle.js"></script>
```

AMD:

``` js
var FlexSearch = require("./flexsearch.js");
```

Load one of the builds from the folder dist within your html as a script and use as follows:

``` js
var index = new FlexSearch.Index(options);
var document = new FlexSearch.Document(options);
var worker = new FlexSearch.Worker(options);
```

Node.js

```npm
npm install flexsearch
```

In your code include as follows:

``` js
const { Index, Document, Worker } = require("flexsearch");
const index = new Index(options);
const document = new Document(options);
const worker = new Worker(options);
```

Basic Usage and Variants

``` js
index.add(id, text);
index.search(text);
index.search(text, limit);
index.search(text, options);
index.search(text, limit, options);
index.search(options);
```

``` js
document.add(doc);
document.add(id, doc);
document.search(text);
document.search(text, limit);
document.search(text, options);
document.search(text, limit, options);
document.search(options);
```

``` js
worker.add(id, text);
worker.search(text);
worker.search(text, limit);
worker.search(text, options);
worker.search(text, limit, options);
worker.search(text, limit, options, callback);
worker.search(options);
```

The worker inherits from type Index and does not inherit from type Document. Therefore, a WorkerIndex basically works like a standard FlexSearch Index. Worker-Support in documents needs to be enabled by just passing the appropriate option during creation { worker: true }.

Every method called on a Worker index is treated as async. You will get back a Promise or you can provide a callback function as the last parameter alternatively.

API Overview

Global methods:

- FlexSearch.__registerCharset__(name, charset)- FlexSearch.__registerLanguage__(name, language)

Index methods:

- Index.__add__(id, string) *- Index.__append__(id, string) *- Index.__update__(id, string) *- Index.__remove__(id) *- Index.__search__(string, \, \) *- Index.__search__(options) *- _async_ Index.__export__(handler)- _async_ Index.__import__(key, data)

WorkerIndex methods:

- _async_ Index.__add__(id, string)- _async_ Index.__append__(id, string)- _async_ Index.__update__(id, string)- _async_ Index.__remove__(id)- _async_ Index.__search__(string, \, \)- _async_ Index.__search__(options)- _async_ ~~Index.__export__(handler)~~ (WIP)- _async_ ~~Index.__import__(key, data)~~ (WIP)

Document methods:

- Document.__add__(\, document) *- Document.__append__(\, document) *- Document.__update__(\, document) *- Document.__remove__(id || document) *- Document.__search__(string, \, \) *- Document.__search__(options) *- _async_ Document.__export__(handler)- _async_ Document.__import__(key, data)* For each of those methods there exist an asynchronous equivalent:

Async Version:

- _async_ .__addAsync__( ... , \)- _async_ .__appendAsync__( ... , \)- _async_ .__updateAsync__( ... , \)- _async_ .__removeAsync__( ... , \)- _async_ .__searchAsync__( ... , \)

Async methods will return a Promise, alternatively you can pass a callback function as the last parameter.

Methods export and also import are always async as well as every method you call on a Worker-based Index.

Options

FlexSearch is highly customizable. Make use of the right options can really improve your results as well as memory economy and query time.

Index Options


Option	Values	Description	Default
preset	"memory" "performance" "match" "score" "default"	The configuration profile as a shortcut or as a base for your custom settings.	"default"
tokenize	"strict" "forward" "reverse" "full"	The indexing mode (tokenizer). Choose one of the built-ins or pass a custom tokenizer function.	"strict"
cache	Boolean Number	Enable/Disable and/or set capacity of cached entries. When passing a number as a limit the cache automatically balance stored entries related to their popularity. Note: When just using "true" the cache has no limits and growth unbounded.	false
resolution	Number	Sets the scoring resolution (default: 9).	9
context	Boolean Context Options	Enable/Disable contextual indexing. When passing "true" as value it will take the default values for the context.	false
optimize	Boolean	When enabled it uses a memory-optimized stack flow for the index.	true
boost	function(arr, str, int) => float	A custom boost function used when indexing contents to the index. The function has this signature: `Function(words[], term, index) => Float`. It has 3 parameters where you get an array of all words, the current term and the current index where the term is placed in the word array. You can apply your own calculation e.g. the occurrences of a term and return this factor (<1 means relevance is lowered, >1 means relevance is increased). Note: this feature is currently limited by using the tokenizer "strict" only.	null
Language-specific Options and Encoding:
charset	Charset Payload String (key)	Provide a custom charset payload or pass one of the keys of built-in charsets.	"latin"
language	Language Payload String (key)	Provide a custom language payload or pass in language shorthand flag (ISO-3166) of built-in languages.	null
encode	false "default" "simple" "balance" "advanced" "extra" function(str) => [words]	The encoding type. Choose one of the built-ins or pass a custom encoding function.	"default"
stemmer	false String Function		false
filter	false String Function		false
matcher	false String Function		false
Additional Options for Document Indexes:
worker	Boolean	Enable/Disable and set count of running worker threads.	false
document	Document Descriptor	Includes definitions for the document index and storage.

Context Options


Option	Values	Description	Default
resolution	Number	Sets the scoring resolution for the context (default: 1).	1
depth	false Number	Enable/Disable contextual indexing and also sets contextual distance of relevance. Depth is the maximum number of words/tokens away a term to be considered as relevant.	1
bidirectional	Boolean	Sets the scoring resolution (default: 9).	true

Document Options


Option	Values	Description	Default
id	String		"id""
tag	false String		"tag"
index	String Array<String> Array<Object>
store	Boolean String Array<String>		false

Charset Options


Option	Values	Description	Default
split	false RegExp String	The rule to split words when using non-custom tokenizer (built-ins e.g. "forward"). Use a string/char or use a regular expression (default: `/\W+/`).	`/[\W_]+/`
rtl	Boolean	Enables Right-To-Left encoding.	false
encode	function(str) => [words]	The custom encoding function.	/lang/latin/default.js

Language Options


Option	Values	Description
stemmer	false String Function	Disable or pass in language shorthand flag (ISO-3166) or a custom object.
filter	false String Function	Disable or pass in language shorthand flag (ISO-3166) or a custom array.
matcher	false String Function	Disable or pass in language shorthand flag (ISO-3166) or a custom array.

Search Options


Option	Values	Description	Default
limit	number	Sets the limit of results.	100
offset	number	Apply offset (skip items).	0
suggest	Boolean	Enables suggestions in results.	false

Document Search Options

Additionally, to the Index search options above.


Option	Values	Description	Default
index	String Array<String> Array<Object>	Sets the document fields which should be searched. When no field is set, all fields will be searched. Custom options per field are also supported.
tag	String Array<String>	Sets the document fields which should be searched. When no field is set, all fields will be searched. Custom options per field are also supported.	false
enrich	Boolean	Enrich IDs from the results with the corresponding documents.	false
bool	"and" "or"	Sets the used logical operator when searching through multiple fields or tags.	"or"

Tokenizer (Prefix Search)

Tokenizer affects the required memory also as query time and flexibility of partial matches. Try to choose the most upper of these tokenizer which fits your needs:


Option	Description	Example	Memory Factor (n = length of word)
"strict"	index whole words	`foobar`	* 1
"forward"	incrementally index words in forward direction	`fo`obar `foob`ar	* n
"reverse"	incrementally index words in both directions	foob`ar` fo`obar`	* 2n - 1
"full"	index every possible combination	fo`oba`r f`oob`ar	* n * (n - 1)

Encoders

Encoding affects the required memory also as query time and phonetic matches. Try to choose the most upper of these encoders which fits your needs, or pass in a custom encoder:


Option	Description	False-Positives	Compression
false	Turn off encoding	no	0%
"default"	Case in-sensitive encoding	no	0%
"simple"	Case in-sensitive encoding Charset normalizations	no	~ 3%
"balance"	Case in-sensitive encoding Charset normalizations Literal transformations	no	~ 30%
"advanced"	Case in-sensitive encoding Charset normalizations Literal transformations Phonetic normalizations	no	~ 40%
"extra"	Case in-sensitive encoding Charset normalizations Literal transformations Phonetic normalizations Soundex transformations	yes	~ 65%
function()	Pass custom encoding via function(string):[words]

Usage

Create a new index

``` js
var index = new Index();
```

Create a new index and choosing one of the presets:

``` js
var index = new Index("performance");
```

Create a new index with custom options:

``` js
var index = new Index({
charset: "latin:extra",
tokenize: "reverse",
resolution: 9
});
```

Create a new index and extend a preset with custom options:

``` js
var index = new FlexSearch({
preset: "memory",
tokenize: "forward",
resolution: 5
});
```

See all available custom options.

Add text item to an index

Every content which should be added to the index needs an ID. When your content has no ID, then you need to create one by passing an index or count or something else as an ID (a value from type number is highly recommended). Those IDs are unique references to a given content. This is important when you update or adding over content through existing IDs. When referencing is not a concern, you can simply use something simple like count++.

Index.__add(id, string)__

``` js
index.add(0, "John Doe");
```

Search items

Index.__search(string | options, \<limit\>, \<options\>)__

``` js
index.search("John");
```

Limit the result:

``` js
index.search("John", 10);
```

Check existence of already indexed IDs

You can check if an ID was already indexed by:

``` js
if(index.contain(1)){
console.log("ID is already in index");
}
```

Async

You can call each method in its async version, e.g. index.addAsync or index.searchAsync.

You can assign callbacks to each async function:

``` js
index.addAsync(id, content, function(){
console.log("Task Done");
});
index.searchAsync(query, function(result){
console.log("Results: ", result);
});
```

Or do not pass a callback function and getting back a Promise instead:

``` js
index.addAsync(id, content).then(function(){
console.log("Task Done");
});
index.searchAsync(query).then(function(result){
console.log("Results: ", result);
});
```

Or use async and await:

``` js
async function add(){
await index.addAsync(id, content);
console.log("Task Done");
}
async function search(){
const results = await index.searchAsync(query);
console.log("Results: ", result);
}
```

Append Contents

You can append contents to an existing index like:

``` js
index.append(id, content);
```

This will not overwrite the old indexed contents as it will do when perform index.update(id, content). Keep in mind that index.add(id, content) will also perform "update" under the hood when the id was already being indexed.

Appended contents will have their own context and also their own full resolution. Therefore, the relevance isn't being stacked but gets its own context.

Let us take this example:

``` js
index.add(0, "some index");
index.append(0, "some appended content");
index.add(1, "some text");
index.append(1, "index appended content");
```

When you query index.search("index") then you will get index id 1 as the first entry in the result, because the context starts from zero for the appended data (isn't stacked to the old context) and here "index" is the first term.

If you didn't want this behavior than just use the standard index.add(id, content) and provide the full length of content.

Update item from an index

Index.__update(id, string)__

``` js
index.update(0, "Max Miller");
```

Remove item from an index

Index.__remove(id)__

``` js
index.remove(0);
```

Add custom tokenizer

A tokenizer split words/terms into components or partials.

Define a private custom tokenizer during creation/initialization:

``` js
var index = new FlexSearch({
tokenize: function(str){
return str.split(/\s-\//g);
}
});
```

The tokenizer function gets a string as a parameter and has to return an array of strings representing a word or term. In some languages every char is a term and also not separated via whitespaces.

Add language-specific stemmer and/or filter

__Stemmer:__ several linguistic mutations of the same word (e.g. "run" and "running")

__Filter:__ a blacklist of words to be filtered out from indexing at all (e.g. "and", "to" or "be")

Assign a private custom stemmer or filter during creation/initialization:

``` js
var index = new FlexSearch({
stemmer: {
// object {key: replacement}
"ational": "ate",
"tional": "tion",
"enci": "ence",
"ing": ""
},
filter: [
// array blacklist
"in",
"into",
"is",
"isn't",
"it",
"it's"
]
});
```

Using a custom filter, e.g.:

``` js
var index = new FlexSearch({
filter: function(value){
// just add values with length > 1 to the index
return value.length > 1;
}
});
```

Or assign stemmer/filters globally to a language:

Stemmer are passed as a object (key-value-pair), filter as an array.

``` js
FlexSearch.registerLanguage("us", {
stemmer: { /* ... */ },
filter: [ /* ... */ ]
});
```

Or use some pre-defined stemmer or filter of your preferred languages:

``` html
<html>
<head>
<script src="js/flexsearch.bundle.js"></script>
<script src="js/lang/en.min.js"></script>
<script src="js/lang/de.min.js"></script>
</head>
...
```

Now you can assign built-in stemmer during creation/initialization:

``` js
var index_en = new FlexSearch.Index({
language: "en"
});
var index_de = new FlexSearch.Index({
language: "de"
});
```

In Node.js all built-in language packs files are available:

``` js
const { Index } = require("flexsearch");
var index_en = new Index({
language: "en"
});
```

Right-To-Left Support

Set the tokenizer at least to "reverse" or "full" when using RTL.

Just set the field "rtl" to _true_ and use a compatible tokenizer:

``` js
var index = new Index({
encode: str => str.toLowerCase().split(/[^a-z]+/),
tokenize: "reverse",
rtl: true
});
```

CJK Word Break (Chinese, Japanese, Korean)

Set a custom tokenizer which fits your needs, e.g.:

``` js
var index = FlexSearch.create({
encode: str => str.replace(/[\x00-\x7F]/g, "").split("")
});
```

You can also pass a custom encoder function to apply some linguistic transformations.

``` js
index.add(0, "一个单词");
```

``` js
var results = index.search("单词");
```

Index Documents (Field-Search)

The Document Descriptor

Assuming our document has a data structure like this:

``` json
{
"id": 0,
"content": "some text"
}
```

Old syntax FlexSearch v0.6.3 (___not supported anymore!___):

``` js
const index = new Document({
doc: {
id: "id",
field: ["content"]
}
});
```

The document descriptor has slightly changed, there is no field branch anymore, instead just apply one level higher, so key becomes a main member of options.

For the new syntax the field "doc" was renamed to document and the field "field" was renamed to index:

``` js
const index = new Document({
document: {
id: "id",
index: ["content"]
}
});
index.add({
id: 0,
content: "some text"
});
```

The field id describes where the ID or unique key lives inside your documents. The default key gets the value id by default when not passed, so you can shorten the example from above to:

``` js
const index = new Document({
document: {
index: ["content"]
}
});
```

The member index has a list of fields which you want to be indexed from your documents. When just selecting one field, then you can pass a string. When also using default key id then this shortens to just:

``` js
const index = new Document({ document: "content" });
index.add({ id: 0, content: "some text" });
```

Assuming you have several fields, you can add multiple fields to the index:

``` js
var docs = [{
id: 0,
title: "Title A",
content: "Body A"
},{
id: 1,
title: "Title B",
content: "Body B"
}];
```

``` js
const index = new Document({
id: "id",
index: ["title", "content"]
});
```

You can pass custom options for each field:

``` js
const index = new Document({
id: "id",
index: [{
field: "title",
tokenize: "forward",
optimize: true,
resolution: 9
},{
field: "content",
tokenize: "strict",
optimize: true,
resolution: 5,
minlength: 3,
context: {
depth: 1,
resolution: 3
}
}]
});
```

Field options gets inherited when also global options was passed, e.g.:

``` js
const index = new Document({
tokenize: "strict",
optimize: true,
resolution: 9,
document: {
id: "id",
index:[{
field: "title",
tokenize: "forward"
},{
field: "content",
minlength: 3,
context: {
depth: 1,
resolution: 3
}
}]
}
});
```

Note: The context options from the field "content" also gets inherited by the corresponding field options, whereas this field options was inherited by the global option.

Nested Data Fields (Complex Objects)

Assume the document array looks more complex (has nested branches etc.), e.g.:

``` json
{
"record": {
"id": 0,
"title": "some title",
"content": {
"header": "some text",
"footer": "some text"
}
}
}
```

Then use the colon separated notation root:child:child to define hierarchy within the document descriptor:

``` js
const index = new Document({
document: {
id: "record:id",
index: [
"record:title",
"record:content:header",
"record:content:footer"
]
}
});
```

Just add fields you want to query against. Do not add fields to the index, you just need in the result (but did not query against). For this purpose you can store documents independently of its index (read below).

When you want to query through a field you have to pass the exact key of the field you have defined in the doc as a field name (with colon syntax):

``` js
index.search(query, {
index: [
"record:title",
"record:content:header",
"record:content:footer"
]
});
```

Same as:

``` js
index.search(query, [
"record:title",
"record:content:header",
"record:content:footer"
]);
```

Using field-specific options:

``` js
index.search([{
field: "record:title",
query: "some query",
limit: 100,
suggest: true
},{
field: "record:title",
query: "some other query",
limit: 100,
suggest: true
}]);
```

You can perform a search through the same field with different queries.

When passing field-specific options you need to provide the full configuration for each field. They get not inherited like the document descriptor.

Complex Documents

You need to follow 2 rules for your documents:

1. The document cannot start with an Array at the root index. This will introduce sequential data and isn't supported yet. See below for a workaround for such data.

``` js
[ // <-- not allowed as document start!
{
"id": 0,
"title": "title"
}
]
```

2. The id can't be nested inside an array (also none of the parent fields can't be an array). This will introduce sequential data and isn't supported yet. See below for a workaround for such data.

``` js
{
"records": [ // <-- not allowed when ID or tag lives inside!
{
"id": 0,
"title": "title"
}
]
}
```

Here an example for a supported complex document:

``` json
{
"meta": {
"tag": "cat",
"id": 0
},
"contents": [
{
"body": {
"title": "some title",
"footer": "some text"
},
"keywords": ["some", "key", "words"]
},
{
"body": {
"title": "some title",
"footer": "some text"
},
"keywords": ["some", "key", "words"]
}
]
}
```

The corresponding document descriptor (when all fields should be indexed) looks like:

``` js
const index = new Document({
document: {
id: "meta:id",
tag: "meta:tag",
index: [
"contents[]:body:title",
"contents[]:body:footer",
"contents[]:keywords"
]
}
});
```

Again, when searching you have to use the same colon-separated-string from your field definition.

``` js
index.search(query, {
index: "contents[]:body:title"
});
```

Not Supported Documents (Sequential Data)

This example breaks both rules from above:

``` js
[ // <-- not allowed as document start!
{
"tag": "cat",
"records": [ // <-- not allowed when ID or tag lives inside!
{
"id": 0,
"body": {
"title": "some title",
"footer": "some text"
},
"keywords": ["some", "key", "words"]
},
{
"id": 1,
"body": {
"title": "some title",
"footer": "some text"
},
"keywords": ["some", "key", "words"]
}
]
}
]
```

You need to apply some kind of structure normalization.

A workaround to such a data structure looks like this:

``` js
const index = new Document({
document: {
id: "record:id",
tag: "tag",
index: [
"record:body:title",
"record:body:footer",
"record:body:keywords"
]
}
});
function add(sequential_data){
for(let x = 0, data; x < sequential_data.length; x++){
data = sequential_data[x];
for(let y = 0, record; y < data.records.length; y++){
record = data.records[y];
index.add({
id: record.id,
tag: data.tag,
record: record
});
}
}
}
// now just use add() helper method as usual:
add([{
// sequential structured data
// take the data example above
}]);
```

You can skip the first loop when your document data has just one index as the outer array.

Add/Update/Remove Documents to/from the Index

Just pass the document array (or a single object) to the index:

``` js
index.add(docs);
```

Update index with a single object or an array of objects:

``` js
index.update({
data:{
id: 0,
title: "Foo",
body: {
content: "Bar"
}
}
});
```

Remove a single object or an array of objects from the index:

``` js
index.remove(docs);
```

When the id is known, you can also simply remove by (faster):

``` js
index.remove(id);
```

Join / Append Arrays

On the complex example above, the field keywords is an array but here the markup did not have brackets like keywords[]. That will also detect the array but instead of appending each entry to a new context, the array will be joined into on large string and added to the index.

The difference of both kinds of adding array contents is the relevance when searching. When adding each item of an array via append() to its own context by using the syntax field[], then the relevance of the last entry concurrent with the first entry. When you left the brackets in the notation, it will join the array to one whitespace-separated string. Here the first entry has the highest relevance, whereas the last entry has the lowest relevance.

So assuming the keyword from the example above are pre-sorted by relevance to its popularity, then you want to keep this order (information of relevance). For this purpose do not add brackets to the notation. Otherwise, it would take the entries in a new scoring context (the old order is getting lost).

Also you can left bracket notation for better performance and smaller memory footprint. Use it when you did not need the granularity of relevance by the entries.

Field-Search

Search through all fields:

``` js
index.search(query);
```

Search through a specific field:

``` js
index.search(query, { index: "title" });
```

Search through a given set of fields:

``` js
index.search(query, { index: ["title", "content"] });
```

Same as:

``` js
index.search(query, ["title", "content"]);
```

Pass custom modifiers and queries to each field:

``` js
index.search([{
field: "content",
query: "some query",
limit: 100,
suggest: true
},{
field: "content",
query: "some other query",
limit: 100,
suggest: true
}]);
```

You can perform a search through the same field with different queries.

See all available field-search options.

The Result Set

Schema of the result-set:

fields[] => { field, result[] => { document }}

The first index is an array of fields the query was applied to. Each of this field has a record (object) with 2 properties "field" and "result". The "result" is also an array and includes the result for this specific field. The result could be an array of IDs or as enriched with stored document data.

A non-enriched result set now looks like:

``` js
[{
field: "title",
result: [0, 1, 2]
},{
field: "content",
result: [3, 4, 5]
}]
```

An enriched result set now looks like:

``` js
[{
field: "title",
result: [
{ id: 0, doc: { /* document */ }},
{ id: 1, doc: { /* document */ }},
{ id: 2, doc: { /* document */ }}
]
},{
field: "content",
result: [
{ id: 3, doc: { /* document */ }},
{ id: 4, doc: { /* document */ }},
{ id: 5, doc: { /* document */ }}
]
}]
```

When using pluck instead of "field" you can explicitly select just one field and get back a flat representation:

``` js
index.search(query, { pluck: "title", enrich: true });
```

``` js
[
{ id: 0, doc: { /* document */ }},
{ id: 1, doc: { /* document */ }},
{ id: 2, doc: { /* document */ }}
]
```

This result set is a replacement of "boolean search". Instead of applying your bool logic to a nested object, you can apply your logic by yourself on top of the result-set dynamically. This opens hugely capabilities on how you process the results. Therefore, the results from the fields aren't squashed into one result anymore. That keeps some important information, like the name of the field as well as the relevance of each field results which didn't get mixed anymore.

A field search will apply a query with the boolean "or" logic by default. Each field has its own result to the given query.

There is one situation where the bool property is being still supported. When you like to switch the default "or" logic from the field search into "and", e.g.:

``` js
index.search(query, {
index: ["title", "content"],
bool: "and"
});
```

You will just get results which contains the query in both fields. That's it.

Tag Search

You can also fetch results from one or more tags when no query was passed:

``` js
index.search({ tag: ["cat", "dog"] });
```

In this case the result-set looks like:

``` js
[{
tag: "cat",
result: [ /* all cats */ ]
},{
tag: "dog",
result: [ /* all dogs */ ]
}]
```

Limit & Offset

By default, every query is limited to 100 entries. Unbounded queries leads into issues. You need to set the limit as an option to adjust the size.

You can set the limit and the offset for each query:

``` js
index.search(query, { limit: 20, offset: 100 });
```

You cannot pre-count the size of the result-set. That's a limit by the design of FlexSearch. When you really need a count of all results you are able to page through, then just assign a high enough limit and get back all results and apply your paging offset manually (this works also on server-side). FlexSearch is fast enough that this isn't an issue.

Document Store

Only a document index can have a store. You can use a document index instead of a flat index to get this functionality also when only storing ID-content-pairs.

You can define independently which fields should be indexed and which fields should be stored. This way you can index fields which should not be included in the search result.

Do not use a store when: 1. an array of IDs as the result is good enough, or 2. you already have the contents/documents stored elsewhere (outside the index).

When the store attribute was set, you have to include all fields which should be stored explicitly (acts like a whitelist).

When the store attribute was not set, the original document is stored as a fallback.

This will add the whole original content to the store:

``` js
const index = new Document({
document: {
index: "content",
store: true
}
});
index.add({ id: 0, content: "some text" });
```

Access documents from internal store

You can get indexed documents from the store:

``` js
var data = index.get(1);
```

You can update/change store contents directly without changing the index by:

``` js
index.set(1, data);
```

To update the store and also update the index then just use index.update, index.add or index.append.

When you perform a query, weather it is a document index or a flat index, then you will always get back an array of IDs.

Optionally you can enrich the query results automatically with stored contents by:

``` js
index.search(query, { enrich: true });
```

Your results look now like:

``` js
[{
id: 0,
doc: { /* content from store */ }
},{
id: 1,
doc: { /* content from store */ }
}]
```

Configure Storage (Recommended)

This will add just specific fields from a document to the store (the ID isn't necessary to keep in store):

``` js
const index = new Document({
document: {
index: "content",
store: ["author", "email"]
}
});
index.add(id, content);
```

You can configure independently what should being indexed and what should being stored. It is highly recommended to make use of this whenever you can.

Here a useful example of configuring doc and store:

``` js
const index = new Document({
document: {
index: "content",
store: ["author", "email"]
}
});
index.add({
id: 0,
author: "Jon Doe",
email: "john@mail.com",
content: "Some content for the index ..."
});
```

You can query through the contents and will get back the stored values instead:

``` js
index.search("some content", { enrich: true });
```

Your results are now looking like:

``` js
[{
field: "content",
result: [{
id: 0,
doc: {
author: "Jon Doe",
email: "john@mail.com",
}
}]
}]
```

Both field "author" and "email" are not indexed.

Chaining

Simply chain methods like:

``` js
var index = FlexSearch.create()
.addMatcher({'â': 'a'})
.add(0, 'foo')
.add(1, 'bar');
```

``` js
index.remove(0).update(1, 'foo').add(2, 'foobar');
```

Enable Contextual Scoring

Create an index and use the default context:

``` js
var index = new FlexSearch({
tokenize: "strict",
context: true
});
```

Create an index and apply custom options for the context:

``` js
var index = new FlexSearch({
tokenize: "strict",
context: {
resolution: 5,
depth: 3,
bidirectional: true
}
});
```

Only the tokenizer "strict" is actually supported by the contextual index.

The contextual index requires <a href="#memory">additional amount of memory</a> depending on depth.

Auto-Balanced Cache (By Popularity)

You need to initialize the cache and its limit during the creation of the index:

``` js
const index = new Index({ cache: 100 });
```

``` js
const results = index.searchCache(query);
```

A common scenario for using a cache is an autocomplete or instant search when typing.

When passing a number as a limit the cache automatically balance stored entries related to their popularity.

When just using "true" the cache is unbounded and perform actually 2-3 times faster (because the balancer do not have to run).

Worker Parallelism (Browser + Node.js)

The new worker model from v0.7.0 is divided into "fields" from the document (1 worker = 1 field index). This way the worker becomes able to solve tasks (subtasks) completely. The downside of this paradigm is they might not have been perfect balanced in storing contents (fields may have different length of contents). On the other hand there is no indication that balancing the storage gives any advantage (they all require the same amount in total).

When using a document index, then just apply the option "worker":

``` js
const index = new Document({
index: ["tag", "name", "title", "text"],
worker: true
});
index.add({
id: 1, tag: "cat", name: "Tom", title: "some", text: "some"
}).add({
id: 2, tag: "dog", name: "Ben", title: "title", text: "content"
}).add({
id: 3, tag: "cat", name: "Max", title: "to", text: "to"
}).add({
id: 4, tag: "dog", name: "Tim", title: "index", text: "index"
});
```

```
Worker 1: { 1: "cat", 2: "dog", 3: "cat", 4: "dog" }
Worker 2: { 1: "Tom", 2: "Ben", 3: "Max", 4: "Tim" }
Worker 3: { 1: "some", 2: "title", 3: "to", 4: "index" }
Worker 4: { 1: "some", 2: "content", 3: "to", 4: "index" }
```

When you perform a field search through all fields then this task is being balanced perfectly through all workers, which can solve their subtasks independently.

Worker Index

Above we have seen that documents will create worker automatically for each field. You can also create a WorkerIndex directly (same like using Index instead of Document).

Use as ES6 module:

``` js
import WorkerIndex from "./worker/i