Hi team,
First, thanks for working on the Node.js client for Apache IoTDB. I’m trying to integrate it into a TypeScript application and ran into a packaging/install issue that I wanted to report.
What I tried
The documentation for the GitHub repository points to:
npm install @iotdb/client
However, in my environment this package was not available in the npm registry, so the install failed.
I then checked npm and found that the published package name currently available is:
That package installs successfully with:
npm install iotdb-client-nodejs
But after installing it, I was not able to use it as a working runtime dependency in my project. The module imported successfully, but the runtime exports were effectively empty / unusable for constructing a Session.
What worked as a workaround
I was able to get it working only by:
- installing the GitHub repo directly:
npm install git+https://github.com/apache/iotdb-client-nodejs.git#<commit>
- then building the package locally inside
node_modules/@iotdb/client
- after that,
Session and the rest of the API became available and my smoke tests passed
What I’m hoping for
It would be great to have one of these clarified/fixed:
- a published npm package that matches the documented install command, or
- updated documentation that reflects the installable package and exact usage.
My environment
- Node.js: 24.1.0
- IoTDB: 1.3.3
- TypeScript project
- Tested against local Docker-based IoTDB deployment
If useful, I can share the exact smoke test and the steps I used to reproduce this.
Thanks again!
Hi team,
First, thanks for working on the Node.js client for Apache IoTDB. I’m trying to integrate it into a TypeScript application and ran into a packaging/install issue that I wanted to report.
What I tried
The documentation for the GitHub repository points to:
However, in my environment this package was not available in the npm registry, so the install failed.
I then checked npm and found that the published package name currently available is:
That package installs successfully with:
But after installing it, I was not able to use it as a working runtime dependency in my project. The module imported successfully, but the runtime exports were effectively empty / unusable for constructing a
Session.What worked as a workaround
I was able to get it working only by:
node_modules/@iotdb/clientSessionand the rest of the API became available and my smoke tests passedWhat I’m hoping for
It would be great to have one of these clarified/fixed:
My environment
If useful, I can share the exact smoke test and the steps I used to reproduce this.
Thanks again!