Skip to content

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 ​

PropertyModifierTypeDescriptionInherited fromDefined in
defaultreadonlynumber-FieldBase.defaultconfig/types.ts:11
descriptionreadonlystringOne sentence that tells what the field changes.FieldBase.descriptionconfig/types.ts:6
kindreadonly"number"-FieldBase.kindconfig/types.ts:10
labelreadonlystringThe short name of the field.FieldBase.labelconfig/types.ts:4
maxreadonlynumberThe maximum value. It is a hard limit.-config/types.ts:20
minreadonlynumberThe minimum value.-config/types.ts:18
stepreadonlynumberThe interval between two valid values.-config/types.ts:22

Methods ​

parse() ​

ts
parse(input): number | undefined;

Defined in: config/types.ts:12

Parameters ​

ParameterType
inputunknown

Returns ​

number | undefined

Inherited from ​

ts
FieldBase.parse