Interface Setting

interface Setting {
    defaultValue: string;
    description: string;
    floatMax?: number;
    floatMin?: number;
    hotConfigurable: boolean;
    intMax?: number;
    intMin?: number;
    name: string;
    propertyType: SettingPropertyType;
    stringConstraint?: string;
    unit?: string;
}

Properties

defaultValue description floatMax? floatMin? hotConfigurable intMax? intMin? name propertyType stringConstraint? unit?

Properties

defaultValue

defaultValue: string

Value set when not specified.

description

description: string

Setting description.

OptionalfloatMax

floatMax?: number

Maximum value for float types.

OptionalfloatMin

floatMin?: number

Minimum value for float types.

hotConfigurable

hotConfigurable: boolean

Setting can be applied without restarting.

OptionalintMax

intMax?: number

Maximum value for int types.

OptionalintMin

intMin?: number

Minimum value for int types.

name

name: string

Setting name from the database engine.

propertyType

propertyType: SettingPropertyType

Setting type.

OptionalstringConstraint

stringConstraint?: string

Validation regex for string type settings.

Optionalunit

unit?: string

Setting base unit.

Settings

On This Page

Properties