Appearance

API reference@connectum/events-amqpDocs 1.3.x

Connectum API Reference / @connectum/events-amqp / types / AmqpLifecycleCallbacks

Interface: AmqpLifecycleCallbacks ​

Defined in: packages/events-amqp/src/types.ts:495

Connection lifecycle callbacks.

Prefer the single discriminated onLifecycle callback; the flat callbacks are a compatibility shim over the same event stream and are deprecated since 1.3.0 (removal not before 2.0).

Properties ​

onConnected? ​

readonly optional onConnected?: () => void

Defined in: packages/events-amqp/src/types.ts:515

Returns ​

void

Deprecated ​

Since 1.3.0 — use onLifecycle (type: "connected"). Kept until at least 2.0.

onDisconnected? ​

readonly optional onDisconnected?: (cause) => void

Defined in: packages/events-amqp/src/types.ts:517

Parameters ​

cause ​

Error

Returns ​

void

Deprecated ​

Since 1.3.0 — use onLifecycle (type: "disconnected"). Kept until at least 2.0.

onLifecycle? ​

readonly optional onLifecycle?: (event) => void

Defined in: packages/events-amqp/src/types.ts:513

Single discriminated-union lifecycle callback — the preferred surface. Receives every AmqpLifecycleEvent, including blocked/unblocked, which have no flat-callback equivalent. Flat callbacks (if also set) are invoked after onLifecycle for the same underlying event.

MUST NOT throw: dispatch runs inside the connection driver's event handlers, so exceptions are isolated (swallowed) to protect the connection — a throwing callback neither disturbs recovery nor starves the flat shim.

Setting this (like onSetupFailed / failFastOnInitialSetupError) enables the startup validation probe: one extra short-lived connection plus a topology validation pass at connect() (requires recovery enabled), so setup-failed { initial: true } can be delivered for a deterministic misconfiguration at boot.

Parameters ​

event ​

AmqpLifecycleEvent

Returns ​

void

onReconnectFailed? ​

readonly optional onReconnectFailed?: (cause) => void

Defined in: packages/events-amqp/src/types.ts:530

Parameters ​

cause ​

Error

Returns ​

void

Deprecated ​

Since 1.3.0 — use onLifecycle (type: "reconnect-failed"). Kept until at least 2.0.

onReconnecting? ​

readonly optional onReconnecting?: (info) => void

Defined in: packages/events-amqp/src/types.ts:528

A reconnect attempt has been scheduled. Fires exactly ONCE per scheduled retry (amqplib's reconnect-scheduled). A failed attempt that also emits connect-failed does NOT double-invoke this; the terminal case (retry budget exhausted, or a fatal topology stop under treatTopologyErrorAsFatal) is reported via onReconnectFailed, not here.

Parameters ​

info ​
attempt ​

number

delay ​

number

error ​

Error

Returns ​

void

Deprecated ​

Since 1.3.0 — use onLifecycle (type: "reconnecting"). Kept until at least 2.0.

onSetupFailed? ​

readonly optional onSetupFailed?: (error, ctx) => void

Defined in: packages/events-amqp/src/types.ts:546

A setup/topology failure occurred while (re)applying the declarative topology — during the startup window (ctx.initial: true; ctx.attempt is 0 on the probe, or the 0-based attempt index in the bounded initial phase) and/or on a reconnect whose topology re-assert fails (ctx.initial: false, ctx.attempt ≥ 1).

This surfaces deterministic configuration drift (e.g. a missing queue in check mode, or a PRECONDITION_FAILED redeclare) distinctly from a mere broker outage, even when fail-fast is off. The initial-connect invocation requires a startup validation probe, which runs when either this callback, onLifecycle, or AmqpAdapterOptions.failFastOnInitialSetupError is set.

Parameters ​

error ​

Error

ctx ​
attempt ​

number

initial ​

boolean

Returns ​

void

Deprecated ​

Since 1.3.0 — use onLifecycle (type: "setup-failed"). Kept until at least 2.0.