Class: IauUserSettingManager

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/IauUserSettings.ts:25

A manager for IAU user settings.

Implements

• UserSettingManager<IauAllUserSettingTypes>

Constructors

Constructor

new IauUserSettingManager(bus, iauDefsConfig): IauUserSettingManager

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/IauUserSettings.ts:43

Constructor.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
iauDefsConfig	IauDefsConfig	A configuration object which defines IAU options.

Returns

IauUserSettingManager

Properties

iauCount

readonly iauCount: number

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/IauUserSettings.ts:32

The number of IAUs supported by this manager.

Methods

getAliasedManager()

getAliasedManager(index): UserSettingManager<IauUserSettingTypes>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/IauUserSettings.ts:100

Gets a manager for aliased IAU user settings for an indexed IAU.

Parameters

Parameter	Type	Description
index	number	The index of the IAU for which to get an aliased setting manager.

Returns

UserSettingManager<IauUserSettingTypes>

A manager for aliased IAU user settings for the specified IAU.

Throws

RangeError if index is less than 1 or greater than the number of IAUs supported by this manager.

---

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/IauUserSettings.ts:85

Returns

UserSetting<UserSettingValue>[]

Inherit Doc

Implementation of

UserSettingManager.getAllSettings

---

getSetting()

getSetting<K>(name): UserSetting<NonNullable<IauAllUserSettingTypes[K]>>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/IauUserSettings.ts:75

Type Parameters

Type Parameter
K extends `iauAdcIndex_${number}` | `iauAhrsIndex_${number}`

Parameters

Parameter	Type
name	K

Returns

UserSetting<NonNullable<IauAllUserSettingTypes[K]>>

Inherit Doc

Implementation of

UserSettingManager.getSetting

---

mapTo()

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

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/IauUserSettings.ts:90

Type Parameters

Type Parameter
M extends UserSettingRecord

Parameters

Parameter	Type
map	UserSettingMap<M, IauAllUserSettingTypes>

Returns

UserSettingManager<M & IauAllUserSettingTypes>

Inherit Doc

Implementation of

UserSettingManager.mapTo

---

tryGetSetting()

tryGetSetting<K>(name): K extends `iauAdcIndex_${number}` | `iauAhrsIndex_${number}` ? UserSetting<IauAllUserSettingTypes[K<K>]> : undefined

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/IauUserSettings.ts:70

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
name	K

Returns

K extends `iauAdcIndex_${number}` | `iauAhrsIndex_${number}` ? UserSetting<IauAllUserSettingTypes[K<K>]> : undefined

Inherit Doc

Implementation of

UserSettingManager.tryGetSetting

---

whenSettingChanged()

whenSettingChanged<K>(name): Consumer<NonNullable<IauAllUserSettingTypes[K]>>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/IauUserSettings.ts:80

Type Parameters

Type Parameter
K extends `iauAdcIndex_${number}` | `iauAhrsIndex_${number}`

Parameters

Parameter	Type
name	K

Returns

Consumer<NonNullable<IauAllUserSettingTypes[K]>>

Inherit Doc

Implementation of

UserSettingManager.whenSettingChanged