KafkaOptionsType

Defined in: src/io/broker/KafkaOptions.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

brokers?

readonly optional brokers?: string | readonly string[]

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

Bootstrap servers ('kafka-1:9092,kafka-2:9092' or array).

---

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

---

clientId?

readonly optional clientId?: string

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

Stable client id reported to the broker.

---

consumer?

readonly optional consumer?: object

Defined in: src/io/broker/KafkaOptions.ts:33

Consumer options. groupId is required to start a consumer.

commitMode?

readonly optional commitMode?: KafkaCommitMode

Offset-commit policy. Default 'auto' — kafkajs auto-commits after the handler returns (at-least-once). See KafkaCommitMode for the 'manual' (exactly-once-with- processing) shape.

commitTimeoutMs?

readonly optional commitTimeoutMs?: number

Max time in ms the manual-commit pump waits for an external commit / nack before giving up on a message and letting kafkajs reject it (which triggers a rebalance and re-delivery). Only used when commitMode === 'manual'. Default 30s.

fromBeginning?

readonly optional fromBeginning?: boolean

groupId?

readonly optional groupId?: string

---

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

---

producer?

readonly optional producer?: object

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

Producer options.

allowAutoTopicCreation?

readonly optional allowAutoTopicCreation?: boolean

idempotent?

readonly optional idempotent?: boolean

---

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

---

sasl?

readonly optional sasl?: object

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

Optional SASL credentials.

mechanism

readonly mechanism: "plain" | "scram-sha-256" | "scram-sha-512"

password

readonly password: string

username

readonly username: string

---

ssl?

readonly optional ssl?: boolean

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

Enable TLS.

---

target?

readonly optional target?: ActorRef<KafkaRecord>

Defined in: src/io/broker/KafkaOptions.ts:52

Subscriber that receives every consumed record.

---

topics?

readonly optional topics?: readonly string[]

Defined in: src/io/broker/KafkaOptions.ts:54

Topics the consumer subscribes to at connect time.