Class: AliasedUserSettingManager<T>

Defined in: src/sdk/settings/AliasedUserSettingManager.ts:16

An aliased user setting manager which can dynamically (re)define the settings from which its aliased settings are sourced.

Type Parameters

Type Parameter	Description
T extends UserSettingRecord	The record describing the settings provided by the manager.

Implements

• UserSettingManager<T>

Constructors

Constructor

new AliasedUserSettingManager<T>(bus, settingDefs): AliasedUserSettingManager<T>

Defined in: src/sdk/settings/AliasedUserSettingManager.ts:27

Constructor.

Parameters

Parameter	Type	Description
bus	EventBus	The bus used by this manager to publish setting change events.
settingDefs	readonly UserSettingDefinition<T[keyof T & string]>[]	The setting definitions used to initialize this manager's settings. The definitions should define the settings' aliased names.

Returns

AliasedUserSettingManager<T>

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

Defined in: src/sdk/settings/AliasedUserSettingManager.ts:80

Gets an array of all settings of this manager.

Returns

UserSetting<UserSettingValue>[]

an array of all settings of this manager.

Implementation of

UserSettingManager.getAllSettings

---

getSetting()

getSetting<K>(name): UserSettingFromManager<T, K>

Defined in: src/sdk/settings/AliasedUserSettingManager.ts:58

Gets a setting from this manager.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type	Description
name	K	The name of the setting to get.

Returns

UserSettingFromManager<T, K>

The requested setting.

Throws

Error if no setting with the specified name exists.

Implementation of

UserSettingManager.getSetting

---

mapTo()

mapTo<M>(map): UserSettingManager<M & T>

Defined in: src/sdk/settings/AliasedUserSettingManager.ts:85

Maps a subset of this manager's settings to ones with aliased names, and creates a new setting manager which supports accessing the settings using their aliases.

Type Parameters

Type Parameter
M extends Record<any, UserSettingValue>

Parameters

Parameter	Type	Description
map	UserSettingMap<M, T>	A map defining the aliases of a subset of this manager's settings, with aliased setting names as keys and original setting names as values.

Returns

UserSettingManager<M & T>

A new setting manager which supports accessing a subset of this manager's settings using aliased names.

Implementation of

UserSettingManager.mapTo

---

tryGetSetting()

tryGetSetting<K>(name): OptionalUserSettingFromManager<T, K>

Defined in: src/sdk/settings/AliasedUserSettingManager.ts:53

Attempts to get a setting from this manager.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type	Description
name	K	The name of the setting to get.

Returns

OptionalUserSettingFromManager<T, K>

The requested setting, or undefined if no such setting exists.

Implementation of

UserSettingManager.tryGetSetting

---

useAliases()

useAliases<O>(masterManager, map): void

Defined in: src/sdk/settings/AliasedUserSettingManager.ts:44

Defines the mappings from this manager's aliased settings to their source settings. Once the mappings are defined, each aliased setting will take the value of its source setting, and setting the value of the aliased setting will also set the value of the source setting. If a source setting cannot be defined for an aliased setting, the aliased setting's value will be fixed to its default value and cannot be changed.

Type Parameters

Type Parameter
O extends UserSettingRecord

Parameters

Parameter	Type	Description
masterManager	UserSettingManager<O>	The manager hosting the settings from which this manager's aliased settings will be sourced.
map	UserSettingMap<T, O>	The mappings for this manager's aliased settings, as a set of key-value pairs where the keys are the aliased setting names and the values are the source setting names. For any aliased setting whose name does not appear as a key in the mapping, its source setting is assumed to have the same name.

Returns

void

---

whenSettingChanged()

whenSettingChanged<K>(name): UserSettingConsumerFromManager<T, K>

Defined in: src/sdk/settings/AliasedUserSettingManager.ts:68

Gets a consumer which notifies handlers when the value of a setting changes.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type	Description
name	K	The name of a setting.

Returns

UserSettingConsumerFromManager<T, K>

a consumer which notifies handlers when the value of the setting changes.

Throws

Error if no setting with the specified name exists.

Deprecated

Please use getSetting(name).sub() instead.

Implementation of

UserSettingManager.whenSettingChanged