Skip to content

basalt / queue-kafka/src / KafkaDriverOptions

Interface: KafkaDriverOptions ​

Defined in: queue-kafka/src/index.ts:59

Extended by ​

Properties ​

brokers ​

> brokers: string[]

Defined in: queue-kafka/src/index.ts:60


client? ​

> optional client?: KafkaClient

Defined in: queue-kafka/src/index.ts:69

Injectable client — defaults to kafkajs. Tests pass a fake.


clientId? ​

> optional clientId?: string

Defined in: queue-kafka/src/index.ts:61


deadSuffix? ​

> optional deadSuffix?: string

Defined in: queue-kafka/src/index.ts:67

Suffix for the dead-letter topic. Default '.dead'.


groupId? ​

> optional groupId?: string

Defined in: queue-kafka/src/index.ts:63

Consumer group used by workers. Default 'basalt-queue'.


onError? ​

> optional onError?: (error, info) => void

Defined in: queue-kafka/src/index.ts:77

Called on infrastructure faults the driver cannot recover in line — a worker's connect/subscribe/run failing at boot (otherwise the app reports healthy with ZERO workers and the rejection is process-fatal), or a retry/dead-letter re-publish failing inside the consume callback. Same pattern as the rabbitmq/sqs drivers. Default: console.error with context.

Parameters ​

error ​

unknown

info ​
queue? ​

string

source ​

"consumer" | "producer"

Returns ​

void


retrySuffix? ​

> optional retrySuffix?: string

Defined in: queue-kafka/src/index.ts:65

Suffix for the retry topic. Default '.retry'.

Released under the MIT License.