# kafka-wrapper-library

> A Kafka wrapper library for Kafka Consumers and Producers, made in Typescript.

Latest version **0.1.4** (published 2018-03-23) · 0 weekly downloads

## Install

```sh
npm install kafka-wrapper-library
pnpm add kafka-wrapper-library
yarn add kafka-wrapper-library
bun add kafka-wrapper-library
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2018-03-23 |
| First published | 2018-03-23 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 30.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Maintainers | ricardo-pinho |

## Links

- npm: https://www.npmjs.com/package/kafka-wrapper-library
- npm.io page: https://npm.io/package/kafka-wrapper-library

## Dependencies (2)

- [optimist](https://npm.io/package/optimist.md) ^0.6.1
- [kafka-node](https://npm.io/package/kafka-node.md) ^2.4.1

## Recent versions

- 0.1.4 (latest) — 2018-03-23
- 0.1.3 — 2018-03-23
- 0.1.2 — 2018-03-23
- 0.1.1 — 2018-03-23
- 0.1.0 — 2018-03-23

## README

# kafka-wrapper-library
A Kafka wrapper library for Kafka Consumers and Producers, made in Typescript.


## Producer

### Sending message
```let producer = new KafkaProducer("localhost:22181");
	producer.sendMessages("another_new_topx", 0, "new_msg", new kafka.KeyedMessage('keyed', 'a keyed message'))
	.then(value => {
	console.log(value);
    });
```


### Creating a topic
```let producer_create_topic = new KafkaProducer("localhost:22181");
producer_create_topic.createTopic("another_new_topx", true, null)
	.then(value => {
		console.log(value);
	});
```

## Consumer

### Consuming a topic
```let consumer = new KafkaConsumer("localhost:22181", "another_new_topx3", 0, 0)
	.Consume(null, null);
```

## High Level Producer

### Sending a message
```let high_producer = new KafkaHighLevelProducer("localhost:22181");
high_producer.sendMessages("another_new_topx", new kafka.KeyedMessage('keyed', 'a keyed message'))
```

### Creating a topic
```let high_producer_create_topic = new KafkaHighLevelProducer("localhost:22181");
high_producer_create_topic.sendMessages("random_topic")
```


## KafkaConsumerGroup


```let consumerGroup = new KafkaConsumerGroup("localhost:22181", "some_consumer_name");
let new_comsumer_1 = consumerGroup.consumerInitiate('consumer1', 'another_new_topx');
new_comsumer_1.on('error', consumerGroup.onError);
new_comsumer_1.on('message', function () {
		new_comsumer_1.close(true, function (error) {
			console.log('consumer1 closed', error);
		});
});
```

```let new_comsumer_2 = consumerGroup.consumerInitiate('consumer2', 'another_new_topx');
new_comsumer_2.on('error', consumerGroup.onError);
new_comsumer_2.on('message', consumerGroup.onMessage);
new_comsumer_2.on('connect', function () {
	setTimeout(function () {
		new_comsumer_2.close(true, function (error) {
			console.log('consumer2 closed', error);
		});
	}, 25000);
});

let new_comsumer_3 = consumerGroup.consumerInitiate('consumer3', 'another_new_topx');
new_comsumer_3.on('error', consumerGroup.onError);
new_comsumer_3.on('message', consumerGroup.onMessage);
```

## ProducerStream
Not functional yet!
```let producer_stream = new KafkaProducerStream("localhost:22181");
producer_stream.sendMessages("another_new_topx", new kafka.KeyedMessage('keyed', 'a keyed message'))
```

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