Result
Home > @backstage/plugin-search-common > Result
Signature:
export interface Result<TDocument extends SearchDocument>
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| document | TDocument | The raw value of the document, as indexed. | |
| highlight? | ResultHighlight | (Optional) Optional result highlight. Useful for improving the search result display/experience. | |
| rank? | number | (Optional) Optional result rank, where 1 is the first/top result returned. Useful for understanding search effectiveness in analytics. | |
| type | string | The "type" of the given document. See: DocumentCollatorFactory.type |