Type Alias TrieSearchOptions
cache?: boolean;
expandRegexes?: [{ alternate: string; regex: RegExp }];
ignoreCase?: boolean;
insertFullUnsplitKey?: boolean;
maxCacheSize?: number;
min?: number;
splitOnGetRegEx?: RegExp | false;
splitOnRegEx?: RegExp | false;
tokenizer?: (str: string) => IterableIterator<string>;
}
Properties
Optionalcache
Is caching enabled; default: true.
OptionalexpandRegexes
By default, this is set to an array of international vowels expansions, allowing searches for vowels like 'a' to
return matches on 'å' or 'ä' etc. Set this to an empty array / [] if you want to disable it. See the top of
src/trie/TrieSearch.js file for examples.
OptionalignoreCase
Ignores case in lookups; default: true.
OptionalinsertFullUnsplitKey
In TrieSearch.map when splitOnRegEx is defined and insertFullUnsplitKey is true the full key will also be
mapped; default: false.
OptionalmaxCacheSize
The max cache size before removing entries in a LRU manner; default: 64.
Optionalmin
The size of the prefix for keys; minimum length of a key to store and search. By default, this is 1, but you
might improve performance by using 2 or 3.
OptionalsplitOnGetRegEx
How phrases are split on retrieval / get; default: /\s/g.
OptionalsplitOnRegEx
How phrases are split on search; default: /\s/g. By default, this is any whitespace. Set to false if you have
whitespace in your keys! Set it to something else to split along other boundaries.
Optionaltokenizer
Provide a custom tokenizer that is used to split keys. IE a Grapheme / Unicode tokenizer.
Options for TrieSearch.