Mutable search context used to carry filter/include/exclude state across nested queries.
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`filteredIds
```ts
filteredIds(allIds: Iterable): string[] | undefined
```
Returns the current candidate ids after include/exclude filtering, or ``undefined`` when unrestricted.
Parameters:
- `allIds: Iterable`hits
```ts
hits(): Hits
```