prorm API Reference
    Preparing search index...

    Interface KafkaStoreOptions

    Connection options for KafkaStore.

    Mirrors kafkajs's Kafka constructor options. brokers is the list of host:port seed brokers. A pre-built kafkajs Kafka instance can be injected via client, in which case connect() uses it directly and skips loading the driver (this is how tests inject a mock).

    interface KafkaStoreOptions {
        clientId?: string;
        brokers?: string[];
        ssl?: boolean | Record<string, unknown>;
        sasl?: KafkaSaslOptions;
        client?: any;
    }
    Index
    clientId? brokers? ssl? sasl? client?
    clientId?: string

    Client identifier reported to the broker.

    brokers?: string[]

    Seed broker list, e.g. ['localhost:9092'].

    ssl?: boolean | Record<string, unknown>

    Enable TLS, or pass a kafkajs TLS options object.

    sasl?: KafkaSaslOptions

    SASL authentication configuration.

    client?: any

    A pre-built kafkajs Kafka instance. When provided, connect() uses it directly and does not require('kafkajs').

    Settings
    Member Visibility

    On This Page
    Properties