Class RedisCache

A Redis cache (client).

Hierarchy

CacheBase
- RedisCache

Implements

Cache

Index

Constructors

constructor

Properties

options

Methods

Constructors

constructor

new RedisCache(options: RedisCacheOptions): RedisCache

- Defined in src/cache/redis.ts:40
Initializes a new instance of that class.

Parameters
- options: RedisCacheOptions
  
  The options.
Returns RedisCache

Properties

Readonly options

options: RedisCacheOptions

The options.

Methods

Private createClient

createClient(): RedisClient

- Defined in src/cache/redis.ts:52
Returns RedisClient

get

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

Implementation of Cache.get

Inherited from CacheBase.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 getInner

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

Overrides CacheBase.getInner
- Defined in src/cache/redis.ts:89
inheritdoc

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

Protected getOptionValue

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

Inherited from CacheBase.getOptionValue
- 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

Inherited from CacheBase.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 setInner

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

Overrides CacheBase.setInner
- Defined in src/cache/redis.ts:120
inheritdoc

Parameters
- key: any
- value: any
- opts: SetCacheValueOptions
Returns Promise<void>

Private withConnection

withConnection<TResult>(func: (client: RedisClient) => TResult | PromiseLike<TResult>): Promise<TResult>

- Defined in src/cache/redis.ts:173
Type parameters
- TResult
Parameters
- func: (client: RedisClient) => TResult | PromiseLike<TResult>
  - - (client: RedisClient): TResult | PromiseLike<TResult>
    - Parameters
      - client: RedisClient
      Returns TResult | PromiseLike<TResult>
Returns Promise<TResult>

Static fromEnvironment

fromEnvironment(): RedisCache

- Defined in src/cache/redis.ts:78
Creates a new instance from environment variable.

Returns RedisCache

The new instance.

Generated using TypeDoc