Skip to main content

RuleGroupDiagnosticsResult<R, C>

Defined in: packages/core/src/types/export.ts:533

A RuleGroupType annotated with diagnostics results, as produced by formatQuery for the "diagnostics" format.

The generics mirror those of RuleGroupType.

Extends​

Type Parameters​

Type ParameterDefault type
R extends RuleDiagnosticsResultRuleDiagnosticsResult
C extends stringstring

Properties​

combinator​

combinator: C

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

Inherited from​

Omit.combinator

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

level​

level: number

Defined in: packages/core/src/types/export.ts:549

The nesting depth of this group (path.length).

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

not?​

optional not?: boolean

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

Inherited from​

Omit.not

path​

path: number[]

Defined in: packages/core/src/types/export.ts:547

The path to this group within the query tree.

Overrides​

CommonRuleAndGroupProperties.path

reasons?​

optional reasons?: any[]

Defined in: packages/core/src/types/export.ts:545

Reasons why the group itself is invalid. Only present when the group is invalid and specific reasons were provided by the validator.

rules​

rules: RuleGroupDiagnosticsArray<RuleGroupDiagnosticsResult<R, C>, R>

Defined in: packages/core/src/types/export.ts:550

valid​

valid: boolean

Defined in: packages/core/src/types/export.ts:538

Whether the group and all of its descendants are valid.

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.