Skip to main content

JetstreamHealthStatus

@horizon-republic/nestjs-jetstream


@horizon-republic/nestjs-jetstream / JetstreamHealthStatus

JetstreamHealthStatus

Defined in: src/interfaces/health.interface.ts:4

Health status returned by the JetStream health indicator.

Properties​

connected​

connected: boolean

Defined in: src/interfaces/health.interface.ts:6

Whether every critical connection is alive.


connections?​

optional connections?: Record<string, JetstreamConnectionHealth>

Defined in: src/interfaces/health.interface.ts:23

Per-connection breakdown.

Absent when only one connection is configured, so the single-connection response is byte-for-byte what it was before named connections existed.


degraded?​

optional degraded?: boolean

Defined in: src/interfaces/health.interface.ts:16

Whether at least one non-critical connection is down.

Orthogonal to connected, and absent when only one connection is configured.


latency​

latency: number | null

Defined in: src/interfaces/health.interface.ts:10

Default connection's round-trip latency in ms, or null if disconnected.


server​

server: string | null

Defined in: src/interfaces/health.interface.ts:8

Default connection's NATS server URL, or null if not connected.