RuleType<F, O, V, C>

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

The main rule type. The field, operator, and value properties can be narrowed with generics.

Extends

• CommonRuleAndGroupProperties

Type Parameters

Type Parameter	Default type
F extends string	string
O extends string	string
V	any
C extends string	string

Properties

combinatorPreceding?

optional combinatorPreceding: C

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

Only used when adding a rule to a query that uses independent combinators.

---

disabled?

optional disabled: boolean

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

Inherited from

CommonRuleAndGroupProperties.disabled

---

field

field: F

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

---

id?

optional id: string

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

Inherited from

CommonRuleAndGroupProperties.id

---

match?

optional match: MatchConfig

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

---

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

---

operator

operator: O

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

---

path?

optional path: Path

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

Inherited from

CommonRuleAndGroupProperties.path

---

value

value: V

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

---

valueSource?

optional valueSource: ValueSource

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

---

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.