Class MultiKeyMap<Key, V>

A utility class that works like a Map, but accepts multiple values as the key for each value.

Type Parameters

const Key extends readonly any[]
const V

Index

Constructors

Accessors

Methods

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

Constructors

constructor

new MultiKeyMap<const Key extends readonly any[], const V>(
entries?: null | MultiKeyMap<Key, V> | readonly (readonly [Key, V])[],
): MultiKeyMap<Key, V>
Type Parameters
- const Key extends readonly any[]
- const V
Parameters
- Optionalentries: null | MultiKeyMap<Key, V> | readonly (readonly [Key, V])[]
Returns MultiKeyMap<Key, V>
- Defined in MultiKeyMap.ts:10

Accessors

size

get size(): number
Get the number of entries in the map.

Returns number
- Defined in MultiKeyMap.ts:130

Methods

[iterator]

"[iterator]"(): Generator<[key: Key, value: V]>
Returns Generator<[key: Key, value: V]>
- Defined in MultiKeyMap.ts:170

clear

clear(): void
Clear all values from the map.

Returns void
- Defined in MultiKeyMap.ts:122

delete

delete(key: Readonly<Key>): boolean
Delete the value for a given key.

Time complexity: O(1), given that the length of the key is constant.
Parameters
- key: Readonly<Key>
Returns boolean
- Defined in MultiKeyMap.ts:87

entries

entries(): Generator<[key: Key, value: V]>
Get an iterator for all entries in the map.

Returns Generator<[key: Key, value: V]>
- Defined in MultiKeyMap.ts:137

forEach

forEach(
callbackfn: (value: V, key: Key, map: this) => void,
thisArg?: any,
): void
Call a function for each entry in the map.
Parameters
- callbackfn: (value: V, key: Key, map: this) => void
- OptionalthisArg: any
Returns void
- Defined in MultiKeyMap.ts:161

get

get(key: Readonly<Key>): undefined | V
Get a value for a given key.

Time complexity: O(1), given that the length of the key is constant.
Parameters
- key: Readonly<Key>
Returns undefined | V
- Defined in MultiKeyMap.ts:51

has

has(key: Readonly<Key>): boolean
Check if a value exists for a given key.

Time complexity: O(1), given that the length of the key is constant.
Parameters
- key: Readonly<Key>
Returns boolean
- Defined in MultiKeyMap.ts:72

keys

keys(): Generator<Key>
Get an iterator for all keys in the map.

Returns Generator<Key>
- Defined in MultiKeyMap.ts:145

set

set(key: Readonly<Key>, value: V): this
Add or update a value for a given key.

Time complexity: O(1), given that the length of the key is constant.
Parameters
- key: Readonly<Key>
- value: V
Returns this
- Defined in MultiKeyMap.ts:22

values

values(): Generator<V>
Get an iterator for all values in the map.

Returns Generator<V>
- Defined in MultiKeyMap.ts:153