Skip to main content

FullOperator<N extends string = string>

Defined in: packages/core/src/types/basic.ts:243

Full operator definition used in the operators/getOperators props of QueryBuilder. This type requires both name and value, but the operators/getOperators props themselves can use a FlexibleOption where only one of name or value is required, or FullOperator where only name is required.

The name/value properties of this interface can be narrowed with generics.

Extends​

Type Parameters​

Type ParameterDefault type
N extends stringstring

Indexable​

[key: string]: unknown

Properties​

arity?​

optional arity?: Arity

Defined in: packages/core/src/types/basic.ts:246


className?​

optional className?: Classname

Defined in: packages/core/src/types/basic.ts:60

Inherited from​

WithOptionalClassName.className


disabled?​

optional disabled?: boolean

Defined in: packages/core/src/types/options.ts:54

Inherited from​

BaseOption.disabled


label​

label: string

Defined in: packages/core/src/types/options.ts:53

Inherited from​

BaseOption.label


name​

name: N

Defined in: packages/core/src/types/options.ts:51

Inherited from​

WithOptionalClassName.name


value​

value: N

Defined in: packages/core/src/types/options.ts:52

Inherited from​

WithOptionalClassName.value


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.