Skip to content

Interface: EnumField<V> ​

Defined in: config/types.ts:36

A field with a fixed list of string values.

Extends ​

  • FieldBase<"enum", V>

Type Parameters ​

Type ParameterDefault type
V extends stringstring

Properties ​

PropertyModifierTypeDescriptionInherited fromDefined in
defaultreadonlyV-FieldBase.defaultconfig/types.ts:11
descriptionreadonlystringOne sentence that tells what the field changes.FieldBase.descriptionconfig/types.ts:6
kindreadonly"enum"-FieldBase.kindconfig/types.ts:10
labelreadonlystringThe short name of the field.FieldBase.labelconfig/types.ts:4
optionsreadonlyreadonly V[]The valid values.-config/types.ts:38

Methods ​

parse() ​

ts
parse(input): V | undefined;

Defined in: config/types.ts:12

Parameters ​

ParameterType
inputunknown

Returns ​

V | undefined

Inherited from ​

ts
FieldBase.parse