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

    Type Alias ConnectionPoolOptions

    Options for the ConnectionPool.

    type ConnectionPoolOptions = {
        bootstrapBrokers: readonly BrokerAddress[];
        clientId?: string;
        connectTimeoutMs?: number;
        maxConnectionsPerBroker?: number;
        reconnect?: ReconnectStrategy;
        requestTimeoutMs?: number;
        sasl?: SaslConfig;
        socketFactory: SocketFactory;
        tls?: TlsConfig;
    }
    Index

    Properties

    bootstrapBrokers clientId? connectTimeoutMs? maxConnectionsPerBroker? reconnect? requestTimeoutMs? sasl? socketFactory tls?

    Properties

    bootstrapBrokers: readonly BrokerAddress[]

    Bootstrap broker addresses for initial cluster discovery.

    clientId?: string

    Client ID sent in request headers (default: "@qualithm/kafka-client").

    connectTimeoutMs?: number

    Connection timeout in milliseconds (default: 30000).

    maxConnectionsPerBroker?: number

    Maximum number of connections per broker (default: 1).

    reconnect?: ReconnectStrategy

    Opt-in reconnection strategy. When set, the pool replaces dead connections in the background with exponential backoff. Disabled by default.

    requestTimeoutMs?: number

    Per-request timeout in milliseconds (default: 30000).

    sasl?: SaslConfig

    SASL authentication configuration.

    socketFactory: SocketFactory

    Factory function for creating the underlying socket.

    tls?: TlsConfig

    TLS configuration.

    Settings

    Member Visibility

    On This Page

    Properties