Interface Map<K, V>

Type Parameters

K
V

Hierarchy

Map

Index

Properties

Methods

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly size

size: number

returns: the number of elements in the Map.

Methods

[iterator]

[iterator](): IterableIterator<[K, V]>

- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>

clear

clear(): void

- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Returns void

delete

delete(key: K): boolean

- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:27
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(): IterableIterator<[K, V]>

- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:126
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[K, V]>

forEach

forEach(callbackfn: ((value: V, key: K, map: internal.Map<K, V>) => void), thisArg?: any): void

- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:31
Executes a provided function once per each key/value pair in the Map, in insertion order.

Parameters
- callbackfn: ((value: V, key: K, map: internal.Map<K, V>) => void)
  - - (value: V, key: K, map: internal.Map<K, V>): void
    - Parameters
      - value: V
      - key: K
      - map: internal.Map<K, V>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: K): undefined | V

- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:36
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 undefined | V
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

has

has(key: K): boolean

- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:40
Parameters
- key: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.

keys

keys(): IterableIterator<K>

- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:131
Returns an iterable of keys in the map

Returns IterableIterator<K>

set

set(key: K, value: V): internal.Map<K, V>

- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:44
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 internal.Map<K, V>

values

values(): IterableIterator<V>

- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:136
Returns an iterable of values in the map

Returns IterableIterator<V>

Generated using TypeDoc