Install the InfluxDB JavaScript client library
Install Node.js
Install Node.js.
Ensure that InfluxDB is running and you can connect to it. For information about what URL to use to connect to InfluxDB OSS or InfluxDB Cloud, see InfluxDB URLs.
Create a directory for your new Node.js project, and then change to the directory–for example, enter the following command into your terminal:
mkdir influx-node-app && cd influx-node-appEnter the following command to generate an npm package for your project.
npm: the package manager included with Node.js-y: uses defaults for the package and bypasses prompts
npm init -y
Install TypeScript
Many of the client library examples use TypeScript. Follow these steps to initialize the TypeScript project:
Install TypeScript and type definitions for Node.js.
npm i -g typescript && npm i --save-dev @types/nodeEnter the following command to create a TypeScript configuration (
tsconfig.json) with default values:tsc --initRun the TypeScript compiler. To recompile your code automatically as you make changes, pass the
--watch, -wflag to the compiler.tsc --watch
Install dependencies
The JavaScript client library contains two packages: @influxdata/influxdb-client and @influxdata/influxdb-client-apis.
Add both as dependencies of your project.
Open a new terminal window and install
@influxdata/influxdb-clientfor querying and writing data:npm install --save @influxdata/influxdb-clientInstall
@influxdata/influxdb-client-apisfor access to the InfluxDB management APIs:npm install --save @influxdata/influxdb-client-apis
Next steps
Once you’ve installed the JavaScript client library, you’re ready to write data to InfluxDB or get started with other examples from the client library.
Get started with examples
The client examples include an env module for accessing your InfluxDB properties from environment variables or from env.mjs.
The examples use these properties to interact with the InfluxDB API.
Set environment variables or update
env.mjswith your InfluxDB bucket, organization, token, and URL.export INFLUX_URL=http://localhost:8086 export INFLUX_TOKEN=YOUR_API_TOKEN export INFLUX_ORG=YOUR_ORG export INFLUX_BUCKET=YOUR_BUCKETReplace the following:
YOUR_API_TOKEN: InfluxDB API tokenYOUR_ORG: InfluxDB organization IDYOUR_BUCKET: InfluxDB bucket name
Run one of the
influxdb-client-jsexample scripts.query.ts
For more examples and information, see the JavaScript client on GitHub.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.