Querylight TS Demo

QueryContext

Mutable search context used to carry filter/include/exclude state across nested queries.

Back to docs search

Reference Entry

QueryContext

API Reference · foundation · order 118

Mutable search context used to carry filter/include/exclude state across nested queries.

Relevant APIs

QueryContext

Mutable search context used to carry filter/include/exclude state across nested queries.

Declaration

class QueryContext

Constructors

constructor

```ts constructor(): QueryContext ```

Members

exclude

```ts exclude(ids: string[]): void ``` Parameters: - `ids: string[]`

include

```ts include(ids: string[]): void ``` Parameters: - `ids: string[]`

setIncludeIds

```ts setIncludeIds(ids: string[]): void ``` Parameters: - `ids: string[]`

withFilterMode

```ts withFilterMode(block: function (context: QueryContext): T): T ``` Parameters: - `block: function (context: QueryContext): T`

hits

```ts hits(): Hits ```