Skip to main content

FullOperator<N>

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

Properties​

arity?​

optional arity: Arity

Defined in​

packages/react-querybuilder/src/types/basic.ts:228

className?​

optional className: Classname

Inherited from​

HasOptionalClassName.className

Defined in​

packages/react-querybuilder/src/types/basic.ts:58

disabled?​

optional disabled: boolean

Inherited from​

FullOption.disabled

Defined in​

packages/react-querybuilder/src/types/options.ts:33

label​

label: string

Inherited from​

FullOption.label

Defined in​

packages/react-querybuilder/src/types/options.ts:32

name​

name: N

Inherited from​

FullOption.name

Defined in​

packages/react-querybuilder/src/types/options.ts:30

value​

value: N

Inherited from​

FullOption.value

Defined in​

packages/react-querybuilder/src/types/options.ts:31

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.