Writer.md

Class: Writer

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();

Table of contents

Constructors

• constructor

Methods

• close
• produce

Constructors

constructor

• new Writer(writerConfig)

Parameters

Name	Type	Description
writerConfig	WriterConfig	Writer configuration.

Defined in

index.d.ts:324

Methods

close

▸ close(): void

destructor

description Close the writer.

Returns

void

• Nothing.

Defined in

index.d.ts:337

---

produce

▸ produce(produceConfig): void

method Write messages to Kafka.

Parameters

Name	Type	Description
produceConfig	ProduceConfig	Produce configuration.

Returns

void

• Nothing.

Defined in

index.d.ts:331