Class IterableWeakMap<K, V>

Stores a map of objects with weak references to the keys, allowing them to be garbage collected. Both keys and values can be iterated over, unlike a WeakMap.

Template: K

Template: V

Type Parameters

K extends WeakKey
V

Hierarchy

WeakMap
- IterableWeakMap

Index

Constructors

Methods

[iterator] clear delete entries get keys set values

Constructors

constructor

new IterableWeakMap<K extends WeakKey, V>(
entries?: Iterable<[K, V], undefined, unknown>,
): IterableWeakMap<K, V>
Type Parameters
- K extends WeakKey
- V
Parameters
- Optionalentries: Iterable<[K, V], undefined, unknown> = []
  The initial entries.
Returns IterableWeakMap<K, V>
Overrides WeakMap.constructor

Methods

[iterator]

"[iterator]"(): Generator<[K, V], void, unknown>
Enumerate the entries.

Returns Generator<[K, V], void, unknown>

clear

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

Returns void

delete

delete(key: K): boolean
Remove a key from the map.
Parameters
- key: K
  The key to remove.
Returns boolean
Overrides WeakMap.delete

entries

entries(): Generator<[K, V], void, unknown>
Enumerate the entries.

Returns Generator<[K, V], void, unknown>

get

get(key: K): V | undefined
Retrieve a value from the map.
Parameters
- key: K
  The value's key.
Returns V | undefined
Overrides WeakMap.get

keys

keys(): Generator<K, void, unknown>
Enumerate the keys.

Returns Generator<K, void, unknown>

set

set(key: K, value: V): IterableWeakMap<K, V>
Place a value in the map.
Parameters
- key: K
  The key.
- value: V
  The value.
Returns IterableWeakMap<K, V>
Overrides WeakMap.set

values

values(): Generator<V, void, unknown>
Enumerate the values.

Returns Generator<V, void, unknown>