Skip to content

Commit c53d1b1

Browse files
committed
Include ruleProcessor in transformQuery option list
1 parent 337c4d2 commit c53d1b1

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/api/misc.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@ function convertQuery(query: RuleGroupTypeIC): RuleGroupType;
4848
function transformQuery(query: RuleGroupTypeAny, options: QueryTransformerOptions): any;
4949
```
5050

51-
This function recursively steps through nested `rules` arrays in a `RuleGroupType` or `RuleGroupTypeIC`, passing each `RuleType` object to a provided `ruleProcessor` function. Several other options are also available:
51+
This function recursively steps through nested `rules` arrays in a `RuleGroupType` or `RuleGroupTypeIC`, passing each `RuleType` object to a provided `ruleProcessor` function. Available options include:
5252

53+
- `ruleProcessor`: Custom processing for each rule.
5354
- `ruleGroupProcessor`: Custom processing for each rule group. (The `rules` property will be overwritten.)
5455
- `propertyMap`: Keys in the rule or group objects that match keys in this object will be renamed to the corresponding value.
5556
- `combinatorMap`: Best explained with an example: `{and: "&&", or: "||"}` would translate "and"/"or" combinators to "&&"/"||", respectively.

0 commit comments

Comments
 (0)