Class WeightedLruCache<K, V>

LRU bounded by both entry count and caller-defined weight units.

Type Parameters

K
V

Hierarchy (View Summary)

LruCache<K, V>
- WeightedLruCache

Index

Constructors

Accessors

size stats weight

Methods

clear delete get has keys peek set trySet

Constructors

constructor

new WeightedLruCache<K, V>(
options: WeightedCacheOptions<K, V>,
): WeightedLruCache<K, V>
Create a cache with caller-defined weight accounting and optional entry limits.
Type Parameters
- K
- V
Parameters
- options: WeightedCacheOptions<K, V>
Returns WeightedLruCache<K, V>
Overrides LruCache.constructor
- Defined in cache/LruCache.ts:193

Accessors

size

get size(): number
Number of currently retained entries.

Returns number
Inherited from LruCache.size
- Defined in cache/LruCache.ts:67

stats

get stats(): CacheStats
Return a new frozen snapshot of usage and limits.

Returns CacheStats
Inherited from LruCache.stats
- Defined in cache/LruCache.ts:79

weight

get weight(): number
Sum of currently retained entry weights.

Returns number
Inherited from LruCache.weight
- Defined in cache/LruCache.ts:73

Methods

clear

clear(): void
Remove all entries and reset retained weight to zero.

Returns void
Inherited from LruCache.clear
- Defined in cache/LruCache.ts:176

delete

delete(key: K): boolean
Remove an entry and its weight; return whether it existed.
Parameters
- key: K
Returns boolean
Inherited from LruCache.delete
- Defined in cache/LruCache.ts:160

get

get(key: K): V | undefined
Read a value and mark an existing entry most recently used.
Parameters
- key: K
Returns V | undefined
Inherited from LruCache.get
- Defined in cache/LruCache.ts:102

has

has(key: K): boolean
Test membership without refreshing recency.
Parameters
- key: K
Returns boolean
Inherited from LruCache.has
- Defined in cache/LruCache.ts:90

keys

keys(): MapIterator<K>
Live iterator, ordered least to most recently used.

Returns MapIterator<K>
Inherited from LruCache.keys
- Defined in cache/LruCache.ts:183

peek

peek(key: K): V | undefined
Read a value without refreshing recency; missing keys return undefined.
Parameters
- key: K
Returns V | undefined
Inherited from LruCache.peek
- Defined in cache/LruCache.ts:96

set

set(key: K, value: V): this
Chainable insertion. Use trySet when admission needs to be observed.
Parameters
- key: K
- value: V
Returns this
Inherited from LruCache.set
- Defined in cache/LruCache.ts:118

trySet

trySet(key: K, value: V): boolean
False means disabled or oversized. An existing value is preserved on rejection.
Parameters
- key: K
- value: V
Returns boolean
Inherited from LruCache.trySet
- Defined in cache/LruCache.ts:126