Class WeakCache<K, V>

Type Parameters

K extends {}
V extends WeakKey = WeakKey

Index

Constructors

Accessors

Methods

clear delete dispose ensure get has set values

Constructors

constructor

new WeakCache<K extends {}, V extends WeakKey = WeakKey>(
iterable?: null | Iterable<readonly [K, V], any, any>,
): WeakCache<K, V>
Type Parameters
- K extends {}
- V extends WeakKey = WeakKey
Parameters
- Optionaliterable: null | Iterable<readonly [K, V], any, any>
Returns WeakCache<K, V>
- Defined in weak-cache.ts:21

Accessors

size

get size(): number
Returns number
- Defined in weak-cache.ts:5

Methods

clear

clear(dispose?: (value: V) => void): void
Parameters
- Optionaldispose: (value: V) => void
Returns void
- Defined in weak-cache.ts:29

delete

delete(key: K): boolean
Removes the specified element from the WeakMap.
Parameters
- key: K
Returns boolean
true if the element was successfully removed, or false if it was not present.
- Defined in weak-cache.ts:44

dispose

dispose(): void
Returns void
- Defined in weak-cache.ts:54

ensure

ensure(key: K, create: () => V): V
Parameters
- key: K
- create: () => V
Returns V
- Defined in weak-cache.ts:63

get

get(key: K): undefined | V
Parameters
- key: K
Returns undefined | V
a specified element.
- Defined in weak-cache.ts:74

has

has(key: K): boolean
Parameters
- key: K
Returns boolean
a boolean indicating whether an element with the specified key exists or not.
- Defined in weak-cache.ts:81

set

set(key: K, value: V): this
Adds a new element with a specified key and value.
Parameters
- key: K
  Must be an object or symbol.
- value: V
Returns this
this
- Defined in weak-cache.ts:90

values

values(): IterableIterator<V>
Returns IterableIterator<V>
- Defined in weak-cache.ts:101