NatsOptionsType

Defined in: src/io/broker/NatsOptions.ts:14

Common options 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

• BrokerCommonOptionsType

Properties

circuitBreaker?

readonly optional circuitBreaker?: object

Defined in: src/io/broker/BrokerOptions.ts:48

Optional circuit-breaker around connectImplementation. 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

BrokerCommonOptionsType.circuitBreaker

---

name?

readonly optional name?: string

Defined in: src/io/broker/NatsOptions.ts:24

Optional client name reported to the server.

---

outboundBuffer?

readonly optional outboundBuffer?: number

Defined in: src/io/broker/BrokerOptions.ts:61

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

BrokerCommonOptionsType.outboundBuffer

---

password?

readonly optional password?: string

Defined in: src/io/broker/NatsOptions.ts:20

---

reconnect?

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

Defined in: src/io/broker/BrokerOptions.ts:35

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

Union Members

false

---

Type Literal

{ factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }

factor?

readonly optional factor?: number

initialDelayMs?

readonly optional initialDelayMs?: number

maxAttempts?

readonly optional maxAttempts?: number

Cap on retry attempts. Default: Infinity (retry forever).

maxDelayMs?

readonly optional maxDelayMs?: number

Inherited from

BrokerCommonOptionsType.reconnect

---

servers?

readonly optional servers?: string | readonly string[]

Defined in: src/io/broker/NatsOptions.ts:16

NATS server URLs ('nats://localhost:4222').

---

subscriptions?

readonly optional subscriptions?: readonly object[]

Defined in: src/io/broker/NatsOptions.ts:22

Subscriptions wired up at connect time. Subjects support * and > wildcards (NATS-side).

---

token?

readonly optional token?: string

Defined in: src/io/broker/NatsOptions.ts:18

Optional credentials (token / user-password).

---

user?

readonly optional user?: string

Defined in: src/io/broker/NatsOptions.ts:19