Skip to main content

Type Alias: UserSettingManagerEntry<T>

UserSettingManagerEntry<T> = object

Defined in: src/sdk/settings/UserSetting.ts:144

An entry for a user setting in a UserSettingManager.

Type Parameters​

Type ParameterDescription
T extends UserSettingValueThe type of the setting's value.

Properties​

crossSyncTopic?​

optional crossSyncTopic: `usersetting_sync_cross_${string}`

Defined in: src/sdk/settings/UserSetting.ts:152

The event topic used to sync the setting across instruments.

initSub​

initSub: Subscription

Defined in: src/sdk/settings/UserSetting.ts:161

The initialization subscription for the setting.

initUid​

initUid: number

Defined in: src/sdk/settings/UserSetting.ts:158

The unique ID attached to this entry's setting's initialization sync event.

setting​

setting: SyncableUserSetting<T>

Defined in: src/sdk/settings/UserSetting.ts:146

A user setting.

syncTime​

syncTime: number

Defined in: src/sdk/settings/UserSetting.ts:155

The timestamp of the most recent sync event.

syncTopic​

syncTopic: `usersetting_sync_${string}`

Defined in: src/sdk/settings/UserSetting.ts:149

The event topic used to sync the setting locally.