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

    Type Alias ConsumerOptions

    Consumer configuration options.

    type ConsumerOptions = {
        assignor?: PartitionAssignor;
        autoCommit?: boolean;
        autoCommitIntervalMs?: number;
        connectionPool: ConnectionPool;
        groupId: string;
        groupInstanceId?: string | null;
        groupProtocol?: GroupProtocol;
        heartbeatIntervalMs?: number;
        isolationLevel?: typeof FetchIsolationLevel[keyof typeof FetchIsolationLevel];
        maxBytes?: number;
        maxPartitionBytes?: number;
        maxWaitMs?: number;
        minBytes?: number;
        offsetReset?: OffsetResetStrategy;
        rebalanceListener?: RebalanceListener;
        rebalanceTimeoutMs?: number;
        retry?: ConsumerRetryConfig;
        serverAssignor?: string | null;
        sessionTimeoutMs?: number;
        telemetry?: TelemetryConfig;
    }
    Index

    Properties

    assignor? autoCommit? autoCommitIntervalMs? connectionPool groupId groupInstanceId? groupProtocol? heartbeatIntervalMs? isolationLevel? maxBytes? maxPartitionBytes? maxWaitMs? minBytes? offsetReset? rebalanceListener? rebalanceTimeoutMs? retry? serverAssignor? sessionTimeoutMs? telemetry?

    Properties

    assignor?: PartitionAssignor

    Partition assignor strategy (classic protocol only).

    rangeAssignor
    autoCommit?: boolean

    Whether to auto-commit offsets.

    true
    autoCommitIntervalMs?: number

    Auto-commit interval in milliseconds.

    5000
    connectionPool: ConnectionPool

    The connection pool to use.

    groupId: string

    The consumer group ID.

    groupInstanceId?: string | null

    Group instance ID for static membership (KIP-345). Null for dynamic.

    groupProtocol?: GroupProtocol

    Consumer group protocol.

    • "classic" \u2014 JoinGroup/SyncGroup/Heartbeat/LeaveGroup (default)
    • "consumer" \u2014 KIP-848 ConsumerGroupHeartbeat with server-side assignment
    "classic"
    heartbeatIntervalMs?: number

    Heartbeat interval in milliseconds.

    3000
    isolationLevel?: typeof FetchIsolationLevel[keyof typeof FetchIsolationLevel]

    Fetch isolation level.

    ReadUncommitted
    maxBytes?: number

    Maximum bytes to fetch per request.

    52428800 (50 MiB)
    maxPartitionBytes?: number

    Maximum bytes to fetch per partition.

    1048576 (1 MiB)
    maxWaitMs?: number

    Maximum wait time in milliseconds for the broker to accumulate data.

    500
    minBytes?: number

    Minimum bytes for the broker to return.

    1
    offsetReset?: OffsetResetStrategy

    Offset reset strategy.

    "latest"
    rebalanceListener?: RebalanceListener

    Rebalance listener callbacks.

    rebalanceTimeoutMs?: number

    Rebalance timeout in milliseconds.

    60000
    retry?: ConsumerRetryConfig

    Retry configuration.

    serverAssignor?: string | null

    Server-side assignor name for KIP-848 protocol (e.g. "range", "uniform"). Only used when groupProtocol is "consumer". Null uses the broker default.

    sessionTimeoutMs?: number

    Session timeout in milliseconds.

    30000
    telemetry?: TelemetryConfig

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

    Settings

    Member Visibility

    On This Page

    Properties