Skip to main content

RulesEngineProcessor<TResult = unknown>

RulesEngineProcessor<TResult = unknown> = (rulesEngine: RulesEngineAny, options: FormatRulesEngineOptions) => TResult

Defined in: rules-engine/src/types/export.ts:43

Function to produce a result that formatRulesEngine uses when processing a react-querybuilder!RulesEngine RulesEngine or react-querybuilder!RulesEngineIC RulesEngineIC object.

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

FormatDefault rules engine processor
json-rules-enginedefaultRulesEngineProcessorJsonRulesEngine
nativedefaultRulesEngineProcessorNative
rulepilotdefaultRulesEngineProcessorRulePilot
node-rulesdefaultRulesEngineProcessorNodeRules

Type Parameters​

Type ParameterDefault type
TResultunknown

Parameters​

ParameterType
rulesEngineRulesEngineAny
optionsFormatRulesEngineOptions

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.