Class RedisCache

Class RedisCache. Implements cache engine over redis.

Implements

ICache

Index

Constructors

Properties

name options ready

Methods

del get init purge set destroy

Constructors

constructor

new RedisCache(): RedisCache
Returns RedisCache

Properties

name

name: string = RedisCache.name

options

options: IRedisCacheOptions

ready

ready: boolean = false

Methods

del

del(key: string): Promise<boolean>
Removes stored in cache value under given key
Parameters
- key: string
Returns Promise<boolean>
Implementation of ICache.del
- Defined in src/cache/RedisCache.ts:202

get

get(key: string): Promise<any>
Returns value stored in cache by a given key
Parameters
- key: string
Returns Promise<any>
Implementation of ICache.get
- Defined in src/cache/RedisCache.ts:142

init

init(options?: IRedisCacheOptions): Promise<RedisCache>
Initializes cache instance
Parameters
- Optionaloptions: IRedisCacheOptions
Returns Promise<RedisCache>
Implementation of ICache.init
- Defined in src/cache/RedisCache.ts:61

purge

purge(keyMask: string): Promise<boolean>
Purges all keys from cache by a given wildcard mask
Parameters
- keyMask: string
Returns Promise<boolean>
Implementation of ICache.purge
- Defined in src/cache/RedisCache.ts:216

set

set(key: string, value: any, ttl?: number, nx?: boolean): Promise<boolean>
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 exist yet. Given value could be any JSON-compatible object and will be serialized automatically.
Parameters
- key: string
- value: any
- Optionalttl: number
- nx: boolean = false
Returns Promise<boolean>
Implementation of ICache.set
- Defined in src/cache/RedisCache.ts:170

`Static`destroy

destroy(): Promise<void>
Safely destroys redis connection

Returns Promise<void>
- Defined in src/cache/RedisCache.ts:243