Class CustomMap<ExternalKey, InternalKey, V>

constructor

• new CustomMap<ExternalKey, InternalKey, V>(
      externalToInternal: (key: ExternalKey) => InternalKey,
      internalToExternal: (key: InternalKey) => ExternalKey,
  ): CustomMap<ExternalKey, InternalKey, V>

• Type Parameters

  • ExternalKey
  • InternalKey
  • V

  Parameters

  • externalToInternal: (key: ExternalKey) => InternalKey
  • internalToExternal: (key: InternalKey) => ExternalKey

  Returns CustomMap<ExternalKey, InternalKey, V>

Readonlyclear

[toStringTag]

• get "[toStringTag]"(): string

• Returns string

size

• get size(): number

• Returns number

  the number of elements in the Map.

[iterator]

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

• Returns MapIterator<[ExternalKey, V]>

delete

• delete(key: ExternalKey): boolean

• Parameters

  • key: ExternalKey

  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<[ExternalKey, V]>

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

  Returns MapIterator<[ExternalKey, V]>

forEach

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

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

  Parameters

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

  Returns void

get

• get(key: ExternalKey): undefined | 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: ExternalKey

  Returns undefined | V

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

getInternalMap

• getInternalMap(): Map<InternalKey, V>

• Returns Map<InternalKey, V>

has

• has(key: ExternalKey): boolean

• Parameters

  • key: ExternalKey

  Returns boolean

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

keys

• keys(): MapIterator<ExternalKey>

• Returns an iterable of keys in the map

  Returns MapIterator<ExternalKey>

set

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

  Returns this

values

• values(): MapIterator<V>

• Returns an iterable of values in the map

  Returns MapIterator<V>