Reader.md

xk6-kafka

---

Class: Reader

Defined in: index.d.ts:367

Classdesc

Reader reads messages from Kafka.

Example

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

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

// In teardown function
reader.close();

Constructors

Constructor

new Reader(readerConfig): Reader

Defined in: index.d.ts:374

Parameters

readerConfig

ReaderConfig

Reader configuration.

Returns

Reader

• Reader instance.

Methods

close()

close(): void

Defined in: index.d.ts:387

Returns

void

• Nothing.

Destructor

Description

Close the reader.

---

consume()

consume(consumeConfig): Message[]

Defined in: index.d.ts:381

Parameters

consumeConfig

ConsumeConfig

Consume configuration.

Returns

Message[]

• Messages.

Method

Read messages from Kafka.