Interface DataCache<K, V>

A persistent cache that stores data with an optional expiration time.

interface DataCache<K extends Data, V extends Data> {
    delete(key: K): Promise<void>;
    match(key: K): Promise<undefined | V>;
    put(key: K, value: V, options?: { maximumDuration: number }): Promise<void>;
}

Type Parameters

K extends Data
V extends Data

Index

Methods

delete match put

Methods

delete

delete(key: K): Promise<void>
Deletes an item from the cache.
Parameters
- key: K
  The key previously used to store the value.
Returns Promise<void>
- Defined in cache/data-cache.ts:34

match

match(key: K): Promise<undefined | V>
Attempts to retrieve a value from the cache.
Parameters
- key: K
  The key previously used to store the value.
Returns Promise<undefined | V>
- Defined in cache/data-cache.ts:29

put

put(key: K, value: V, options?: { maximumDuration: number }): Promise<void>
Stores a new value within the cache.
Parameters
- key: K
  key to use to store the value
- value: V
  the value to store
- Optionaloptions: { maximumDuration: number }
  optional TTL settings, relative to now
Returns Promise<void>
- Defined in cache/data-cache.ts:24

Interface DataCache<K, V>

Type Parameters

Index

Methods

Methods

delete

Parameters

Returns Promise<void>

match

Parameters

Returns Promise<undefined | V>

put

Parameters

Returns Promise<void>

Settings

On This Page