Interface Result<TDocument>

interface Result<TDocument extends SearchDocument> {
    document: TDocument;
    highlight?: ResultHighlight;
    rank?: number;
    type: string;
}

Type Parameters

TDocument extends SearchDocument

Index

Properties

document highlight? rank? type

Properties

document

document: TDocument

The raw value of the document, as indexed.

`Optional`highlight

highlight?: ResultHighlight

Optional result highlight. Useful for improving the search result display/experience.

`Optional`rank

rank?: number

Optional result rank, where 1 is the first/top result returned. Useful for understanding search effectiveness in analytics.

type

type: string

The "type" of the given document. See: DocumentCollatorFactory."type"