Type Alias ConnectionOptions

Options for creating a KafkaConnection.

type ConnectionOptions = {
    clientId?: string;
    connectTimeoutMs?: number;
    host: string;
    port: number;
    requestTimeoutMs?: number;
    sasl?: SaslConfig;
    socketFactory: SocketFactory;
    tls?: TlsConfig;
}

Index

Properties

clientId? connectTimeoutMs? host port requestTimeoutMs? sasl? socketFactory tls?

Properties

`Optional` `Readonly`clientId

clientId?: string

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

`Optional` `Readonly`connectTimeoutMs

connectTimeoutMs?: number

Connection timeout in milliseconds (default: 30000).

`Readonly`host

host: string

Broker hostname.

`Readonly`port

port: number

Broker port.

`Optional` `Readonly`requestTimeoutMs

requestTimeoutMs?: number

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

`Optional` `Readonly`sasl

sasl?: SaslConfig

SASL authentication configuration.

`Readonly`socketFactory

socketFactory: SocketFactory

Factory function for creating the underlying socket.

`Optional` `Readonly`tls

tls?: TlsConfig

TLS configuration.