Type Alias SearchResult

A single search result, including the document ID, terms that matched, the match information, the score, and all the stored fields.

type SearchResult = {
    id: any;
    match: MatchInfo;
    queryTerms: string[];
    score: number;
    terms: string[];
    [key: string]: any;
}

Properties

id: any

The document ID.

Match information, see MatchInfo.

queryTerms: string[]

Query terms that matched (e.g. "moto" for prefix "moto").

score: number

Score of the search result.

terms: string[]

Document terms that matched (e.g. "motorcycle" for prefix "moto").