Class Setting<T>

A setting value that can be observed for changes.

Each Setting instance manages its own value and listeners, providing a clean, composable alternative to global event buses or proxies.

Type Parameters

T

Index

Constructors

Properties

Accessors

Methods

onChange reset toString valueOf

Constructors

constructor

new Setting<T>(defaultValue: T): Setting<T>
Type Parameters
- T
Parameters
- defaultValue: T
Returns Setting<T>
- Defined in src/Settings.ts:20

Properties

`Readonly`defaultValue

defaultValue: T

Accessors

value

get value(): T
Get the current value

Returns T
- Defined in src/Settings.ts:25
set value(newValue: T): void
Set a new value, notifying listeners if changed
Parameters
- newValue: T
Returns void
- Defined in src/Settings.ts:30

Methods

onChange

onChange(listener: (oldValue: T, newValue: T) => void): UnsubscribeFunction
Subscribe to value changes.
Parameters
- listener: (oldValue: T, newValue: T) => void
Returns UnsubscribeFunction
Unsubscribe function
- Defined in src/Settings.ts:45

reset

reset(): void
Reset to default value

Returns void
- Defined in src/Settings.ts:51

toString

toString(): string
Returns string
- Defined in src/Settings.ts:60

valueOf

valueOf(): T
Allow implicit coercion in conditionals

Returns T
- Defined in src/Settings.ts:56