# @xeotekofficial/topic-partition-calculator

> Tools to calculate the number of partitions you need for your Kafka topic

Latest version **0.1.1** (published 2023-08-09) · ISC license · 0 weekly downloads

## Install

```sh
npm install @xeotekofficial/topic-partition-calculator
pnpm add @xeotekofficial/topic-partition-calculator
yarn add @xeotekofficial/topic-partition-calculator
bun add @xeotekofficial/topic-partition-calculator
```

## 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.1.1 |
| Published | 2023-08-09 |
| First published | 2023-08-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 25.4 KB |
| Known vulnerabilities | 0 (+17 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Xeotek |
| Maintainers | s.barnhurst.xeotek, xeotek |
| Keywords | Kafka, topic, topics, partitions, calulator, data, streams |

## Links

- npm: https://www.npmjs.com/package/@xeotekofficial/topic-partition-calculator
- Repository: https://github.com/Xeotek/TopicPartitionCalculator
- Homepage: https://github.com/Xeotek/TopicPartitionCalculator#readme
- Issues: https://github.com/Xeotek/TopicPartitionCalculator/issues
- npm.io page: https://npm.io/package/@xeotekofficial/topic-partition-calculator

## Dependencies (10)

- [rxjs](https://npm.io/package/rxjs.md) ~7.8.0
- [tslib](https://npm.io/package/tslib.md) ^2.3.0
- [zone.js](https://npm.io/package/zone.js.md) ~0.13.0
- [@angular/core](https://npm.io/package/@angular/core.md) ^16.1.0
- [@angular/forms](https://npm.io/package/@angular/forms.md) ^16.1.0
- [@angular/common](https://npm.io/package/@angular/common.md) ^16.1.0
- [@angular/compiler](https://npm.io/package/@angular/compiler.md) ^16.1.0
- [@angular/animations](https://npm.io/package/@angular/animations.md) ^16.1.0
- [@angular/platform-browser](https://npm.io/package/@angular/platform-browser.md) ^16.1.0
- [@angular/platform-browser-dynamic](https://npm.io/package/@angular/platform-browser-dynamic.md) ^16.1.0

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2023-08-09
- 0.1.0 — 2023-08-06

## README

# TopicPartitionCalculator
The Topic Partition Calculator allows you to calculate the number of Apache Kafka Topics for a given use case.

## Installation 

Using npm:
```shell
$ npm i --save @xeotekofficial/topic-partition-calculator
```

## Usage
In project:
```js
import { 
  calculateRecommendedNumberOfPartitions, 
  TPCNumberOfPartitionsInputs 
} from '@xeotekofficial/topic-partition-calculator';

function someFn({ T, P, C, B }: TPCNumberOfPartitionsInputs) {
  const results = calculateRecommendedNumberOfPartitions({ T, P, C, B });
  return `Recommended number of partitions: ${results}`;
}
```

## Demo

To view the demo app run: 
```shell
$ git clone https://github.com/Xeotek/TopicPartitionCalculator.git
$ cd TopicPartitionCalculator
$ npm install
$ npm run demo
```
Then open `http://localhost:4200/` inside your browser.

See the [package source](https://github.com/Xeotek/TopicPartitionCalculator) for more details.

---
_Source: https://npm.io/package/@xeotekofficial/topic-partition-calculator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._