You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iggy.apache.org by pi...@apache.org on 2025/07/27 14:39:31 UTC
(iggy) branch master updated: chore(sdk): update NodeJS SDK package info (#2042)
This is an automated email from the ASF dual-hosted git repository.
piotr pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iggy.git
The following commit(s) were added to refs/heads/master by this push:
new 34939244 chore(sdk): update NodeJS SDK package info (#2042)
34939244 is described below
commit 34939244e1e9315bdbfcb017415bacf0585bb1ce
Author: Piotr Gankiewicz <pi...@gmail.com>
AuthorDate: Sun Jul 27 16:39:26 2025 +0200
chore(sdk): update NodeJS SDK package info (#2042)
Co-authored-by: T1B0 <T1...@users.noreply.github.com>
---
foreign/node/README.md | 10 +++++-----
foreign/node/package-lock.json | 8 ++++----
foreign/node/package.json | 6 +++---
3 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/foreign/node/README.md b/foreign/node/README.md
index f7d08535..700c5f3f 100644
--- a/foreign/node/README.md
+++ b/foreign/node/README.md
@@ -4,30 +4,30 @@ Apache Iggy Node.js client written in typescript, it currently only supports tcp
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](https://github.com/T1B0/iggy-bin) / [npm](https://www.npmjs.com/package/iggy-bin)) 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](https://github.com/apache/iggy/tree/master/foreign/node) and is now published on npmjs as @apache-iggy/node-sdk
+note: This lib started as _iggy-bin_ ( [github](https://github.com/T1B0/iggy-bin) / [npm](https://www.npmjs.com/package/iggy-bin)) 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](https://github.com/apache/iggy/tree/master/foreign/node) 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](<https://github.com/iggy-rs/iggy-node-http-client>) (moved on 04 July 2024)
## install
```bash
-npm i --save @apache-iggy/node-sdk
+npm i --save apache-iggy
```
## basic usage
```ts
-import { Client } from "@apache-iggy/node-sdk";
+import { Client } from "apache-iggy";
const credentials = { username: "iggy", password: "iggy" };
-const c = new Client({
+const client = new Client({
transport: "TCP",
options: { port: 8090, host: "127.0.0.1" },
credentials,
});
-const stats = await c.system.getStats();
+const stats = await client.system.getStats();
```
## use sources
diff --git a/foreign/node/package-lock.json b/foreign/node/package-lock.json
index 328472cb..d5f4df94 100644
--- a/foreign/node/package-lock.json
+++ b/foreign/node/package-lock.json
@@ -1,12 +1,12 @@
{
- "name": "@apache-iggy/node-sdk",
- "version": "0.5.0",
+ "name": "apache-iggy",
+ "version": "0.5.0-edge.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
- "name": "@apache-iggy/node-sdk",
- "version": "0.5.0",
+ "name": "apache-iggy",
+ "version": "0.5.0-edge.1",
"license": "Apache-2.0",
"dependencies": {
"debug": "4.3.7",
diff --git a/foreign/node/package.json b/foreign/node/package.json
index 9293e3d8..039a73d9 100644
--- a/foreign/node/package.json
+++ b/foreign/node/package.json
@@ -1,5 +1,5 @@
{
- "name": "@apache-iggy/node-sdk",
+ "name": "apache-iggy",
"type": "module",
"version": "0.5.0",
"description": "Official Apache Iggy NodeJS SDK",
@@ -19,8 +19,8 @@
},
"publishConfig": {
"access": "public",
- "main": "dist/src/index.js",
- "types": "dist/src/index.d.ts"
+ "main": "dist/index.js",
+ "types": "dist/index.d.ts"
},
"homepage": "https://iggy.apache.org",
"files": [