Querylight TS Demo

Query

Minimal query contract implemented by all query classes.

Back to docs search

Reference Entry

Query

API Reference · foundation · order 97

Minimal query contract implemented by all query classes.

Relevant APIs

Query

Tags

api-reference interfaces

Query

Minimal query contract implemented by all query classes.

Declaration

interface Query

Members

boost

```ts boost: number | undefined ```

hits

```ts hits(documentIndex: DocumentIndex, context?: QueryContext): Promise ``` Parameters: - `documentIndex: DocumentIndex` - `context?: QueryContext`

highlightClauses

```ts highlightClauses(documentIndex: DocumentIndex): HighlightClause[] ``` Parameters: - `documentIndex: DocumentIndex`