Interface: UserSetting<T>

A user setting.

Type parameters

Name	Type
T	extends UserSettingValue

Hierarchy

• MutableSubscribable<T>

  ↳ UserSetting

Properties

definition

• Readonly definition: UserSettingDefinition<T>

This setting's definition.

Defined in

src/sdk/settings/UserSetting.ts:26

---

isMutableSubscribable

• Readonly isMutableSubscribable: true

Flags this object as a MutableSubscribable.

Inherited from

MutableSubscribable.isMutableSubscribable

Defined in

src/sdk/sub/Subscribable.ts:121

---

isSubscribable

• Readonly isSubscribable: true

Flags this object as a Subscribable.

Inherited from

MutableSubscribable.isSubscribable

Defined in

src/sdk/sub/Subscribable.ts:9

---

value

• value: T

This setting's current value.

Defined in

src/sdk/settings/UserSetting.ts:29

Methods

get

▸ get(): T

Gets this item's state.

Returns

T

This item's state.

Inherited from

MutableSubscribable.get

Defined in

src/sdk/sub/Accessible.ts:9

---

map

▸ map<M>(fn, equalityFunc?): MappedSubscribable<M>

Maps this subscribable to a new subscribable.

Type parameters

Name
M

Parameters

Name	Type	Description
fn	(input: T, previousVal?: M) => M	The function to use to map to the new subscribable.
equalityFunc?	(a: M, b: M) => boolean	The function to use to check for equality between mapped values. Defaults to the strict equality comparison (===).

Returns

MappedSubscribable<M>

The mapped subscribable.

Inherited from

MutableSubscribable.map

Defined in

src/sdk/sub/Subscribable.ts:36

▸ map<M>(fn, equalityFunc, mutateFunc, initialVal): MappedSubscribable<M>

Maps this subscribable to a new subscribable with a persistent, cached value which is mutated when it changes.

Type parameters

Name
M

Parameters

Name	Type	Description
fn	(input: T, previousVal?: M) => M	The function to use to map to the new subscribable.
equalityFunc	(a: M, b: M) => boolean	The function to use to check for equality between mapped values.
mutateFunc	(oldVal: M, newVal: M) => void	The function to use to change the value of the mapped subscribable.
initialVal	M	The initial value of the mapped subscribable.

Returns

MappedSubscribable<M>

The mapped subscribable.

Inherited from

MutableSubscribable.map

Defined in

src/sdk/sub/Subscribable.ts:45

---

pipe

▸ pipe(to, paused?): Subscription

Subscribes to and pipes this subscribable's state to a mutable subscribable. Whenever an update of this subscribable's state is received through the subscription, it will be used as an input to change the other subscribable's state.

Parameters

Name	Type	Description
to	MutableSubscribable<any, T>	The mutable subscribable to which to pipe this subscribable's state.
paused?	boolean	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Inherited from

MutableSubscribable.pipe

Defined in

src/sdk/sub/Subscribable.ts:60

▸ pipe<M>(to, map, paused?): Subscription

Subscribes to this subscribable's state and pipes a mapped version to a mutable subscribable. Whenever an update of this subscribable's state is received through the subscription, it will be transformed by the specified mapping function, and the transformed state will be used as an input to change the other subscribable's state.

Type parameters

Name
M

Parameters

Name	Type	Description
to	MutableSubscribable<any, M>	The mutable subscribable to which to pipe this subscribable's mapped state.
map	(fromVal: T, toVal: M) => M	The function to use to transform inputs.
paused?	boolean	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Inherited from

MutableSubscribable.pipe

Defined in

src/sdk/sub/Subscribable.ts:70

---

resetToDefault

▸ resetToDefault(): void

Resets this setting to its default value.

Returns

void

Defined in

src/sdk/settings/UserSetting.ts:32

---

set

▸ set(value): void

Sets the state of this item.

Parameters

Name	Type	Description
value	T	The input used to change the state.

Returns

void

Inherited from

MutableSubscribable.set

Defined in

src/sdk/sub/Accessible.ts:21

---

sub

▸ sub(handler, initialNotify?, paused?): Subscription

Subscribes to changes in this subscribable's state.

Parameters

Name	Type	Description
handler	(value: T) => void	A function which is called when this subscribable's state changes.
initialNotify?	boolean	Whether to immediately invoke the callback function with this subscribable's current state. Defaults to false. This argument is ignored if the subscription is initialized as paused.
paused?	boolean	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Inherited from

MutableSubscribable.sub

Defined in

src/sdk/sub/Subscribable.ts:19

---

unsub

▸ unsub(handler): void

Unsubscribes a callback function from this subscribable.

Parameters

Name	Type	Description
handler	(value: T) => void	The function to unsubscribe.

Returns

void

Deprecated

This method has been deprecated in favor of using the Subscription object returned by .sub() to manage subscriptions.

Inherited from

MutableSubscribable.unsub

Defined in

src/sdk/sub/Subscribable.ts:27