UpdateMethod()
Defined in: packages/core/src/utils/queryTools.ts:337
Call Signature
UpdateMethod<
RGextendsRuleGroupTypeAny>(query:RG,prop:UpdateableProperties,value:any,pathOrID:string|Path,options?:UpdateOptions):RG
Defined in: packages/core/src/utils/queryTools.ts:341
Updates a single property of a rule or group.
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. |
pathOrID | string | Path | The path or ID of the rule or group to update. |
options? | UpdateOptions | Options. |
Returns
RG
Call Signature
UpdateMethod<
RGextendsRuleGroupTypeAny>(query:RG,props:UpdateableProperties[],values:any[],pathOrID:string|Path,options?:UpdateOptions):RG
Defined in: packages/core/src/utils/queryTools.ts:358
Updates multiple properties of a rule or group using parallel arrays of property names and corresponding values.
Type Parameters
| Type Parameter |
|---|
RG extends RuleGroupTypeAny |
Parameters
| Parameter | Type | Description |
|---|---|---|
query | RG | The query to update. |
props | UpdateableProperties[] | The names of the properties to update. |
values | any[] | The new values, in the same order as props. |
pathOrID | string | Path | The path or ID of the rule or group to update. |
options? | UpdateOptions | Options. |
Returns
RG
Call Signature
UpdateMethod<
RGextendsRuleGroupTypeAny>(query:RG,props:UpdateValueMap,pathOrID:string|Path,options?:UpdateOptions):RG
Defined in: packages/core/src/utils/queryTools.ts:375
Updates multiple properties of a rule or group using a map of property names to their new values.
Type Parameters
| Type Parameter |
|---|
RG extends RuleGroupTypeAny |
Parameters
| Parameter | Type | Description |
|---|---|---|
query | RG | The query to update. |
props | UpdateValueMap | A map of property names to their new values. |
pathOrID | string | Path | The path or ID of the rule or group to update. |
options? | UpdateOptions | Options. |
Returns
RG
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.