Class MapValueNotifier<K, V>

Implements ObservableValue<ReadonlyMap<K, V>>, which is notified whenever set(), delete() or clear() is called.

Type Parameters

K
V

Implements

ObservableValue<ReadonlyMap<K, V>>

Index

Constructors

Methods

clear delete getValue set subscribe

Constructors

constructor

new MapValueNotifier<K, V>(init?: Map<K, V>): MapValueNotifier<K, V>
Type Parameters
- K
- V
Parameters
- Optionalinit: Map<K, V>
Returns MapValueNotifier<K, V>
- Defined in src/utils/observable-notifier-value.ts:172

Methods

clear

clear(): void
Returns void
- Defined in src/utils/observable-notifier-value.ts:207

delete

delete(key: K): boolean
Parameters
- key: K
Returns boolean
- Defined in src/utils/observable-notifier-value.ts:199

getValue

getValue(): ReadonlyMap<K, V>
Get the underlying map. Readonly because changing it won't trigger updates.

Returns ReadonlyMap<K, V>
Implementation of ObservableValue.getValue
- Defined in src/utils/observable-notifier-value.ts:188

set

set(key: K, value: V): this
Parameters
- key: K
- value: V
Returns this
- Defined in src/utils/observable-notifier-value.ts:193

subscribe(
callback: (v: ReadonlyMap<K, V>) => void,
initialTrigger?: boolean,
): Terminable
Subscribe to updates of the set
Parameters
- callback: (v: ReadonlyMap<K, V>) => void
- initialTrigger: boolean = false
Returns Terminable
Implementation of ObservableValue.subscribe
- Defined in src/utils/observable-notifier-value.ts:177