Interface: NumberField
Defined in: config/types.ts:16
A number field. parse clamps the value to min and max and rounds it to step.
Extends
FieldBase<"number",number>
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
default | readonly | number | - | 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 | "number" | - | FieldBase.kind | config/types.ts:10 |
label | readonly | string | The short name of the field. | FieldBase.label | config/types.ts:4 |
max | readonly | number | The maximum value. It is a hard limit. | - | config/types.ts:20 |
min | readonly | number | The minimum value. | - | config/types.ts:18 |
step | readonly | number | The interval between two valid values. | - | config/types.ts:22 |
Methods
parse()
ts
parse(input): number | undefined;Defined in: config/types.ts:12
Parameters
| Parameter | Type |
|---|---|
input | unknown |
Returns
number | undefined
Inherited from
ts
FieldBase.parse