kkrpc
    Preparing search index...

    Interface KafkaTransportOptions

    Options for connecting a kkrpc transport to a Kafka topic.

    interface KafkaTransportOptions {
        __client?: KafkaClientLike;
        brokers?: string[];
        clientId?: string;
        consumerConfig?: Record<string, unknown>;
        fromBeginning?: boolean;
        groupId?: string;
        localPeerId: string;
        numPartitions?: number;
        producerConfig?: Record<string, unknown>;
        remotePeerId?: string;
        replicationFactor?: number;
        retry?: Record<string, unknown>;
        sasl?: Record<string, unknown>;
        ssl?: boolean | Record<string, unknown>;
        topic?: string;
    }
    Index

    Properties

    __client? brokers? clientId? consumerConfig? fromBeginning? groupId? localPeerId numPartitions? producerConfig? remotePeerId? replicationFactor? retry? sasl? ssl? topic?

    Properties

    Optional__client

    __client?: KafkaClientLike

    Optional Kafka client factory override used by tests and custom integrations.

    brokers?: string[]

    Kafka broker addresses passed to the KafkaJS client.

    clientId?: string

    KafkaJS client id. Defaults to a kkrpc id derived from localPeerId.

    consumerConfig?: Record<string, unknown>

    Extra KafkaJS consumer options.

    fromBeginning?: boolean

    Whether the consumer should read from the beginning when subscribing.

    groupId?: string

    Consumer group id used by the receiving side.

    localPeerId: string

    Stable id for this endpoint; used to filter self-delivered messages.

    numPartitions?: number

    Number of partitions to request when creating the topic.

    producerConfig?: Record<string, unknown>

    Extra KafkaJS producer options.

    remotePeerId?: string

    Optional target endpoint id for point-to-point delivery.

    replicationFactor?: number

    Replication factor to request when creating the topic.

    retry?: Record<string, unknown>

    KafkaJS retry configuration.

    sasl?: Record<string, unknown>

    KafkaJS SASL authentication configuration.

    ssl?: boolean | Record<string, unknown>

    KafkaJS SSL configuration.

    topic?: string

    Topic used to exchange kkrpc bus envelopes.

    Settings

    Member Visibility

    On This Page

    Properties