Class BiMap<K, V>

constructor

• new BiMap<K, V extends object>(base?: Iterable<[K, V], any, any>): BiMap<K, V>

  Type Parameters

  • K
  • V extends object

  Parameters

  • Optionalbase: Iterable<[K, V], any, any>

  Returns BiMap<K, V>

Readonly[toStringTag]

size

[iterator]

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

  Returns MapIterator<[K, V]>

clear

• clear(): void

  Returns void

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.

entries

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

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

  Returns MapIterator<[K, V]>

forEach

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

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

  Parameters

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

  Returns void

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.

getKey

• getKey(value: V): K | undefined

  Parameters

  • value: V

  Returns K | undefined

has

• has(key: K): boolean

  Parameters

  • key: K

  Returns boolean

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

hasValue

• hasValue(value: V): boolean

  Parameters

  • value: V

  Returns boolean

keys

• keys(): MapIterator<K>

  Returns an iterable of keys in the map

  Returns MapIterator<K>

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

values

• values(): MapIterator<V>

  Returns an iterable of values in the map

  Returns MapIterator<V>