RuleProcessor()

RuleProcessor: (rule: RuleType, options?: ValueProcessorOptions, meta?: { context: Record<string, any>; processedParams: Record<string, any> | any[]; }) => any

Function to produce a result that formatQuery uses when processing a RuleType object.

See the default rule processor for each format to know what type to return.

Format	Default rule processor
sql	defaultRuleProcessorSQL
parameterized	defaultRuleProcessorParameterized
parameterized_named	defaultRuleProcessorParameterized
mongodb (deprecated)	defaultRuleProcessorMongoDB
mongodb_query	defaultRuleProcessorMongoDBQuery
cel	defaultRuleProcessorCEL
spel	defaultRuleProcessorSpEL
jsonlogic	defaultRuleProcessorJsonLogic
elasticsearch	defaultRuleProcessorElasticSearch
jsonata	defaultRuleProcessorJSONata

Parameters

Parameter	Type
rule	RuleType
options?	ValueProcessorOptions
meta?	{ context: Record<string, any>; processedParams: Record<string, any> | any[]; }
meta.context?	Record<string, any>
meta.processedParams?	Record<string, any> | any[]

Returns

any

Defined in

packages/react-querybuilder/src/types/importExport.ts:270

---

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.