Skip to main content

QueryActionHandlers

Defined in: packages/core/src/utils/queryActions.ts:101

The seven mutations a query builder performs. Each takes the current query and returns the next one, or undefined when the mutation was aborted—because the target is disabled, a confirmation callback declined, or a depth limit was reached.

Properties​

addGroup​

addGroup: (query: any, ruleGroup: any, parentPath: Path, context?: any) => any

Defined in: packages/core/src/utils/queryActions.ts:103

Parameters​

ParameterType
queryany
ruleGroupany
parentPathPath
context?any

Returns​

any


addRule​

addRule: (query: any, rule: RuleType, parentPath: Path, context?: any) => any

Defined in: packages/core/src/utils/queryActions.ts:102

Parameters​

ParameterType
queryany
ruleRuleType
parentPathPath
context?any

Returns​

any


groupRule​

groupRule: (query: any, sourcePath: Path, targetPath: Path, clone?: boolean, context?: any) => any

Defined in: packages/core/src/utils/queryActions.ts:113

Parameters​

ParameterType
queryany
sourcePathPath
targetPathPath
clone?boolean
context?any

Returns​

any


moveRule​

moveRule: (query: any, oldPath: Path, newPath: Path | "up" | "down", clone?: boolean, context?: any) => any

Defined in: packages/core/src/utils/queryActions.ts:106

Parameters​

ParameterType
queryany
oldPathPath
newPathPath | "up" | "down"
clone?boolean
context?any

Returns​

any


propChange​

propChange: (query: any, prop: UpdateableProperties, value: any, path: Path) => any

Defined in: packages/core/src/utils/queryActions.ts:104

Parameters​

ParameterType
queryany
propUpdateableProperties
valueany
pathPath

Returns​

any


removeRuleOrGroup​

removeRuleOrGroup: (query: any, path: Path, context?: any) => any

Defined in: packages/core/src/utils/queryActions.ts:105

Parameters​

ParameterType
queryany
pathPath
context?any

Returns​

any


ungroupRuleGroup​

ungroupRuleGroup: (query: any, path: Path, context?: any) => any

Defined in: packages/core/src/utils/queryActions.ts:120

Parameters​

ParameterType
queryany
pathPath
context?any

Returns​

any


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.