Skip to main content

FieldByValue<FieldName extends string = string, OperatorName extends string = string, ValueName extends string = string, OperatorObj extends FullOption = FullOption<OperatorName>>

FieldByValue<FieldName extends string = string, OperatorName extends string = string, ValueName extends string = string, OperatorObj extends FullOption = FullOption<OperatorName>> = WithUnknownIndex<{ name?: FieldName; } & Pick<BaseFullField<FieldName, OperatorName, ValueName, OperatorObj>, Exclude<keyof BaseFullField, "name">>>

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

Field definition used in the fields prop of QueryBuilder. This type is an extension of FullField where only value and label are required.

The name/value, operators, and values properties of this interface can be narrowed with generics.

Type Parameters​

Type ParameterDefault type
FieldName extends stringstring
OperatorName extends stringstring
ValueName extends stringstring
OperatorObj extends FullOptionFullOption<OperatorName>
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.