Documentation - v19.16.0-dev
    Preparing search index...

    Settings: its fields are ValueControllers or groups of them (other Settings). Walked by getControllers; set from a config by applyConfig; kept in the local storage by saveToLocalStorage and loadFromLocalStorage, e.g. when the page closes and opens.

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Sets the settings config gives, each validated (see ValueController.validate): a value refused is skipped with a warning, the others set. The keys that are not settings are ignored (e.g. of a config saved by another version).

      Parameters

      Returns void

    • Disconnects every listener of the settings: they are not used after.

      Returns void

    • The values changed from their default, group by group: a config for applyConfig.

      Returns SettingsConfig<this>

    • Every setting, in the order of the fields, a group's in place.

      Returns Generator<ValueController<unknown>>

    • Sets the settings saved under key in the local storage (saveToLocalStorage); none saved: unchanged. A value refused (e.g. by a later version) is skipped with a warning, the others set (see applyConfig); saved settings that cannot be read are ignored with a warning.

      Parameters

      • key: string

      Returns void

    • Sets every setting back to its default.

      Returns void

    • Saves the values changed from their default under key in the local storage, the key removed when none is: the others follow the defaults of the next versions.

      Parameters

      • key: string

      Returns void