Class RedisCache

Class RedisCache. Implements cache engine over redis.

Hierarchy

RedisCache

Implements

ICache

Index

Properties

Methods

Properties

name

name: string = RedisCache.name

options

options: IRedisCacheOptions

ready

ready: boolean = false

Methods

del

del(key: string): Promise<boolean>

Implementation of ICache.del
- Defined in src/cache/RedisCache.ts:180
Removes stored in cache value under given key

Parameters
- key: string
Returns Promise<boolean>

get

get(key: string): Promise<any>

Implementation of ICache.get
- Defined in src/cache/RedisCache.ts:129
Returns value stored in cache by a given key

Parameters
- key: string
Returns Promise<any>

init

init(options?: IRedisCacheOptions): Promise<RedisCache>

- Defined in src/cache/RedisCache.ts:53
Initializes cache instance

Parameters
- Optional options: IRedisCacheOptions
Returns Promise<RedisCache>

set

set(key: string, value: any, ttl?: undefined | number, nx?: boolean): Promise<boolean>

- Defined in src/cache/RedisCache.ts:152
Stores in cache given value under given key. If TTL is specified, cached value will expire in a given number of milliseconds. If NX argument set to true will create key:value in cache only if it does not exists yet. Given value could be any JSON-compatible object and will be serialized automatically.

Parameters
- key: string
- value: any
- Optional ttl: undefined | number
- Default value nx: boolean = false
Returns Promise<boolean>

Static destroy

destroy(): Promise<void>

- Defined in src/cache/RedisCache.ts:189
Safely destroys redis connection

Returns Promise<void>