Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchResult<T>

Package version

Contains a document found by a search query, plus associated metadata. Contains a document found by a search query, plus associated metadata.

Type parameters

  • T

Hierarchy

  • SearchResult

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Properties

Optional highlights

highlights: undefined | {}

Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query. NOTE: This property will not be serialized. It can only be populated by the server.

score

score: number

The relevance score of the document compared to other documents returned by the query. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc