Class RedisConnection

Hierarchy

EventEmitter
- RedisConnection

Index

Constructors

constructor

Properties

minimumVersion

Accessors

Methods

Constructors

constructor

new RedisConnection(opts?: ConnectionOptions, shared?: boolean, blocking?: boolean): RedisConnection

Overrides EventEmitter.constructor
- Defined in classes/redis-connection.ts:40
Parameters
- Optional opts: ConnectionOptions
- shared: boolean = false
- blocking: boolean = true
Returns RedisConnection

Properties

Static minimumVersion

minimumVersion: string = '5.0.0'

Accessors

client

get client(): Promise<RedisClient>

- Defined in classes/redis-connection.ts:150
Returns Promise<RedisClient>

redisVersion

get redisVersion(): string

- Defined in classes/redis-connection.ts:248
Returns string

Methods

close

close(): Promise<void>

- Defined in classes/redis-connection.ts:217
Returns Promise<void>

disconnect

disconnect(): Promise<void>

- Defined in classes/redis-connection.ts:189
Returns Promise<void>

reconnect

reconnect(): Promise<void>

- Defined in classes/redis-connection.ts:212
Returns Promise<void>

Static waitUntilReady

waitUntilReady(client: RedisClient): Promise<void>

- Defined in classes/redis-connection.ts:113
Waits for a redis client to be ready.

Parameters
- client: RedisClient
Returns Promise<void>

Generated using TypeDoc