Class ValueMap<K, V>

A map implementation that uses value comparison for keys instead of referential identity.

IMPORTANT! we assume objects are never modified once the hash is computed and put in the Map. Modifying an object after adding to the Map will cause incorrect behaviour.

Type Parameters

  • K
  • V

Hierarchy

  • Map<K, V>
    • ValueMap

Properties

[toStringTag] [species]

Accessors

size

Methods

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

Properties

Readonly[toStringTag]

[toStringTag]: string

Static Readonly[species]

[species]: MapConstructor

Accessors

size

  • get size(): number

  • Returns number

    the number of elements in the Map.

Methods

[iterator]

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

  • Returns an iterable of entries in the map.

    Returns MapIterator<[K, V]>

clear

delete

  • delete(key): 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.

entries

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

  • Returns an iterable of key, value pairs for every entry in the map.

    Returns MapIterator<[K, V]>

forEach

  • forEach(callbackfn, thisArg?): 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)
        • (value, key, map): void

        • Parameters

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

          Returns void

    • OptionalthisArg: any

    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

  • Parameters

    • key: K

    Returns boolean

    boolean indicating whether an element with the specified key exists or not.

keys

  • keys(): MapIterator<K>

  • Returns an iterable of keys in the map

    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

values

  • values(): MapIterator<V>

  • Returns an iterable of values in the map

    Returns MapIterator<V>

Staticinit

Settings

Member Visibility

On This Page

Properties
Accessors
Methods