RuleGroupDiagnosticsResult<R extends RuleDiagnosticsResult = RuleDiagnosticsResult, C extends string = string>
Defined in: packages/core/src/types/export.ts:581
A RuleGroupType annotated with diagnostics results, as produced
by formatQuery for the "diagnostics" format.
The generics mirror those of RuleGroupType.
Extends
Omit<RuleGroupType<R,C>,"rules">
Type Parameters
| Type Parameter | Default type |
|---|---|
R extends RuleDiagnosticsResult | RuleDiagnosticsResult |
C extends string | string |
Properties
combinator
combinator:
C
Defined in: packages/core/src/types/ruleGroups.ts:61
Inherited from
Omit.combinator
disabled?
optionaldisabled?:boolean
Defined in: packages/core/src/types/ruleGroups.ts:10
Inherited from
CommonRuleAndGroupProperties.disabled
id?
optionalid?:string
Defined in: packages/core/src/types/ruleGroups.ts:9
Inherited from
CommonRuleAndGroupProperties.id
level
level:
number
Defined in: packages/core/src/types/export.ts:597
The nesting depth of this group (path.length).
muted?
optionalmuted?: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
not?
optionalnot?:boolean
Defined in: packages/core/src/types/ruleGroups.ts:63
Inherited from
Omit.not
path
path:
number[]
Defined in: packages/core/src/types/export.ts:595
The path to this group within the query tree.
Overrides
CommonRuleAndGroupProperties.path
reasons?
optionalreasons?:any[]
Defined in: packages/core/src/types/export.ts:593
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:598
valid
valid:
boolean
Defined in: packages/core/src/types/export.ts:586
Whether the group and all of its descendants are valid.
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.