Querylight TS Demo

MatchQuery

Full-text query against one field using analyzed terms and optional prefix expansion.

Back to docs search

Reference Entry

MatchQuery

API Reference · foundation · order 71

Full-text query against one field using analyzed terms and optional prefix expansion.

Relevant APIs

MatchQuery

Full-text query against one field using analyzed terms and optional prefix expansion.

Declaration

class MatchQuery

Constructors

constructor

```ts constructor(__namedParameters: MatchQueryParams): MatchQuery ``` Parameters: - `__namedParameters: MatchQueryParams`

Members

boost

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

hits

```ts hits(documentIndex: DocumentIndex): Promise ``` Parameters: - `documentIndex: DocumentIndex`

highlightClauses

```ts highlightClauses(): { kind: "term"; field: string; text: string; operation: OP; prefixMatch: boolean }[] ```