RedisStreamsActorSettings

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

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

blockMs?

readonly optional blockMs?: number

Defined in: src/io/broker/RedisStreamsActor.ts:37

Block timeout per XREADGROUP call in ms. Default: 5_000.

---

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

---

consumerGroup?

readonly optional consumerGroup?: object

Defined in: src/io/broker/RedisStreamsActor.ts:30

Consumer-group settings — required to consume. When omitted only producing works.

consumer

readonly consumer: string

createIfMissing?

readonly optional createIfMissing?: boolean

Auto-create the group if missing. Default: true.

group

readonly group: string

---

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

---

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).

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

BrokerCommonSettings.reconnect

---

streams?

readonly optional streams?: readonly string[]

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

Streams to consume.

---

target?

readonly optional target?: ActorRef<RedisStreamEntry>

Defined in: src/io/broker/RedisStreamsActor.ts:39

Subscriber for inbound entries. Required to consume.

---

url?

readonly optional url?: string

Defined in: src/io/broker/RedisStreamsActor.ts:26

Redis URL ('redis://host:6379').