update()
update<
RG
>(query
:RG
,prop
:UpdateableProperties
,value
:any
,path
:Path
,__namedParameters
:UpdateOptions
):RG
Defined in: packages/react-querybuilder/src/utils/queryTools.ts:109
Updates a property of a rule or group within a query.
Type Parameters
Type Parameter |
---|
RG extends RuleGroupTypeAny |
Parameters
Parameter | Type | Description |
---|---|---|
query | RG | The query to update. |
prop | UpdateableProperties | The name of the property to update. |
value | any | The new value of the property. |
path | Path | The path of the rule or group to update. |
__namedParameters | UpdateOptions | Options. |
Returns
RG
The new query with the rule or group property updated.
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.