Class LRUCache<K, V>

A Least Recently Used cache.

When the cache needs to drop a value to stay within its bounds, it chooses the value that was accessed the least recently.

Type Parameters

K
V

Implements

Disposable

Index

Constructors

Accessors

Methods

[dispose] get has set

Constructors

constructor

new LRUCache<K, V>(options?: LRUCacheOptions<V>): LRUCache<K, V>
Type Parameters
- K
- V
Parameters
- options: LRUCacheOptions<V> = {}
Returns LRUCache<K, V>
- Defined in src/collections/lru-cache.ts:36

Accessors

size

get size(): number
Get the current size of the cache.

Returns number
- Defined in src/collections/lru-cache.ts:59

Methods

[dispose]

"[dispose]"(): void
Returns void
Implementation of Disposable.[dispose]
- Defined in src/collections/lru-cache.ts:40

get

get(key: K): Option<V>
Get the value associated with the given key, if it exists in the cache.
Parameters
- key: K
Returns Option<V>
- Defined in src/collections/lru-cache.ts:75

has

has(key: K): boolean
Test if the cache contains a given key.

This does not count as an access towards cache invalidation.
Parameters
- key: K
Returns boolean
- Defined in src/collections/lru-cache.ts:68

set

set(key: K, value: V): void
Add a key/value pair to the cache.
Parameters
- key: K
- value: V
Returns void
- Defined in src/collections/lru-cache.ts:88