Type alias SearchResult<ID, Field>

SearchResult<ID, Field>: Field & {
    id: ID;
    match: MatchInfo;
    score: number;
    terms: string[];
}

Type of the search results. Each search result indicates the document ID, the terms that matched, the match information, the score, and all the stored fields.

Type Parameters

ID = any
The type of id being indexed.
Field extends Record<string, any> = Record<never, never>

Type declaration

id: ID
The document ID
match: MatchInfo
Match information, see MatchInfo
score: number
Score of the search results
terms: string[]
List of terms that matched

Generated using TypeDoc