Skip to main content

WalkOptions

Defined in: packages/core/src/utils/QueryManager.ts:372

Options for QueryManager.walk and its derivatives.

Properties​

from?​

optional from?: string | Path

Defined in: packages/core/src/utils/QueryManager.ts:377

Traverse only the subtree rooted at this path or id instead of the whole query. The node itself is visited first. When the path or id can't be resolved, nothing is visited.

groupsOnly?​

optional groupsOnly?: boolean

Defined in: packages/core/src/utils/QueryManager.ts:381

Visit only groups.

rulesOnly?​

optional rulesOnly?: boolean

Defined in: packages/core/src/utils/QueryManager.ts:379

Visit only rules. Groups are still traversed, just not yielded (except as parent).

caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.