Skip to main content

RuleType<F extends string = string, O extends string = string, V = any, C extends string = string, M = Record<string, any>>

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

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

Extends​

Type Parameters​

Type ParameterDefault type
F extends stringstring
O extends stringstring
Vany
C extends stringstring
MRecord<string, any>

Properties​

combinatorPreceding?​

optional combinatorPreceding?: C

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

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:10

Inherited from​

CommonRuleAndGroupProperties.disabled

field​

field: F

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

id?​

optional id?: string

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

Inherited from​

CommonRuleAndGroupProperties.id

lhs?​

optional lhs?: ExpressionNode

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

When present, the rule's left-hand side is this expression. The field property continues to drive operator selection and validation.

match?​

optional match?: MatchConfig

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

meta?​

optional meta?: M

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

Opaque metadata for use by extension packages. The core library preserves this property but does not read or interpret it.

muted?​

optional muted?: boolean

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

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:33

path?​

optional path?: Path

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

Inherited from​

CommonRuleAndGroupProperties.path

value​

value: V

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

valueSource?​

optional valueSource?: ValueSource

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

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.