QuerySettings.md

quetch

---

quetch / QuerySettings

Type Alias: QuerySettings<T>

QuerySettings<T>: object

Settings to use when doing a query.

Type Parameters

• T

Type declaration

abortController?

optional abortController: AbortController

Abort controller to abort the query.

pathField?

optional pathField: FieldFiltered<T, string>

Path to the field that contains the path value of an item, used for displaying items in a tree.

pathFieldSeparator?

optional pathFieldSeparator: string

Maps path fields to a string used to separate the path nodes of a field value.

Default

"/"

pathFieldSeparatorEscape?

optional pathFieldSeparatorEscape: string

String used to escape the separator.

Default

"\\"

signal?

optional signal: AbortSignal

Abort signal to abort the query.

transformFilterChildren()?

optional transformFilterChildren: (filter) => Exclude<Filter<T>, object>

Returns a filter that captures the items expressed by the provided FilterChildren. The return filter cannot use filters of type FilterChildren.

Parameters

filter

FilterChildren<T>

The provided FilterChildren to express.

Returns

Exclude<Filter<T>, object>

A filter that captures the items expressed by the provided FilterChildren.

Defined in

lib/types/QuerySettings.ts:8