@saniot/kafka-header-helper/README.md

A package which help in making consistent kafka header.

# Kafka Header

---

## Introduction:

It create a header structure for kafka payload.

#

### How to use:

#### 1. kafkaHeader

#

```node.js
const { kafkaHeader } = require("kafka_header");
```

Change in code

```node.js
# Payload before header
let payload = [
        {
            key: kafkaKey,
            value: kafkaValue
        },
    ];

# Payload after adding header
let payload = [
        {
            key: kafkaKey,
            value: kafkaValue,
            header: { ...kafkaHeader("service_name") },
        },
    ];
```

#

#### 2. addHeader

#

```node.js
const { addHeader } = require("kafka_header");
```

Change in code

```node.js
# Before
await kafkaProducer.send({
            topic: kafkaTopic,
            messages: payload,
        });

# After
await kafkaProducer.send({
            topic: kafkaTopic,
            messages: addHeader(payload, 'service_name'),
        });
```

#