Querylight TS Demo

MatchPhrase

Phrase query with optional slop.

Back to docs search

Reference Entry

MatchPhrase

API Reference · foundation · order 74

Phrase query with optional slop.

Relevant APIs

MatchPhrase

Phrase query with optional slop.

Declaration

class MatchPhrase

Constructors

constructor

```ts constructor(__namedParameters: MatchPhraseParams): MatchPhrase ``` Parameters: - `__namedParameters: MatchPhraseParams`

Members

boost

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

hits

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

highlightClauses

```ts highlightClauses(): { kind: "phrase"; field: string; text: string; slop: number }[] ```