Class IterableWeakSet<T>

Stores a set of objects with weak references to them, allowing them to be garbage collected. Can be iterated over, unlike a WeakSet.

Template: T

Implements

Type Parameters

T extends WeakKey = WeakKey

Hierarchy (View Summary)

IterableWeakSet
- ActiveEffectRegistry

Index

Constructors

Methods

[iterator] add clear delete has values

Constructors

constructor

new IterableWeakSet<T extends WeakKey = WeakKey>(
entries?: Iterable<T, void, unknown>,
): IterableWeakSet<T>
Type Parameters
- T extends WeakKey = WeakKey
Parameters
- Optionalentries: Iterable<T, void, unknown> = []
  The initial entries.
Returns IterableWeakSet<T>

Methods

[iterator]

"[iterator]"(): Generator<T, void, unknown>
Enumerate the values.

Returns Generator<T, void, unknown>

add

add(value: T): IterableWeakSet<T>
Add a value to the set.
Parameters
- value: T
  The value to add.
Returns IterableWeakSet<T>

clear

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

Returns void

delete

delete(value: T): boolean
Delete a value from the set.
Parameters
- value: T
  The value to delete.
Returns boolean

has

has(value: T): boolean
Whether this set contains the given value.
Parameters
- value: T
  The value to test.
Returns boolean

values

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

Returns Generator<T, void, unknown>