Skip to main content

InferOperatorsOptions<O extends FullOperator = FullOperator>

Defined in: packages/core/src/utils/inferOperators.ts:30

Options for inferOperators.

Type Parameters​

Type ParameterDefault type
O extends FullOperatorFullOperator

Properties​

datatypeMap?​

optional datatypeMap?: DatatypeCategoryMap

Defined in: packages/core/src/utils/inferOperators.ts:36

Custom raw datatype → category map.


dropUnknownOperators?​

optional dropUnknownOperators?: boolean

Defined in: packages/core/src/utils/inferOperators.ts:41

Drop operators whose names are not in defaultOperators (i.e. custom operators). Default false.


labels?​

optional labels?: true | Partial<Record<FieldDatatypeCategory, Partial<Record<string, string>>>>

Defined in: packages/core/src/utils/inferOperators.ts:51

Type-specific operator labels. true → defaultDatatypeOperatorLabels. Only labels still equal to the default label are replaced.


map?​

optional map?: Partial<Record<FieldDatatypeCategory, string[]>>

Defined in: packages/core/src/utils/inferOperators.ts:34

Merged over defaultInferOperatorsMap (per-category replacement).


operators?​

optional operators?: FlexibleOptionList<O>

Defined in: packages/core/src/utils/inferOperators.ts:32

Operator list to narrow. Default defaultOperators.


warn?​

optional warn?: boolean

Defined in: packages/core/src/utils/inferOperators.ts:46

Dev-only console.warn when fieldData.operators lists operators incompatible with the field's datatype. Default false.


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.