@qualithm/kafka-client - v0.1.6
    Preparing search index...

    Type Alias ProducerOptions

    Options for creating a KafkaProducer.

    type ProducerOptions = {
        acks?: Acks;
        batch?: BatchConfig;
        compression?: CompressionCodec;
        connectionPool: ConnectionPool;
        idempotent?: boolean;
        partitioner?: Partitioner;
        retry?: RetryConfig;
        telemetry?: TelemetryConfig;
        timeoutMs?: number;
        transactionalId?: string;
    }
    Index

    Properties

    acks? batch? compression? connectionPool idempotent? partitioner? retry? telemetry? timeoutMs? transactionalId?

    Properties

    acks?: Acks

    Acknowledgement mode.

    Acks.All (-1)
    batch?: BatchConfig

    Batching configuration. When lingerMs > 0, messages are accumulated and flushed in batches.

    compression?: CompressionCodec

    Compression codec for record batches.

    CompressionCodec.NONE
    connectionPool: ConnectionPool

    The connection pool to use for sending messages.

    idempotent?: boolean

    Whether this is an idempotent producer. When true, the producer sets acks to All and uses producer IDs.

    false
    partitioner?: Partitioner

    Custom partitioner function.

    defaultPartitioner (murmur2-based key hash, round-robin for null keys)
    retry?: RetryConfig

    Retry configuration for retriable errors.

    telemetry?: TelemetryConfig

    Opt-in telemetry configuration (KIP-714). When provided, the producer periodically pushes client metrics to the broker.

    timeoutMs?: number

    Timeout in milliseconds for the broker to acknowledge the produce request.

    30000
    transactionalId?: string

    Transactional ID for transactional producers. Implies idempotent = true.

    Settings

    Member Visibility

    On This Page

    Properties