Querylight TS Demo

HighlightRequest

Options for `DocumentIndex.highlight(...)`.

Back to docs search

Reference Entry

HighlightRequest

API Reference · foundation · order 95

Options for `DocumentIndex.highlight(...)`.

Relevant APIs

HighlightRequest

Tags

api-reference interfaces

HighlightRequest

Options for DocumentIndex.highlight(...).

Declaration

interface HighlightRequest

Members

fields

```ts fields: string[] ```

fragmentSize

```ts fragmentSize?: number ```

numberOfFragments

```ts numberOfFragments?: number ```

requireFieldMatch

```ts requireFieldMatch?: boolean ```