Skip to main content

DiagnosticEntry

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

A single diagnostic entry produced by the "diagnostics" format.

Properties​

code​

code: string

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

A machine-readable code identifying the type of diagnostic.

id​

id: string

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

The id of the rule or group this diagnostic pertains to.

message​

message: string

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

A human-readable description of the diagnostic.

path​

path: number[]

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

The path to the rule or group within the query tree.

source​

source: "muted" | "placeholder" | "query-validator" | "field-validator" | "type-check" | "field-check"

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

Which check produced this diagnostic.

  • "placeholder" — a placeholder field, operator, or value
  • "muted" — a muted rule or group
  • "query-validator" — the query-level validator
  • "field-validator" — a field-level validator
  • "type-check" — value/type mismatch based on field inputType
  • "field-check" — field existence check against the fields config
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.