# cm-libs-kafka

> Common kafka library

Latest version **1.0.24** (published 2023-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install cm-libs-kafka
pnpm add cm-libs-kafka
yarn add cm-libs-kafka
bun add cm-libs-kafka
```

## 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 | 1.0.24 |
| Published | 2023-07-20 |
| First published | 2022-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 36.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jean Soon |
| Maintainers | paidchain |

## Links

- npm: https://www.npmjs.com/package/cm-libs-kafka
- npm.io page: https://npm.io/package/cm-libs-kafka

## Dependencies (3)

- [kafkajs](https://npm.io/package/kafkajs.md) ^2.2.4
- [cm-libs-utils](https://npm.io/package/cm-libs-utils.md) ^1.0.0
- [cm-libs-context-aware-error](https://npm.io/package/cm-libs-context-aware-error.md) ^1.0.16

## Recent versions

- 1.0.24 (latest) — 2023-07-20
- 1.0.23 — 2023-07-13
- 1.0.22 — 2023-07-08
- 1.0.21 — 2023-05-30
- 1.0.20 — 2023-02-26
- 1.0.19 — 2023-02-25
- 1.0.18 — 2023-01-18
- 1.0.17 — 2022-10-14
- 1.0.16 — 2022-10-13
- 1.0.15 — 2022-04-26
- 1.0.14 — 2022-04-21
- 1.0.13 — 2022-04-17
- 1.0.12 — 2022-04-17
- 1.0.11 — 2022-04-17
- 1.0.10 — 2022-04-16
- … 10 more at https://npm.io/package/cm-libs-kafka/versions

## README

# Common Kafka Library

## Getting Started

This repository serve as a library for common Kafka.

## How to setup environment?

1. Clone this repository.

2. Change directory to the repository.

3. Install package dependencies.
   ```
   npm install
   ```

## How to run unit-test?

1. Write test cases in a `*.test.ts` file under the same folder with the actual module file. For example, module file `src/kafka.ts`, unit-test file `src/kafka.test.ts`.

2. Run unit-test command.

   - To run single module unit-test.

     ```
     npm run test-this src/kafka.test.ts
     ```

   - To run all unit-test.
     ```
     npm run test
     ```

## How to debug?

Please use unit-test method for debugging.

1. Set breakpoint on the source code by pressing `F9` key.

2. Run unit-test command with debugging.

   ```
   npm run debug-this src/kafka.test.ts
   ```

3. Start debugging by pressing `F5` key.

## How to release version?

Write commit message that contains keyword

- `run-release` to publish patch version.
- `run-prerelease` to publish prerelease version.

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