Class HashMap<TKey, TValue>

constructor

• new HashMap<TKey, TValue>(
      comparer?: HashableEqualityComparer<TKey>,
  ): HashMap<TKey, TValue>

  Type Parameters

  • TKey
  • TValue

  Parameters

  • Optionalcomparer: HashableEqualityComparer<TKey>

  Returns HashMap<TKey, TValue>

Readonly[toStringTag]

Readonlycomparer

size

• get size(): number

  Returns number

  the number of elements in the Map.

[iterator]

• "[iterator]"(): MapIterator<[TKey, TValue]>

  Returns MapIterator<[TKey, TValue]>

clear

• clear(): void

  Removes all elements from the Map.

  Returns void

delete

• delete(key: TKey): boolean

  Parameters

  • key: TKey

  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<[TKey, TValue]>

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

  Returns MapIterator<[TKey, TValue]>

forEach

• forEach(
      callbackfn: (value: TValue, key: TKey, map: this) => void,
      thisArg?: unknown,
  ): void

  Executes a provided function once per each key/value pair in the Map, in insertion order.

  Parameters

  • callbackfn: (value: TValue, key: TKey, map: this) => void
  • OptionalthisArg: unknown

  Returns void

get

• get(key: TKey): TValue | 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: TKey

  Returns TValue | undefined

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

getOrInsert

• getOrInsert(key: TKey, defaultValue: TValue): TValue

  Returns a specified element from the Map object. If no element is associated with the specified key, a new element with the value defaultValue will be inserted into the Map and returned.

  Parameters

  • key: TKey
  • defaultValue: TValue

  Returns TValue

  The element associated with the specified key, which will be defaultValue if no element previously existed.

getOrInsertComputed

• getOrInsertComputed(key: TKey, callback: (key: TKey) => TValue): TValue

  Returns a specified element from the Map object. If no element is associated with the specified key, the result of passing the specified key to the callback function will be inserted into the Map and returned.

  Parameters

  • key: TKey
  • callback: (key: TKey) => TValue

  Returns TValue

  The element associated with the specific key, which will be the newly computed value if no element previously existed.

has

• has(key: TKey): boolean

  Parameters

  • key: TKey

  Returns boolean

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

keys

• keys(): MapIterator<TKey>

  Returns an iterable of keys in the map

  Returns MapIterator<TKey>

set

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

  Returns this

values

• values(): MapIterator<TValue>

  Returns an iterable of values in the map

  Returns MapIterator<TValue>