Class LRUCache<K, V>

Type Parameters

K = string
V = unknown

Index

Constructors

Methods

clear delete dump get info keys load purgeStale set values

Constructors

constructor

new LRUCache<K = string, V = unknown>(
options: LRUCacheOptions<K, V>,
): LRUCache<K, V>
Type Parameters
- K = string
- V = unknown
Parameters
- options: LRUCacheOptions<K, V>
Returns LRUCache<K, V>
- Defined in src/common/lib/LRUCache.ts:22

Properties

`Protected`cache

cache: Map<K, LRUCacheItem<V>> = ...

`Protected`options

options: Required<LRUCacheOptions<K, V>>

Methods

clear

clear(): void
Clear the cache

Returns void
- Defined in src/common/lib/LRUCache.ts:76

delete

delete(key: K, reason?: DisposeReason): boolean
Deletes a key out of the cache
Parameters
- key: K
- reason: DisposeReason = 'delete'
Returns boolean
- Defined in src/common/lib/LRUCache.ts:68

dump

dump(): [K, LRUCacheItem<V>][]
Returns [K, LRUCacheItem<V>][]
- Defined in src/common/lib/LRUCache.ts:81

get

get<T = V>(key: K, options?: { updateAgeOnGet?: boolean }): undefined | T
Return a value from the cache
Type Parameters
- T = V
Parameters
- key: K
- options: { updateAgeOnGet?: boolean } = {}
Returns undefined | T
- Defined in src/common/lib/LRUCache.ts:51

info

info(): { capacity: number; size: number }
Returns { capacity: number; size: number }
- capacity: number
- size: number
  The total number of items held in the cache at the current moment
- Defined in src/common/lib/LRUCache.ts:99

keys

keys(): K[]
Returns K[]
- Defined in src/common/lib/LRUCache.ts:106

load

load(entries: string | [K, LRUCacheItem<V>][]): void
Parameters
- entries: string | [K, LRUCacheItem<V>][]
Returns void
- Defined in src/common/lib/LRUCache.ts:84

purgeStale

purgeStale(): boolean
Delete any stale entries.

Returns boolean
- Defined in src/common/lib/LRUCache.ts:89

set

set<T = V>(key: K, value: T, opts?: { ttl?: number }): void
Add a value to the cache
Type Parameters
- T = V
Parameters
- key: K
- value: T
- Optionalopts: { ttl?: number }
Returns void
- Defined in src/common/lib/LRUCache.ts:34

values

values(): V[]
Returns V[]
- Defined in src/common/lib/LRUCache.ts:109