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

Hierarchy

MultiKeyMap

Index

Constructors

Accessors

Methods

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

Constructors

constructor

new MultiKeyMap<const Key, const V>(entries?): MultiKeyMap<Key, V>
Type Parameters
- const Key extends readonly any[]
- const V
Parameters
- Optional entries: 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], any, unknown>
Returns Generator<[key: Key, value: V], any, unknown>
- Defined in MultiKeyMap.ts:170

clear

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

Returns void
- Defined in MultiKeyMap.ts:122

delete

delete(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], any, unknown>
Get an iterator for all entries in the map.

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

forEach

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

get

get(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): 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, any, unknown>
Get an iterator for all keys in the map.

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

set

set(key, value): MultiKeyMap<Key, V>
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 MultiKeyMap<Key, V>
- Defined in MultiKeyMap.ts:22

values

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

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