UpdateOptions

Options for update.

Properties

getRuleDefaultOperator()?

optional getRuleDefaultOperator: (field: string) => string

Determines the default operator name for a given field.

Parameters

Parameter	Type
field	string

Returns

string

Defined in

packages/react-querybuilder/src/utils/queryTools.ts:94

---

getRuleDefaultValue()?

optional getRuleDefaultValue: (rule: RuleType<string, string, any, string>) => any

Gets the default value for a given rule, in case the value needs to be reset.

Parameters

Parameter	Type
rule	RuleType<string, string, any, string>

Returns

any

Defined in

packages/react-querybuilder/src/utils/queryTools.ts:103

---

getValueSources()?

optional getValueSources: (field: string, operator: string) => ValueSources

Determines the valid value sources for a given field and operator.

Parameters

Parameter	Type
field	string
operator	string

Returns

ValueSources

Defined in

packages/react-querybuilder/src/utils/queryTools.ts:98

---

resetOnFieldChange?

optional resetOnFieldChange: boolean

When updating the field of a rule, the rule's operator, value, and valueSource will be reset to their respective defaults. Defaults to true.

Defined in

packages/react-querybuilder/src/utils/queryTools.ts:85

---

resetOnOperatorChange?

optional resetOnOperatorChange: boolean

When updating the operator of a rule, the rule's value and valueSource will be reset to their respective defaults. Defaults to false.

Defined in

packages/react-querybuilder/src/utils/queryTools.ts:90

---

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.