Interface OptionDescriptor<T>

Current/default value and bounds for one exact snake_case option name.

interface OptionDescriptor<T extends OptionValue = OptionValue> {
    current: T;
    default: T;
    maximum?: number;
    minimum?: number;
    name: string;
    type: OptionType;
}

Type Parameters

T extends OptionValue = OptionValue

Index

Properties

current default maximum? minimum? name type

Properties

`Readonly`current

current: T

Current value on this model instance.

`Readonly`default

default: T

Compiled default value.

`Optional` `Readonly`maximum

maximum?: number

Inclusive numeric maximum, absent for boolean/string options.

`Optional` `Readonly`minimum

minimum?: number

Inclusive numeric minimum, absent for boolean/string options.

`Readonly`name

name: string

Exact native option name.

`Readonly`type

type: OptionType

Native option value category.