Class WeakValueMultiKeyMap<Key, V>

A utility class that works like a Map, but accepts multiple values as the key for each value, and does not keep strong references to the values (allowing them to be garbage collected).

When a value is garbage collected, it is automatically removed from the map.

Type Parameters

const Key extends readonly any[]
const V extends object

Index

Constructors

constructor

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

Accessors

size

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

Returns number
- Defined in WeakValueMultiKeyMap.ts:114

Methods

[iterator]

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

clear

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

Returns void
- Defined in WeakValueMultiKeyMap.ts:102

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 WeakValueMultiKeyMap.ts:86

entries

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

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

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 WeakValueMultiKeyMap.ts:148

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 WeakValueMultiKeyMap.ts:57

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 WeakValueMultiKeyMap.ts:77

keys

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

Returns Generator<Key>
- Defined in WeakValueMultiKeyMap.ts:132

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 WeakValueMultiKeyMap.ts:32

values

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

Returns Generator<V>
- Defined in WeakValueMultiKeyMap.ts:140

Class WeakValueMultiKeyMap<Key, V>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WeakValueMultiKeyMap<Key, V>

Accessors

size

Returns number

Methods

[iterator]

Returns Generator<[key: Key, value: V]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns Generator<[key: Key, value: V]>

forEach

Parameters

Returns void

get

Parameters

Returns undefined | V

has

Parameters

Returns boolean

keys

Returns Generator<Key>

set

Parameters

Returns this

values

Returns Generator<V>

Settings

On This Page