iggy node.js client

iggy node.js client for iggy-rs's binary protocol, written in typescript. it currently only support 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 [email protected] is equivalent to @iggy.rs/[email protected]

note: previous works on node.js http client has been moved to [iggy-node-http-client](<https://github.com/iggy-rs/iggy-node-http-client) (moved on 04 July 2024)

install

$ npm i @iggy.rs/sdk

basic usage

import { Client } from "@iggy.rs/sdk";

const credentials = { username: "iggy", password: "iggy" };

const c = new Client({
  transport: "TCP",
  options: { port: 8090, host: "127.0.0.1" },
  credentials,
});

const stats = await c.system.getStats();

use sources

Install

$ npm ci

build

$ npm run build

test

unit tests

$ npm run test

e2e tests

e2e test expect an iggy-server at tcp://127.0.0.1:8090

$ npm run test:e2e

lint

$ npm run lint