// The full set of options (here with their default value) is:
const miniSearch = new MiniSearch({
// idField: field that uniquely identifies a document
idField: 'id',
// extractField: function used to get the value of a field in a document.
// By default, it assumes the document is a flat object with field names as
// property keys and field values as string property values, but custom logic
// can be implemented by setting this option to a custom extractor function.
extractField: (document, fieldName) => document[fieldName],
// tokenize: function used to split fields into individual terms. By
// default, it is also used to tokenize search queries, unless a specific
// `tokenize` search option is supplied. When tokenizing an indexed field,
// the field name is passed as the second argument.
tokenize: (string, _fieldName) => string.split(SPACE_OR_PUNCTUATION),
// processTerm: function used to process each tokenized term before
// indexing. It can be used for stemming and normalization. Return a falsy
// value in order to discard a term. By default, it is also used to process
// search queries, unless a specific `processTerm` option is supplied as a
// search option. When processing a term from a indexed field, the field
// name is passed as the second argument.
processTerm: (term, _fieldName) => term.toLowerCase(),
// searchOptions: default search options, see the `search` method for
// details
searchOptions: undefined,
// fields: document fields to be indexed. Mandatory, but not set by default
fields: undefined
// storeFields: document fields to be stored and returned as part of the
// search results.
storeFields: []
})
Static Readonly wildcardThe special wildcard symbol that can be passed to MiniSearch#search +
Static Readonly wildcardThe special wildcard symbol that can be passed to MiniSearch#search to match all documents
-The number of documents discarded since the most recent vacuuming
-A number between 0 and 1 giving an indication about the proportion of +
The number of documents discarded since the most recent vacuuming
+A number between 0 and 1 giving an indication about the proportion of documents that are discarded, and can therefore be cleaned up by vacuuming. A value close to 0 means that the index is relatively clean, while a higher value means that the index is relatively dirty, and vacuuming could release memory.
-Total number of documents available to search
-Is true if a vacuuming operation is ongoing, false otherwise
Number of terms in the index
-Total number of documents available to search
+Is true if a vacuuming operation is ongoing, false otherwise
Number of terms in the index
+Adds all the given documents to the index asynchronously.
+Adds all the given documents to the index asynchronously.
Returns a promise that resolves (to undefined) when the indexing is done.
This method is useful when index many documents, to avoid blocking the main
thread. The indexing is performed asynchronously and in chunks.
An array of documents to be indexed
Configuration options
Optional chunkA promise resolving to undefined when the indexing is done
Provide suggestions for the given search query
+Provide suggestions for the given search query
The result is a list of suggested modified search queries, derived from the given search query, each with a relevance score, sorted by descending score.
By default, it uses the same options used for search, except that by
@@ -78,7 +78,7 @@
default prefix search is performed on the last term in the query, and terms
are combined with 'AND'.
A sorted array of suggestions sorted by relevance score.
-Discards the document with the given ID, so it won't appear in search results
+Discards the document with the given ID, so it won't appear in search results
It has the same visible effect of MiniSearch.remove (both cause the document to stop appearing in searches), but a different effect on the internal data structures:
@@ -118,7 +118,7 @@The ID of the document to be discarded
-Discards the documents with the given IDs, so they won't appear in search results
It is equivalent to calling MiniSearch#discard for all the given IDs, but with the optimization of triggering at most one automatic @@ -126,14 +126,14 @@
Note: to remove all documents from the index, it is faster and more convenient to call MiniSearch.removeAll with no argument, instead of passing all IDs to this method.
-Returns the stored fields (as configured in the storeFields constructor
option) for the given document ID. Returns undefined if the document is
not present in the index.
The document ID
-Removes the given document from the index.
The document to remove must NOT have changed between indexing and removal, otherwise the index will be corrupted.
This method requires passing the full document to be removed (not just the @@ -141,13 +141,13 @@ memory to be released. A convenient alternative is MiniSearch#discard, which needs only the document ID, and has the same visible effect, but delays cleaning up the index until the next vacuuming.
The document to be removed
-Removes all the given documents from the index. If called with no arguments, +
Removes all the given documents from the index. If called with no arguments, it removes all documents from the index.
Optional documents: readonly T[]The documents to be removed. If this argument is omitted, all documents are removed. Note that, for removing all documents, it is more efficient to call this method with no arguments than to pass all documents.
-It replaces an existing document with the given updated version
It works by discarding the current version and adding the updated one, so it is functionally equivalent to calling MiniSearch#discard followed by MiniSearch#add. The ID of the updated document should @@ -157,7 +157,7 @@ memory to be released (see MiniSearch#discard).
The updated document to replace the old version with
-Search for documents matching the given search query.
+Search for documents matching the given search query.
The result is a list of scored document IDs matching the query, sorted by descending score, and each including data about which terms were matched and in which fields.
@@ -205,7 +205,7 @@ deeply nested queries, it provides a formalized expression tree API for external libraries that implement a parser for custom query languages.Search query
-Allows serialization of the index to JSON, to possibly store it and later +
Allows serialization of the index to JSON, to possibly store it and later deserialize it with MiniSearch.loadJSON.
Normally one does not directly call this method, but rather call the
standard JavaScript JSON.stringify() passing the MiniSearch
@@ -215,7 +215,7 @@
// Serialize the index:
let miniSearch = new MiniSearch({ fields: ['title', 'text'] })
miniSearch.addAll(documents)
const json = JSON.stringify(miniSearch)
// Later, to deserialize it:
miniSearch = MiniSearch.loadJSON(json, { fields: ['title', 'text'] })
A plain-object serializable representation of the search index.
-Triggers a manual vacuuming, cleaning up references to discarded documents +
Triggers a manual vacuuming, cleaning up references to discarded documents from the inverted index
Vacuuming is only useful for applications that use the MiniSearch#discard or MiniSearch#replace methods.
By default, vacuuming is performed automatically when needed (controlled by @@ -246,13 +246,13 @@ times (enqueuing multiple ones would be useless).
Configuration options for the batch size and delay. See VacuumOptions.
-Static getStatic getReturns the default value of an option. It will throw an error if no option with the given name exists.
Name of the option
The default value of the given option
// Get default tokenizer
MiniSearch.getDefault('tokenize')
// Get default term processor
MiniSearch.getDefault('processTerm')
// Unknown options will throw an error
MiniSearch.getDefault('notExisting')
// => throws 'MiniSearch: unknown option "notExisting"'
Static loadJSONDeserializes a JSON index (serialized with JSON.stringify(miniSearch))
+
Static loadJSONDeserializes a JSON index (serialized with JSON.stringify(miniSearch))
and instantiates a MiniSearch instance. It should be given the same options
originally used when serializing the index.
// If the index was serialized with:
let miniSearch = new MiniSearch({ fields: ['title', 'text'] })
miniSearch.addAll(documents)
const json = JSON.stringify(miniSearch)
// It can later be deserialized like this:
miniSearch = MiniSearch.loadJSON(json, { fields: ['title', 'text'] })
@@ -260,4 +260,4 @@
JSON-serialized index
configuration options, same as the constructor
An instance of MiniSearch deserialized from the given JSON.
-Generated using TypeDoc
The type of the documents being indexed.
Basic example:
-