Skip to main content

FormatCapabilities

Defined in: packages/core/src/utils/formatQuery/formatCapabilities.ts:12

Describes what an export format can express. Used by default rule processors to decide whether to skip a rule and by the "diagnostics" format (diagnosticsTargetFormat) to report rules that would be skipped.

Properties​

fieldValueSource​

fieldValueSource: boolean | ReadonlySet<"=" | "!=" | "<" | ">" | "<=" | ">=" | "contains" | "null" | "in" | "between" | "matches" | "endswith" | "beginswith" | "doesnotcontain" | "doesnotbeginwith" | "doesnotendwith" | "notnull" | "notin" | "notbetween" | "doesnotmatch">

Defined in: packages/core/src/utils/formatQuery/formatCapabilities.ts:16

Supports valueSource: 'field'. Set = only for those (lowercased) operators.


matchModes​

matchModes: ReadonlySet<"some" | "all" | "none" | "exactly" | "atleast" | "atmost">

Defined in: packages/core/src/utils/formatQuery/formatCapabilities.ts:18

Supported (lowercased, post-coercion) match modes. Empty = none.


nativeNot​

nativeNot: boolean

Defined in: packages/core/src/utils/formatQuery/formatCapabilities.ts:20

Native group negation. false = De Morgan push-down via negateRuleGroup.


operators​

operators: ReadonlySet<"=" | "!=" | "<" | ">" | "<=" | ">=" | "contains" | "null" | "in" | "between" | "matches" | "endswith" | "beginswith" | "doesnotcontain" | "doesnotbeginwith" | "doesnotendwith" | "notnull" | "notin" | "notbetween" | "doesnotmatch">

Defined in: packages/core/src/utils/formatQuery/formatCapabilities.ts:14

Lowercased operator names the format can express.


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.