Interface KafkaConsumerLike

Minimal consumer shape used by the Kafka transport.

interface KafkaConsumerLike {
    connect(): Promise<void>;
    disconnect(): Promise<void>;
    run(
        options: {
            eachMessage(args: { message: KafkaMessageLike }): void | Promise<void>;
        },
    ): Promise<void>;
    subscribe(
        options: { fromBeginning: boolean; topic: string },
    ): Promise<void>;
}

Index

Methods

connect disconnect run subscribe

Methods

connect

connect(): Promise<void>
Connect the consumer before subscribing.

Returns Promise<void>
- Defined in packages/kkrpc/src/transports/kafka.ts:71

disconnect

disconnect(): Promise<void>
Disconnect the consumer and release network resources.

Returns Promise<void>
- Defined in packages/kkrpc/src/transports/kafka.ts:73

run

run(
    options: {
        eachMessage(args: { message: KafkaMessageLike }): void | Promise<void>;
    },
): Promise<void>
Start consuming messages from the subscription.
Parameters
- options: { eachMessage(args: { message: KafkaMessageLike }): void | Promise<void> }
Returns Promise<void>
- Defined in packages/kkrpc/src/transports/kafka.ts:77

subscribe(options: { fromBeginning: boolean; topic: string }): Promise<void>
Subscribe the consumer to one topic.
Parameters
- options: { fromBeginning: boolean; topic: string }
Returns Promise<void>
- Defined in packages/kkrpc/src/transports/kafka.ts:75

Interface KafkaConsumerLike

Index

Methods

Methods

connect

Returns Promise<void>

disconnect

Returns Promise<void>

run

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Settings

On This Page