# kafka-message-bus

> The Kafka Message Bus is an open-source wrapper for KafkaJS, adding support for deadletter topics and their handling to enhance message processing reliability.

Latest version **0.0.1** (published 2023-12-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install kafka-message-bus
pnpm add kafka-message-bus
yarn add kafka-message-bus
bun add kafka-message-bus
```

## Health

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

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-12-08 |
| First published | 2023-12-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 98 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Tomer Levy |
| Maintainers | tomer-levy555 |

## Links

- npm: https://www.npmjs.com/package/kafka-message-bus
- npm.io page: https://npm.io/package/kafka-message-bus

## Dependencies (4)

- [jest](https://npm.io/package/jest.md) ^29.6.4
- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [kafkajs](https://npm.io/package/kafkajs.md) ^2.2.4
- [ts-jest](https://npm.io/package/ts-jest.md) ^29.1.1

## Recent versions

- 0.0.1 (latest) — 2023-12-08

## README

# Kafka Message Bus 🚌✨
[![Test Coveralls](https://github.com/tomer555/kafka-message-bus/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/tomer555/kafka-message-bus/actions/workflows/test.yml)
[![Coverage Status](https://coveralls.io/repos/github/tomer555/kafka-message-bus/badge.svg?branch=master)](https://coveralls.io/github/tomer555/kafka-message-bus?branch=master)
## Introduction
Kafka Message Bus is a wrapper for KafkaJS, enhancing its functionality with deadletter topic support and handlers. It efficiently manages failed message processing in Kafka topics by redirecting them to deadletter topics for resolution, improving reliability in Kafka-based systems.

## Getting Started
1. **Clone the repository**: 
   ```
   git clone https://github.com/tomer555/kafka-message-bus.git
   ```
2. **Install dependencies**: 
   ```
   npm install
   ```

## Running Tests 🧪
Execute tests using:
```
npm run test
```

## Kafka Provider Usage 📡
Configure, initialize, and use the Kafka provider in your application.

## In-Memory Provider Usage 🧠
Set up and use the In-Memory provider for testing or lightweight handling.

## Contributing
We welcome contributions! Here's how you can contribute:
1. **Fork the Repository**: Create your own fork of the project.
2. **Create a Feature Branch**: Work on new features or bug fixes in your own branch.
3. **Commit Your Changes**: Make sure your changes are well-documented and tested.
4. **Submit a Pull Request**: Submit your changes for review.

For a detailed guide on contributing to projects on GitHub, please refer to the [GitHub contribution guide](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).

## License
MIT License. See [LICENSE](LICENSE).

---

For more details and advanced usage, visit the [GitHub repository](https://github.com/tomer555/kafka-message-bus).

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