Skip to main content

Type Alias: UserSettingSaveManagerSettingDef<ValueType>

UserSettingSaveManagerSettingDef<ValueType> = object

Defined in: src/sdk/settings/UserSettingSaveManager.ts:10

A definition describing a user setting to be saved by UserSettingSaveManager.

Type Parameters

Type Parameter
ValueType extends UserSettingValue

Properties

loadValidator()?

optional loadValidator: (loadValue, setting) => ValueType

Defined in: src/sdk/settings/UserSettingSaveManager.ts:21

A function that validates a loaded value before it is applied to the setting. If not defined, then all loaded values will be applied to the setting as-is.

Parameters

ParameterTypeDescription
loadValueunknownThe loaded value.
settingUserSetting<ValueType>The setting to which the loaded value should be applied.

Returns

ValueType

The value that should be applied to the setting.


setting

setting: UserSetting<ValueType>

Defined in: src/sdk/settings/UserSettingSaveManager.ts:12

The setting to save.