Class ObservableMap<K, V>

A map that emits events when its data changes.

Type Parameters

K
The type of the keys.
V
The type of the values.

Hierarchy

EventDispatcher<ObservableMapEventMap<K, V>>
- ObservableMap

Implements

Map<K, V>

Index

Constructors

Accessors

[toStringTag] size

Methods

[iterator] clear delete entries forEach get has keys set values

Constructors

constructor

new ObservableMap<K, V>(
iterable?: Iterable<readonly [K, V], any, any>,
): ObservableMap<K, V>
Constructs a new map.
Type Parameters
- K
  The type of the keys.
- V
  The type of the values.
Parameters
- Optionaliterable: Iterable<readonly [K, V], any, any>
  A list of entries to add to this map.
Returns ObservableMap<K, V>
Overrides EventDispatcher<ObservableMapEventMap<K, V>>.constructor
- Defined in src/utils/ObservableMap.ts:79

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Implementation of Map.[toStringTag]
- Defined in src/utils/ObservableMap.ts:93

size

get size(): number
Returns number
the number of elements in the Map.
Implementation of Map.size
- Defined in src/utils/ObservableMap.ts:87

Methods

[iterator]

"[iterator]"(): MapIterator<[K, V]>
Returns MapIterator<[K, V]>
Implementation of Map.[iterator]
- Defined in src/utils/ObservableMap.ts:183

clear

clear(): void
Returns void
Implementation of Map.clear
- Defined in src/utils/ObservableMap.ts:99

delete

delete(key: K): boolean
Parameters
- key: K
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Implementation of Map.delete
- Defined in src/utils/ObservableMap.ts:108

entries

entries(): MapIterator<[K, V]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[K, V]>
Implementation of Map.entries
- Defined in src/utils/ObservableMap.ts:159

forEach

forEach(
callbackfn: (value: V, key: K, map: Map<K, V>) => void,
thisArg?: unknown,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: V, key: K, map: Map<K, V>) => void
- OptionalthisArg: unknown
Returns void
Implementation of Map.forEach
- Defined in src/utils/ObservableMap.ts:177

get

get(key: K): V | undefined
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: K
Returns V | undefined
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Implementation of Map.get
- Defined in src/utils/ObservableMap.ts:128

has

has(key: K): boolean
Parameters
- key: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Implementation of Map.has
- Defined in src/utils/ObservableMap.ts:134

keys

keys(): MapIterator<K>
Returns an iterable of keys in the map

Returns MapIterator<K>
Implementation of Map.keys
- Defined in src/utils/ObservableMap.ts:165

set

set(key: K, value: V): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: K
- value: V
Returns this
Implementation of Map.set
- Defined in src/utils/ObservableMap.ts:140

values

values(): MapIterator<V>
Returns an iterable of values in the map

Returns MapIterator<V>
Implementation of Map.values
- Defined in src/utils/ObservableMap.ts:171