Interface CacheStore

Interface defining a cache store. Implement this interface to create a custom cache store.

publicapi

Hierarchy

CacheStore

Index

Methods

Methods

del

del(key: string): void | Promise<void>

- Defined in packages/common/cache/interfaces/cache-manager.interface.ts:34
Destroy a key/value pair from the cache.

Parameters
- key: string
  
  cache key
Returns void | Promise<void>

get

get<T>(key: string): Promise<T | undefined> | T | undefined

- Defined in packages/common/cache/interfaces/cache-manager.interface.ts:28
Retrieve a key/value pair from the cache.

Type parameters
- T
Parameters
- key: string
  
  cache key
Returns Promise<T | undefined> | T | undefined

set

set<T>(key: string, value: T, options?: CacheStoreSetOptions<T>): Promise<void> | void

- Defined in packages/common/cache/interfaces/cache-manager.interface.ts:18
Create a key/value pair in the cache.

Type parameters
- T
Parameters
- key: string
  
  cache key
- value: T
  
  cache value
- Optional options: CacheStoreSetOptions<T>
Returns Promise<void> | void

Generated using TypeDoc