Skip to main content

TransportHooks

Defined in: src/interfaces/hooks.interface.ts:38

Hook callbacks for transport lifecycle and operational events.

Events without a registered hook are silently ignored. Register hooks via forRoot({ hooks: { ... } }) for monitoring, alerting, or custom observability integration.

Example​

JetstreamModule.forRoot({
  hooks: {
    [TransportEvent.Error]: (error, context) => sentry.captureException(error),
    [TransportEvent.RpcTimeout]: (subject) => metrics.increment('rpc.timeout'),
  },
})

Methods​

connect()​

connect(server): void

Defined in: src/interfaces/hooks.interface.ts:40

Fired when NATS connection is established.

Parameters​

server​

string

Returns​

void

deadLetter()​

deadLetter(info): void

Defined in: src/interfaces/hooks.interface.ts:64

Fired when a message exhausts all delivery attempts (dead letter).

Parameters​

info​

DeadLetterInfo

Returns​

void

disconnect()​

disconnect(): void

Defined in: src/interfaces/hooks.interface.ts:43

Fired when NATS connection is lost.

Returns​

void

error()​

error(error, context?): void

Defined in: src/interfaces/hooks.interface.ts:49

Fired on any transport-level error.

Parameters​

error​

Error

context?​

string

Returns​

void

messageRouted()​

messageRouted(subject, kind): void

Defined in: src/interfaces/hooks.interface.ts:55

Fired after a message is successfully routed to its handler.

Parameters​

subject​

string

kind​

MessageKind

Returns​

void

reconnect()​

reconnect(server): void

Defined in: src/interfaces/hooks.interface.ts:46

Fired when NATS connection is re-established after a disconnect.

Parameters​

server​

string

Returns​

void

rpcTimeout()​

rpcTimeout(subject, correlationId): void

Defined in: src/interfaces/hooks.interface.ts:52

Fired when an RPC handler exceeds its timeout.

Parameters​

subject​

string

correlationId​

string

Returns​

void

shutdownComplete()​

shutdownComplete(): void

Defined in: src/interfaces/hooks.interface.ts:61

Fired after graceful shutdown completes.

Returns​

void

shutdownStart()​

shutdownStart(): void

Defined in: src/interfaces/hooks.interface.ts:58

Fired at the start of the graceful shutdown sequence.

Returns​

void