Class IterableWeakMap

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.

Hierarchy

WeakMap
- IterableWeakMap

Index

Constructors

Methods

[iterator] clear delete entries get keys set values

Constructors

constructor

new IterableWeakMap(entries?: Iterable<[any, any], any, any>): IterableWeakMap
Parameters
- Optionalentries: Iterable<[any, any], any, any> = []
  The initial entries.
Returns IterableWeakMap
Overrides WeakMap.constructor

Methods

[iterator]

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

Returns Generator<[any, any], void, any>

clear

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

Returns void

delete

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

entries

entries(): Generator<[any, any], void, any>
Enumerate the entries.

Returns Generator<[any, any], void, any>

get

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

keys

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

Returns Generator<any, void, any>

set

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

values

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

Returns Generator<any, void, any>