JetStreamActorSettings

Defined in: src/io/broker/JetStreamActor.ts:148

Common settings every broker actor accepts on top of its protocol- specific options. Subclasses extend this interface with their own required fields (e.g. brokerUrl, topics).

Extends

BrokerCommonSettings

Properties

ackTimeoutMs?

readonly optional ackTimeoutMs?: number

Defined in: src/io/broker/JetStreamActor.ts:168

Max time the manual-ack pump waits for a ack/nak/term before giving up on a message and rejecting internally (kafkajs-style failure). Default = consumer.ackWaitMs ?? 30s.

circuitBreaker?

readonly optional circuitBreaker?: object

Defined in: src/io/broker/BrokerSettings.ts:28

Optional circuit-breaker around connectImpl. After failureThreshold consecutive failed connect attempts the breaker opens for resetMs and rejects new attempts immediately.

failureThreshold

readonly failureThreshold: number

resetMs

readonly resetMs: number

Inherited from

BrokerCommonSettings.circuitBreaker

consumer?

readonly optional consumer?: JetStreamConsumerConfig

Defined in: src/io/broker/JetStreamActor.ts:160

Consumer config — required to start a subscription.

name?

readonly optional name?: string

Defined in: src/io/broker/JetStreamActor.ts:156

Optional client name.

outboundBuffer?

readonly optional outboundBuffer?: number

Defined in: src/io/broker/BrokerSettings.ts:41

Maximum number of outbound messages buffered while the connection is connecting or disconnected. When the buffer is full the oldest message is dropped (FIFO eviction) and a BrokerBufferOverflow event is published. Default: 1000. Set to 0 to fail-fast (publish a BrokerNotConnected event and drop the message).

Inherited from

BrokerCommonSettings.outboundBuffer

password?

readonly optional password?: string

Defined in: src/io/broker/JetStreamActor.ts:154

reconnect?

readonly optional reconnect?: false | { factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }

Defined in: src/io/broker/BrokerSettings.ts:15

Reconnect strategy applied when the underlying connection drops or connectImpl throws. Default: exponential backoff starting at 200ms, doubling, capped at 30s, infinite attempts. Set to false to disable auto-reconnect (one-shot connections).