Class CacheBase

A basic cache (client).

Hierarchy

CacheBase
- RedisCache

Implements

Cache

Index

Methods

Methods

get

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

Implementation of Cache.get
- Defined in src/cache/index.ts:56
Tries to return a value from the cache.

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

The promise with the value or the default value.

Protected Abstract getInner

getInner(key: string, defaultValue: any): Promise<any>

- Defined in src/cache/index.ts:66
inheritdoc

Parameters
- key: string
- defaultValue: any
Returns Promise<any>

Protected getOptionValue

getOptionValue<TValue, TDefault>(opts: {} | undefined | null, key: any, defaultValue?: TDefault): TValue | TDefault

- Defined in src/cache/index.ts:77
Tries to return a value from a key/value pair.

Type parameters
- TValue
- TDefault
Parameters
- opts: {} | undefined | null
  
  The key/value pair.
- key: any
  
  The key.
- Optional defaultValue: TDefault
Returns TValue | TDefault

The value or the default value if not found.

set

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

Implementation of Cache.set
- Defined in src/cache/index.ts:95
Sets a value.

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

The promise that indicates if operation was successful or not.

Protected Abstract setInner

setInner(key: string, defaultValue: any, opts: SetCacheValueOptions): Promise<void>

- Defined in src/cache/index.ts:117
The logic for 'set()' method.

Parameters
- key: string
  
  The key.
- defaultValue: any
  
  The default value.
- opts: SetCacheValueOptions
  
  Custom options.
Returns Promise<void>

Generated using TypeDoc