RulesEngine<R, C>

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

Rules engine with standard query objects (RuleGroupType). Contains an array of conditions, each with an antecedent (rule group) and an optional consequent. An optional defaultConsequent can be specified that will be used if none of the conditions are met.

Extends

• CommonRuleAndGroupProperties

Type Parameters

Type Parameter	Default type
R extends RuleType	RuleType
C extends string	string

Properties

conditions

conditions: RECondition<RuleType<string, string, any, string>, string>[]

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

---

defaultConsequent?

optional defaultConsequent: Consequent

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

---

disabled?

optional disabled: boolean

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

Inherited from

CommonRuleAndGroupProperties.disabled

---

id?

optional id: string

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

Inherited from

CommonRuleAndGroupProperties.id

---

muted?

optional muted: boolean

Defined in: 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: 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.