Class WeakCache<K, V>

Type Parameters

K extends { }
V extends WeakKey = WeakKey

Index

Constructors

constructor

Accessors

size

Methods

clear delete dispose ensure get has set values

Constructors

constructor

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

Accessors

size

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

Methods

clear

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

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:43

dispose

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

ensure

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

get

get(key: K): V | undefined
Parameters
- key: K
Returns V | undefined

a specified element.
- Defined in weak-cache.ts:73

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:80

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:89

values

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

On This Page