Skip to content

KafkaTransportOptions

Options for creating a Kafka-backed pubsub transport.

optional adminConfig?: AdminConstructorConfig

Optional Kafka admin constructor config.


client: Kafka

@confluentinc/kafka-javascript Kafka client.


optional consumerConfig?: KafkaConsumerOptions

Optional Kafka consumer constructor config.


optional defaultSource?: string

Default CloudEvent source for publishers using this transport.


optional interceptors?: PubSubInterceptor[]

Optional interceptors for transport operations.


optional producerConfig?: ProducerConstructorConfig

Optional Kafka producer constructor config.


optional publishTimeoutMs?: number

Optional timeout for Kafka producer sends in milliseconds.


optional scheduler?: PubSubScheduler

Optional scheduler used for durable notBefore publish and delayed retry.

Immediate publish/subscribe does not require a scheduler. If a publish call provides notBefore, or a handler returns ctx.retry({ delay }), the transport throws unless a scheduler was supplied.


optional signal?: AbortSignal

Optional signal that closes this transport when aborted.