Interface Cache

Describes a cache (client).

Hierarchy

Cache

Implemented by

Index

Methods

get
set

Methods

get

get<TValue, TDefault>(key: any, defaultValue?: TValue): Promise<TValue | TDefault>

- Defined in src/cache/index.ts:33
Tries to return a value from the cache.

Type parameters
- TValue
- TDefault
Parameters
- key: any
  
  The key.
- Optional defaultValue: TValue
Returns Promise<TValue | TDefault>

The promise with the value or the default value.

set

set(key: any, value: any, opts?: SetCacheValueOptions | null | undefined): Promise<boolean>

- Defined in src/cache/index.ts:43
Sets a value.

Parameters
- key: any
  
  The key.
- value: any
  
  The value.
- Optional opts: SetCacheValueOptions | null | undefined
Returns Promise<boolean>

The promise that indicates if operation was successful or not.

Generated using TypeDoc