MiniSearch | MiniSearch (original) (raw)

Type Parameters

• T = any

Index

Constructors

constructor

• new MiniSearch<T>(options): MiniSearch<T>

• Type Parameters

  • T = any

Returns MiniSearch<T>

Properties

Static Readonly wildcard

Accessors

dirtCount

• get dirtCount(): number

• Returns number

dirtFactor

• get dirtFactor(): number

• Returns number

documentCount

• get documentCount(): number

• Returns number

isVacuuming

• get isVacuuming(): boolean

• Returns boolean

termCount

• get termCount(): number

• Returns number

Methods

add

• add(document): void

• Returns void

addAll

• addAll(documents): void

• Parameters

  • documents: readonly T[]

Returns void

addAllAsync

• addAllAsync(documents, options?): Promise<void>

• Parameters

  • documents: readonly T[]
  • options: {
    chunkSize?: number;
    } = {}
    * ##### Optional chunkSize?: number

Returns Promise<void>

A promise resolving to undefined when the indexing is done

autoSuggest

• autoSuggest(queryString, options?): Suggestion[]

• Returns Suggestion[]

A sorted array of suggestions sorted by relevance score.

discard

• discard(id): void

• Returns void

discardAll

• discardAll(ids): void

• Parameters

  • ids: readonly any[]

Returns void

getStoredFields

• getStoredFields(id): undefined | Record<string, unknown>

• Returns undefined | Record<string, unknown>

has

• has(id): boolean

• Returns boolean

remove

• remove(document): void

• Returns void

removeAll

• removeAll(documents?): void

• Parameters

  • Optional documents: readonly T[]

Returns void

replace

• replace(updatedDocument): void

• Parameters

  • updatedDocument: T

Returns void

search

• search(query, searchOptions?): SearchResult[]

• Returns SearchResult[]

toJSON

• toJSON(): AsPlainObject

• Returns AsPlainObject

A plain-object serializable representation of the search index.

vacuum

• vacuum(options?): Promise<void>

• Returns Promise<void>

Static getDefault

• getDefault(optionName): any

• Parameters

  • optionName: string

Returns any

The default value of the given option

Usage:

// 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 loadJSON

• loadJSON<T>(json, options): MiniSearch<T>

• Type Parameters

  • T = any

Parameters

• json: string
• options: Options<T>

Returns MiniSearch<T>

An instance of MiniSearch deserialized from the given JSON.

Static loadJSONAsync

• loadJSONAsync<T>(json, options): Promise<MiniSearch<T>>

• Type Parameters

  • T = any

Parameters

• json: string
• options: Options<T>

Returns Promise<MiniSearch<T>>

A Promise that will resolve to an instance of MiniSearch deserialized from the given JSON.