Class SearchIndex<T>

A collection where all representations (T) of data (D) are indexed upon insertion for efficient querying based on given configuration Use cases include:

Search feature which returns relevant results with the option to support "autocomplete" functionality
Answering potentially complex but predictable questions based on parameters of an "indexer" function

Type Parameters

T

Implements

ISearchIndex<T>

Index

Constructors

Properties

Methods

Answer GetIndexesForQuery Insert Reset Search isQualifiedResult

Constructors

constructor

new SearchIndex<T>(): SearchIndex<T>
Type Parameters
- T
Returns SearchIndex<T>

Properties

`Private` index

index: Record<string, SearchResult<T>[]> = {}

Methods

Answer

Answer(query): Promise<null | T>
Return the best match (equivalent to using the top result from a search)
Parameters
- query: string
Returns Promise<null | T>
Implementation of ISearchIndex.Answer
- Defined in src/Collections/SearchIndex/SearchIndex.ts:31

GetIndexesForQuery

GetIndexesForQuery(query, limit?): Promise<string[]>
Return the best match indexes for a given query (consider for an autocomplete feature)
Parameters
- query: string
- limit: number = 10
Returns Promise<string[]>
Implementation of ISearchIndex.GetIndexesForQuery
- Defined in src/Collections/SearchIndex/SearchIndex.ts:17

Insert

Insert<D>(indexer, items?): Promise<void>
Insert elements into the index <string, T> using the given indexer function
Type Parameters
- D
Parameters
- indexer: Indexer<D, T>
- Optional items: D[]
Returns Promise<void>
Implementation of ISearchIndex.Insert
- Defined in src/Collections/SearchIndex/SearchIndex.ts:7

Reset

Reset(): void
Deletes all indexed data

Returns void
Implementation of ISearchIndex.Reset
- Defined in src/Collections/SearchIndex/SearchIndex.ts:36

Search

Search(query, limit?): Promise<T[]>
Return the best results for a given query
Parameters
- query: string
- limit: number = 10
Returns Promise<T[]>
Implementation of ISearchIndex.Search
- Defined in src/Collections/SearchIndex/SearchIndex.ts:21

`Private` isQualifiedResult

isQualifiedResult(result): result is Pick<any, "item" | "qualifier">
Parameters
- result: any
Returns result is Pick<any, "item" | "qualifier">
- Defined in src/Collections/SearchIndex/SearchIndex.ts:40

Generated using TypeDoc