Skip to main content

DiagnosticsResult

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

Top-level result of formatQuery for the "diagnostics" format.

Properties​

diagnostics​

diagnostics: DiagnosticEntry[]

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

A flat array of all diagnostic entries across the tree.

fieldSummary​

fieldSummary: Record<string, DiagnosticsFieldSummaryEntry>

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

Per-field summary of rule counts and invalid counts.

query​

query: RuleGroupDiagnosticsResult<RuleDiagnosticsResult<string, string, any, string>, string> | RuleGroupICDiagnosticsResult<RuleDiagnosticsResult<string, string, any, string>, string>

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

The annotated query tree with valid, path, and level on every node.

stats​

stats: DiagnosticsStats

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

Aggregate statistics about the query.

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.