RuleGroupICDiagnosticsResult<R, C>

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

A RuleGroupTypeIC annotated with diagnostics results, as produced by formatQuery for the "diagnostics" format (independent combinators).

The generics mirror those of RuleGroupTypeIC.

Extends

• Omit<RuleGroupTypeIC<R, C>, "rules">

Type Parameters

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

Properties

combinator?

optional combinator?: undefined

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

Inherited from

DefaultRuleGroupTypeIC.combinator

---

combinatorPreceding?

optional combinatorPreceding?: C

Defined in: packages/core/src/types/ruleGroupsIC.ts:27

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

Inherited from

Omit.combinatorPreceding

---

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

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

The path to this group within the query tree.

Overrides

CommonRuleAndGroupProperties.path

---

reasons?

optional reasons?: any[]

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

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

---

rules

rules: RuleGroupICDiagnosticsArray<RuleGroupICDiagnosticsResult<R, C>, R, C>

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

---

valid

valid: boolean

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

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.