xk6-kafka

---

Class: Consumer

Defined in: index.d.ts:428

Classdesc

Consumer reads messages from Kafka.

Example

// In init context
const consumer = new Consumer({
  brokers: ["localhost:9092"],
  topic: "my-topic",
});

// In VU code (default function)
const messages = consumer.consume({ maxMessages: 10, nanoPrecision: false });

// In teardown function
consumer.close();

Constructors

Constructor

new Consumer(readerConfig): Consumer

Defined in: index.d.ts:429

Parameters

readerConfig

ReaderConfig

Returns

Consumer

Methods

close()

close(): void

Defined in: index.d.ts:435

Returns

void

---

commitOffsets()

commitOffsets(): void

Defined in: index.d.ts:433

Returns

void

---

consume()

consume(consumeConfig): Message[]

Defined in: index.d.ts:430

Parameters

consumeConfig

ConsumeConfig

Returns

Message[]

---

position()

position(partition): number

Defined in: index.d.ts:432

Parameters

partition

number

Returns

number

---

seek()

seek(partition, offset): void

Defined in: index.d.ts:431

Parameters

partition

number

offset

number

Returns

void

---

stats()

stats(): ConsumerStats

Defined in: index.d.ts:434

Returns

ConsumerStats