Appearance

API reference@connectum/events-redisDocs 1.3.x

Connectum API Reference / @connectum/events-redis / types / RedisLifecycleEvent

Type Alias: RedisLifecycleEvent ​

RedisLifecycleEvent = { connection: RedisLifecycleConnection; reconnected: boolean; type: "connected"; } | { connection: RedisLifecycleConnection; error: Error; type: "disconnected"; } | { attempt: number; connection: RedisLifecycleConnection; delay: number; error: Error; type: "reconnecting"; } | { connection: RedisLifecycleConnection; error: Error; type: "reconnect-failed"; } | { callback: string; error: Error; event: string; type: "lifecycle-error"; }

Defined in: types.ts:85

Connection lifecycle events of the Redis adapter, delivered to RedisLifecycleCallbacks.onLifecycle.

A discriminated union on type. The strings and the shared fields match the AMQP adapter's events; the type is local to this package. The adapter holds one publishing connection and one blocking connection per subscription, so one broker loss is reported once per connection (connection says which).

Union Members ​

Type Literal ​

{ connection: RedisLifecycleConnection; reconnected: boolean; type: "connected"; }

connection ​

readonly connection: RedisLifecycleConnection

reconnected ​

readonly reconnected: boolean

type ​

readonly type: "connected"

A connection became ready: for the first time (reconnected: false) or after a loss (reconnected: true).

Type Literal ​

{ connection: RedisLifecycleConnection; error: Error; type: "disconnected"; }

connection ​

readonly connection: RedisLifecycleConnection

error ​

readonly error: Error

type ​

readonly type: "disconnected"

A connection that had been ready was lost; the client retries on its own. Once per loss, however many attempts fail. Not delivered for the adapter's own close.

Type Literal ​

{ attempt: number; connection: RedisLifecycleConnection; delay: number; error: Error; type: "reconnecting"; }

attempt ​

readonly attempt: number

connection ​

readonly connection: RedisLifecycleConnection

delay ​

readonly delay: number

error ​

readonly error: Error

type ​

readonly type: "reconnecting"

The client scheduled a reconnect attempt after delay milliseconds; attempt counts them since the loss.

Type Literal ​

{ connection: RedisLifecycleConnection; error: Error; type: "reconnect-failed"; }

connection ​

readonly connection: RedisLifecycleConnection

error ​

readonly error: Error

type ​

readonly type: "reconnect-failed"

Terminal: the client ended without the adapter closing it (a retry strategy that returned no delay).

Type Literal ​

{ callback: string; error: Error; event: string; type: "lifecycle-error"; }

callback ​

readonly callback: string

error ​

readonly error: Error

event ​

readonly event: string

type ​

readonly type: "lifecycle-error"

A lifecycle callback threw or returned a rejected promise.