Class Setting<SerializedType, DeserializedType>

Refers to a specific setting on the configuration. Should be initialized with a raw (serialized) type and an actual (deserialized) type.

This is used for both client and wiki-wide configuration.

Type Parameters

  • SerializedType
  • DeserializedType

Constructors

constructor

Properties

allowedValues? defaultValue deserialize? displayOptions? isDisabled isHidden serialize? basicSerializers

Methods

get load lock ok reset set unlock

Constructors

constructor

Properties

Optional ReadonlyallowedValues

allowedValues?: Record<string, DeserializedType> | DeserializedType[]

Allowed values for this setting. Specific values may be provided, or an object of "choice objects": value mapped by the choice label (to be used to get the choice text from i18n, e.g. deputy.setting.user.<group>.<name>.choice.<choice>). When an array is passed, the key to be used for i18n is equal to the result of the allowed value's toString function.

When using allowedValues, as much as possible use primitive types as the deserialized type, since indexOf is used to check if a value is allowed, which may not work properly for class instances or objects.

ReadonlydefaultValue

defaultValue: DeserializedType

The default value of the setting.

Optional Readonlydeserialize

deserialize?: Transformer<DeserializedType, SerializedType>

Parse a serialized value into a deserialized one.

Param: raw

The raw value to parse.

Returns

The parsed value.

Optional ReadonlydisplayOptions

displayOptions?: DisplayOptions

Display options for this setting when showing up on settings interfaces.

ReadonlyisDisabled

isDisabled: ((config?: UserConfiguration) => string | boolean)

Type declaration

    • (config?): string | boolean

    • Parameters

      Returns string | boolean

      if this option is disabled or not.

ReadonlyisHidden

isHidden: ((config?: UserConfiguration) => string | boolean)

Type declaration

    • (config?): string | boolean

    • Parameters

      Returns string | boolean

      if this option is hidden or not.

Optional Readonlyserialize

serialize?: Transformer<SerializedType, DeserializedType>

Serialize this setting's value or a given value.

Param: value

The value to serialize

Static ReadonlybasicSerializers

basicSerializers: {
    deserialize: ((value: any) => any);
    serialize: ((value: any) => any);
} = ...

Methods

get

load

lock

  • lock(): void

  • Prevents the value of the setting from being changed. Used for debugging.

    Returns void

ok

reset

set

  • set(v, throwOnInvalid?): void

  • Sets the value and performs validation. If the input is an invalid value, and throwOnInvalid is false, the value will be reset to default.

    Parameters

    Returns void

unlock

  • unlock(): void

  • Allows the value of the setting to be changed. Used for debugging.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods