# @3g/kafka-wrapper

> A lightweight Kafka wrapper that creates listeners and publisher.

Latest version **2.0.4** (published 2019-06-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @3g/kafka-wrapper
pnpm add @3g/kafka-wrapper
yarn add @3g/kafka-wrapper
bun add @3g/kafka-wrapper
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.4 |
| Published | 2019-06-24 |
| First published | 2018-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 17.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sean Drumm |
| Maintainers | 02harlxj, nicoll1, sjdweb |

## Links

- npm: https://www.npmjs.com/package/@3g/kafka-wrapper
- npm.io page: https://npm.io/package/@3g/kafka-wrapper

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [@types/debug](https://npm.io/package/@types/debug.md) 4.1.4
- [node-rdkafka](https://npm.io/package/node-rdkafka.md) ^2.7.0

## Recent versions

- 2.0.4 (latest) — 2019-06-24
- 2.0.3 — 2019-05-06
- 2.0.2 — 2018-11-05
- 2.0.1 — 2018-10-01
- 2.0.0 — 2018-09-03
- 1.0.1 — 2018-02-02
- 1.0.0 — 2018-02-01

## README

# Kafka Wrapper

A lightweight Kafka wrapper that creates listeners and publisher.

Currently uses `node-rdkafka` behind the scenes.

# Usage

### Listener
```ts
const listener = kafkaListener({
  host: '127.0.0.1:29092',
  groupId: 'testing.123',
  topics: ['test-wrapper'],
}, (message: IMessage) => {
  console.log('here be msgs', message);
  console.log('message value', message.value.toString());
}, (err: Error) => {
  console.error('Err', err);
});
```

### Publisher
```ts
const publisher = kafkaPublisher({
  host: '127.0.0.1:29092',
  clientId: 'testing-wrapper-publisher',
}, (err: Err) => {
  console.error('Err', err);
});

publisher.send({
  topic: 'test-wrapper',
  message: {
    stuff: 123,
  },
}).then(() => {
  console.log('Message sent successfully', i);
}).catch(err => {
  console.error('Err sending message', err);
});

```

# Notes

### Consumer Groups
- [rebalancing](https://stackoverflow.com/questions/28574054/kafka-consumer-rebalancing-algorithm)
- [consumer assignments](https://www.signal.co/dev-log/kafka-consumer-assignments/)

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