RuleGroupProcessor()<TResult>
RuleGroupProcessor<
TResult> = (ruleGroup:RuleGroupTypeAny,options:FormatQueryFinalOptions,meta?: {context?:Record<string,any>;processedParams?:Record<string,any> |any[]; }) =>TResult
Defined in: packages/react-querybuilder/src/types/export.ts:419
Function to produce a result that formatQuery uses when processing a RuleGroupType or RuleGroupTypeIC object.
See the default rule group processor for each format to know what type to return.
| Format | Default rule group processor |
|---|---|
sql | defaultRuleGroupProcessorSQL |
parameterized | defaultRuleGroupProcessorParameterized |
parameterized_named | defaultRuleGroupProcessorParameterized |
mongodb (deprecated) | defaultRuleGroupProcessorMongoDB |
mongodb_query | defaultRuleGroupProcessorMongoDBQuery |
cel | defaultRuleGroupProcessorCEL |
spel | defaultRuleGroupProcessorSpEL |
jsonlogic | defaultRuleGroupProcessorJsonLogic |
elasticsearch | defaultRuleGroupProcessorElasticSearch |
jsonata | defaultRuleGroupProcessorJSONata |
Type Parameters
| Type Parameter | Default type |
|---|---|
TResult | unknown |
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
options | FormatQueryFinalOptions |
meta? | { context?: Record<string, any>; processedParams?: Record<string, any> | any[]; } |
meta.context? | Record<string, any> |
meta.processedParams? | Record<string, any> | any[] |
Returns
TResult
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.