Skip to content

Function: string2option() ​

string2option(value): object

Defined in: packages/validate-openalex/src/prompt/transformer.ts:50

Parameters ​

value ​

string

Returns ​

disabled? ​

optional disabled?: boolean

Whether this option is disabled. Disabled options are visible but cannot be selected.

By default, options are not disabled.

hint? ​

optional hint?: string

An optional hint to display to the user when this option might be selected.

By default, no hint is displayed.

label? ​

optional label?: string

The optional, user-facing text for this option.

By default, the value is converted to a string.

value ​

value: string

Internal data for this option.