Class ObservableMap<K, V>

constructor

• new ObservableMap<K, V>(): ObservableMap<K, V>

• Type Parameters

  • K
  • V

  Returns ObservableMap<K, V>

Readonly[toStringTag]

@eventTypes

size

• get size(): number

• The number of elements.

  Returns number

[iterator]

• [iterator](): MapIterator<[K, V]>

• Returns the [key, value] pairs for each element in the map in insertion order.

  Returns MapIterator<[K, V]>

clear

• clear(): void

• Removes all elements.

  Returns void

delete

• delete(key): boolean

• Removes the specified element.

  Parameters

  • key: K

    The element's key.

  Returns boolean

  True if an element was deleted, otherwise false.

entries

• entries(): MapIterator<[K, V]>

• Returns the [key, value] pairs for each element in the map in insertion order.

  Returns MapIterator<[K, V]>

forEach

• forEach(callbackfn, thisArg?): void

• Executes a provided function once per each key/value pair in the map.

  Parameters

  • callbackfn: ((value: V, key: K, map: Map<K, V>) => void)

    Function to execute for each element.

    • • (value, key, map): void

      • Parameters

        • value: V
        • key: K
        • map: Map<K, V>

        Returns void

  • OptionalthisArg: unknown

    Value to use as this when executing callback.

  Returns void

get

• get(key): V

• 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

  Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

has

• has(key): boolean

• Indicates whether or not an element with the specified key exists.

  Parameters

  • key: K

    The key to test for.

  Returns boolean

keys

• keys(): MapIterator<K>

• Returns the keys for each element in the map in insertion order.

  Returns MapIterator<K>

set

• set(key, value): 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

toJSON

• toJSON(): unknown

• Returns a serializable representation of the map.

  Returns unknown

values

• values(): MapIterator<V>

• Returns the values for each element in the map in insertion order.

  Returns MapIterator<V>