# @dataprism/ldk

> Dataprism Logic Development Kit

Latest version **1.0.0** (published 2017-12-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @dataprism/ldk
pnpm add @dataprism/ldk
yarn add @dataprism/ldk
bun add @dataprism/ldk
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-12-07 |
| First published | 2017-12-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Daan Gerits |
| Maintainers | calmera |
| Keywords | dataprism |

## Links

- npm: https://www.npmjs.com/package/@dataprism/ldk
- Repository: https://github.com/dataprism/dataprism-ldk-nodejs
- Homepage: https://github.com/dataprism/dataprism-ldk-nodejs#readme
- Issues: https://github.com/dataprism/dataprism-ldk-nodejs/issues
- npm.io page: https://npm.io/package/@dataprism/ldk

## Dependencies (2)

- [log4js](https://npm.io/package/log4js.md) ^2.3.12
- [kafka-streams](https://npm.io/package/kafka-streams.md) ^3.0.0

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-12-07

## README

# Dataprism Logic Development Kit

## Introduction
The dataprism logic development kit is used when developing and running logics inside the dataprism platform.

## Usage
```
const Platform = require('dataprism-ldk-nodejs');
const platform = new Platform();

const stream = platform.getStream("my_kafka_topic");

stream.forEach(message => {
    console.log(message);
});

stream.start();
```

## Configuration
The following configuration parameters can be provided:

- **DP_BROKER_LIST** - The list of kafka nodes, including their ports. For example "localhost:9092"
- **DP_GROUP_ID** - The unique group id. The group id links multiple instances of the same logic together and makes sure the kafka messages are distributed between the members of the group
- **DP_CLIENT_ID** - The unique client id, used to identify this logic. If not set, this will default to the hostname
- **DP_BATCH_NUM_MESSAGES** - The number of messages which need to be batched before sending them to the kafka cluster
- **DP_AUTO_OFFSET_RESET** - The kafka offset reset strategy

All these parameters are provided by the dataprism platform if the application is ran as a logic.

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