xk6-kafka

---

Class: Writer

Defined in: index.d.ts:325

Classdesc

Writer writes messages to Kafka.

Example

// In init context
const writer = new Writer({
  brokers: ["localhost:9092"],
  topic: "my-topic",
  autoCreateTopic: true,
});

// In VU code (default function)
writer.produce({
  messages: [
    {
      key: "key",
      value: "value",
    },
  ],
});

// In teardown function
writer.close();

Constructors

Constructor

new Writer(writerConfig): Writer

Defined in: index.d.ts:332

Parameters

writerConfig

WriterConfig

Writer configuration.

Returns

Writer

• Writer instance.

Methods

close()

close(): void

Defined in: index.d.ts:345

Returns

void

• Nothing.

Destructor

Description

Close the writer.

---

produce()

produce(produceConfig): void

Defined in: index.d.ts:339

Parameters

produceConfig

ProduceConfig

Produce configuration.

Returns

void

• Nothing.

Method

Write messages to Kafka.