Skip to main content

getOption()

Call Signature​

getOption<OptType extends {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>(arr: FullOptionList<OptType>, name: string): OptType | undefined

Defined in: packages/core/src/utils/optGroupUtils.ts:263

Gets the option from an OptionList with the given name. Handles Option arrays as well as OptionGroup arrays.

Type Parameters​

Type Parameter
OptType extends {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }

Parameters​

ParameterType
arrFullOptionList<OptType>
namestring

Returns​

OptType | undefined

Call Signature​

getOption<OptType extends {[key: string]: unknown; disabled?: boolean; label: string; name?: string; value: string; }>(arr: FlexibleOptionList<OptType>, name: string): OptType | undefined

Defined in: packages/core/src/utils/optGroupUtils.ts:267

Gets the option from an OptionList with the given name. Handles Option arrays as well as OptionGroup arrays.

Type Parameters​

Type Parameter
OptType extends {[key: string]: unknown; disabled?: boolean; label: string; name?: string; value: string; }

Parameters​

ParameterType
arrFlexibleOptionList<OptType>
namestring

Returns​

OptType | undefined

Call Signature​

getOption<OptType extends {[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>(arr: FlexibleOptionList<OptType>, name: string): OptType | undefined

Defined in: packages/core/src/utils/optGroupUtils.ts:271

Gets the option from an OptionList with the given name. Handles Option arrays as well as OptionGroup arrays.

Type Parameters​

Type Parameter
OptType extends {[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }

Parameters​

ParameterType
arrFlexibleOptionList<OptType>
namestring

Returns​

OptType | undefined


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.