Skip to main content

RulesEngineIC<R, C>

Defined in: packages/rules-engine/src/types/rulesEngine.ts:40

Properties common to both rules and groups.

Extends

Type Parameters

Type ParameterDefault type
R extends RuleTypeRuleType
C extends stringstring

Properties

conditions

conditions: REConditionCascade<RuleGroupTypeIC<R, C>>

Defined in: packages/rules-engine/src/types/rulesEngine.ts:44


defaultConsequent?

optional defaultConsequent: Consequent

Defined in: packages/rules-engine/src/types/rulesEngine.ts:45


disabled?

optional disabled: boolean

Defined in: packages/core/src/types/ruleGroups.ts:9

Inherited from

CommonRuleAndGroupProperties.disabled


id?

optional id: string

Defined in: packages/core/src/types/ruleGroups.ts:8

Inherited from

CommonRuleAndGroupProperties.id


muted?

optional muted: boolean

Defined in: packages/core/src/types/ruleGroups.ts:15

Whether this rule or group is muted. When muted, the rule or group is excluded from query export formats (SQL, JSON, MongoDB, etc.). For groups, muting recursively mutes all children.

Inherited from

CommonRuleAndGroupProperties.muted


path?

optional path: Path

Defined in: packages/core/src/types/ruleGroups.ts:7

Inherited from

CommonRuleAndGroupProperties.path


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.