Class SortedIndexMap<Key, Value>

Static Readonly[species]

Readonly[toStringTag]

Readonlysize

StaticgroupBy

• groupBy<K, T>(
      items: Iterable<T>,
      keySelector: (item: T, index: number) => K,
  ): Map<K, T[]>

  Groups members of an iterable according to the return value of the passed callback.

  Type Parameters

  • K
  • T

  Parameters

  • items: Iterable<T>

    An iterable.

  • keySelector: (item: T, index: number) => K

    A callback which will be invoked for each item in items.

  Returns Map<K, T[]>

forEach

• forEach(
      callbackfn: (value: Value, key: Key, map: Map<Key, Value>) => void,
      thisArg?: any,
  ): void

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

  Parameters

  • callbackfn: (value: Value, key: Key, map: Map<Key, Value>) => void
  • OptionalthisArg: any

  Returns void

get

• get(key: Key): Value | 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: Key

  Returns Value | undefined

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

getOrInsert

• getOrInsert(key: Key, defaultValue: Value): Value

  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: Key
  • defaultValue: Value

  Returns Value

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

getOrInsertComputed

• getOrInsertComputed(key: Key, callback: (key: Key) => Value): Value

  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: Key
  • callback: (key: Key) => Value

  Returns Value

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

has

• has(key: Key): boolean

  Parameters

  • key: Key

  Returns boolean

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