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 Parameter | Default type |
|---|---|
V extends string | string |
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
default | readonly | V | - | FieldBase.default | config/types.ts:11 |
description | readonly | string | One sentence that tells what the field changes. | FieldBase.description | config/types.ts:6 |
kind | readonly | "enum" | - | FieldBase.kind | config/types.ts:10 |
label | readonly | string | The short name of the field. | FieldBase.label | config/types.ts:4 |
options | readonly | readonly V[] | The valid values. | - | config/types.ts:38 |
Methods
parse()
ts
parse(input): V | undefined;Defined in: config/types.ts:12
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
V | undefined
Inherited from
ts
FieldBase.parse