Interface KafkaAdminLike

Minimal admin shape used to ensure the Kafka topic exists.

interface KafkaAdminLike {
    connect(): Promise<void>;
    createTopics(
        options: {
            topics: {
                numPartitions: number;
                replicationFactor: number;
                topic: string;
            }[];
            waitForLeaders: boolean;
        },
    ): Promise<unknown>;
    disconnect(): Promise<void>;
    listTopics(): Promise<string[]>;
}

Index

Methods

connect createTopics disconnect listTopics

Methods

connect

connect(): Promise<void>
Connect the admin client before topic operations.

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

createTopics

createTopics(
    options: {
        topics: {
            numPartitions: number;
            replicationFactor: number;
            topic: string;
        }[];
        waitForLeaders: boolean;
    },
): Promise<unknown>
Create topics when they do not already exist.
Parameters
- options: {
      topics: {
          numPartitions: number;
          replicationFactor: number;
          topic: string;
      }[];
      waitForLeaders: boolean;
  }
Returns Promise<unknown>
- Defined in packages/kkrpc/src/transports/kafka.ts:91

disconnect

disconnect(): Promise<void>
Disconnect the admin client.

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

listTopics

listTopics(): Promise<string[]>
List existing topic names.

Returns Promise<string[]>
- Defined in packages/kkrpc/src/transports/kafka.ts:89

Interface KafkaAdminLike

Index

Methods

Methods

connect

Returns Promise<void>

createTopics

Parameters

Returns Promise<unknown>

disconnect

Returns Promise<void>

listTopics

Returns Promise<string[]>

Settings

On This Page