Class RedisConnection

Hierarchy

EventEmitter
- RedisConnection

Index

Constructors

Properties

closing minimumVersion recommendedMinimumVersion

Accessors

client redisVersion

Methods

close disconnect reconnect waitUntilReady

Constructors

constructor

new RedisConnection(opts?: ConnectionOptions, shared?: boolean, blocking?: boolean): RedisConnection
Parameters
- Optional opts: ConnectionOptions
- shared: boolean = false
- blocking: boolean = true
Returns RedisConnection
Overrides EventEmitter.constructor
- Defined in classes/redis-connection.ts:48

Properties

closing

closing: boolean

`Static` minimumVersion

minimumVersion: string = '5.0.0'

`Static` recommendedMinimumVersion

recommendedMinimumVersion: string = '6.2.0'

Accessors

client

get client(): Promise<RedisClient>
Returns Promise<RedisClient>
- Defined in classes/redis-connection.ts:159

redisVersion

get redisVersion(): string
Returns string
- Defined in classes/redis-connection.ts:286

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in classes/redis-connection.ts:242

disconnect

disconnect(): Promise<void>
Returns Promise<void>
- Defined in classes/redis-connection.ts:214

reconnect

reconnect(): Promise<void>
Returns Promise<void>
- Defined in classes/redis-connection.ts:237

`Static` waitUntilReady

waitUntilReady(client: RedisClient): Promise<void>
Waits for a redis client to be ready.
Parameters
- client: RedisClient
Returns Promise<void>
- Defined in classes/redis-connection.ts:122

Generated using TypeDoc