Class CustomKeyMap<TKey, TValue>`Abstract`

Type Parameters

TKey
TValue

Hierarchy

CustomKeyMap

Implements

Map<TKey, TValue>

Index

Accessors

[toStringTag] size

Methods

[iterator] clear delete entries forEach get getOrFail has keys set values

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Implementation of Map.[toStringTag]
- Defined in collections/custom-key-map.ts:63

size

get size(): number
Returns number
the number of elements in the Map.
Implementation of Map.size
- Defined in collections/custom-key-map.ts:44

Methods

[iterator]

"[iterator]"(): MapIterator<[TKey, TValue]>
Returns MapIterator<[TKey, TValue]>
Implementation of Map.[iterator]
- Defined in collections/custom-key-map.ts:60

clear

clear(): void
Returns void
Implementation of Map.clear
- Defined in collections/custom-key-map.ts:16

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.
Implementation of Map.delete
- Defined in collections/custom-key-map.ts:19

entries

entries(): MapIterator<[TKey, TValue]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[TKey, TValue]>
Implementation of Map.entries
- Defined in collections/custom-key-map.ts:47

forEach

forEach(
callbackfn: (value: TValue, key: TKey, map: Map<TKey, TValue>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: TValue, key: TKey, map: Map<TKey, TValue>) => void
- OptionalthisArg: any
Returns void
Implementation of Map.forEach
- Defined in collections/custom-key-map.ts:22

get

get(key: TKey): undefined | TValue
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 undefined | TValue
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Implementation of Map.get
- Defined in collections/custom-key-map.ts:27

getOrFail

getOrFail(key: TKey): TValue
Parameters
- key: TKey
Returns TValue
- Defined in collections/custom-key-map.ts:30

has

has(key: TKey): boolean
Parameters
- key: TKey
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Implementation of Map.has
- Defined in collections/custom-key-map.ts:37

keys

keys(): MapIterator<TKey>
Returns an iterable of keys in the map

Returns MapIterator<TKey>
Implementation of Map.keys
- Defined in collections/custom-key-map.ts:50

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
Implementation of Map.set
- Defined in collections/custom-key-map.ts:40

values

values(): MapIterator<TValue>
Returns an iterable of values in the map

Returns MapIterator<TValue>
Implementation of Map.values
- Defined in collections/custom-key-map.ts:55