Official Apache Iggy NodeJS SDK
npm install apache-iggyApache Iggy Node.js client written in typescript, it currently only supports tcp & tls transports.
diclaimer: although all iggy commands & basic client/stream are implemented this is still a WIP, provided as is, and has still a long way to go to be considered "battle tested".
note: This lib started as _iggy-bin_ ( github / npm) before migrating under iggy-rs org. package iggy-bin@v1.3.4 is equivalent to @iggy.rs/sdk@v1.0.3 and migrating again under apache iggy monorepo ( github and is now published on npmjs as apache-iggy
note: previous works on node.js http client has been moved to iggy-node-http-client (moved on 04 July 2024)
``bash`
npm i --save apache-iggy
`ts
import { Client } from "apache-iggy";
const credentials = { username: "iggy", password: "iggy" };
const client = new Client({
transport: "TCP",
options: { port: 8090, host: "127.0.0.1" },
credentials,
});
const stats = await client.system.getStats();
`
`bash`
npm ci
`bash`
npm run build
note: use env var IGGY_TCP_ADDRESS="host:port" to set server address for bdd and e2e tests.
#### unit tests
`bash`
npm run test:unit
#### e2e tests
e2e test expect an iggy-server at tcp://127.0.0.1:8090
`bash`
npm run test:e2e
#### bdd tests
bdd test expect an iggy-server at tcp://127.0.0.1:8090
`bash`
npm run test:bdd
#### run all test
npm run test runs unit, bdd and e2e tests suite (expect an iggy-server at tcp://127.0.0.1:8090)
`bash``
npm run lint