# @saniot/kafka-header-helper

> A package which help in making consistent kafka header.

Latest version **1.0.3** (published 2021-06-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install @saniot/kafka-header-helper
pnpm add @saniot/kafka-header-helper
yarn add @saniot/kafka-header-helper
bun add @saniot/kafka-header-helper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-06-01 |
| First published | 2021-05-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Prateek SanIoT |
| Maintainers | saniot |
| Keywords | kafka, payloads, header, node.js |

## Links

- npm: https://www.npmjs.com/package/@saniot/kafka-header-helper
- npm.io page: https://npm.io/package/@saniot/kafka-header-helper

## Recent versions

- 1.0.3 (latest) — 2021-06-01
- 1.0.2 — 2021-05-28
- 1.0.1 — 2021-05-28
- 1.0.0 — 2021-05-28

## README

# 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'),
        });
```

#

---
_Source: https://npm.io/package/@saniot/kafka-header-helper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._