Class PersistentLRUCache<K, V>

A persistent LRUCache. Supported value types are limited by the storage API. In addition to JSON-ifiable values, i.e. Plain Old JavaScript Objects (POJOs), accepted by the storage API, arbitrary objects that implement the Pojoifiable interface can be cached. The conversion from Pojoifiable (and back via the Depojoifier interface) is handled automatically.

Type Parameters

K extends string
The type of cache keys.
V extends Pojoifiable | unknown
The type of values store in this cache.

Hierarchy (View Summary)

LRUCache<K, V>
- PersistentLRUCache

Index

Constructors

constructor

Methods

clear delete get has keys set

Constructors

constructor

new PersistentLRUCache<K extends string, V extends unknown>(
...args: PersistentLRUCacheArgs<V>,
): PersistentLRUCache<K, V>
Type Parameters
- K extends string
  The type of cache keys.
- V extends unknown
  The type of values store in this cache.
Parameters
- ...args: PersistentLRUCacheArgs<V>
  Arguments for the PersistentLRUCache constructor:
  
  limit: the maximum number of entries held by the cache
  
  store: a KVStore instance to use for persistence
  
  area: the name of the storage area to use
  
  (optional) depojoifier: a Depojoifier for converting persisted POJOs to V; required if and only if V extends Pojoifiable.
Returns PersistentLRUCache<K, V>
Overrides LRUCache.constructor
- Defined in webcat/cache.ts:231

Methods

clear

clear(): Promise<void>
Clears all values from the cache.

Returns Promise<void>
Overrides LRUCache.clear
- Defined in webcat/cache.ts:293

delete

delete(key: K): Promise<void>
Clears a single value from the cache.
Parameters
- key: K
  The key to clear.
Returns Promise<void>
Overrides LRUCache.delete
- Defined in webcat/cache.ts:283

get

get(key: K): Promise<V | undefined>
Reads a cached value.
Parameters
- key: K
  The key to read.
Returns Promise<V | undefined>
A Promise that resolves with the value read.
Overrides LRUCache.get
- Defined in webcat/cache.ts:248

has

has(key: K): Promise<boolean>
Parameters
- key: K
Returns Promise<boolean>
A Promise that resolves to true if the given key exists in the cache.
Overrides LRUCache.has
- Defined in webcat/cache.ts:267

keys

keys(): Promise<K[]>
Returns Promise<K[]>
A Promise that resolves to an array of the keys in the cache.
Overrides LRUCache.keys
- Defined in webcat/cache.ts:275

set

set(key: K, value: V): Promise<void>
Caches a value.
Parameters
- key: K
  The key to use.
- value: V
  The value to cache.
Returns Promise<void>
Overrides LRUCache.set
- Defined in webcat/cache.ts:256

Class PersistentLRUCache<K, V>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PersistentLRUCache<K, V>

Methods

clear

Returns Promise<void>

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<V | undefined>

has

Parameters

Returns Promise<boolean>

keys

Returns Promise<K[]>

set

Parameters

Returns Promise<void>

Settings

On This Page