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.
-
Start a new Node.js project. The
npm
package manager is included with Node.js.mkdir influx-node-app && cd influx-node-app 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/node
-
Create a TypeScript configuration with default values.
tsc --init
-
Run the TypeScript compiler. To recompile your code automatically as you make changes, pass the
watch
flag to the compiler.tsc -w -p
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-client
for querying and writing data:npm install --save @influxdata/influxdb-client
-
Install
@influxdata/influxdb-client-apis
for 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.js
.
The examples use these properties to interact with the InfluxDB API.
-
Set environment variables or update
env.js
with 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_BUCKET
Replace the following:
YOUR_API_TOKEN
: InfluxDB API tokenYOUR_ORG
: InfluxDB organization IDYOUR_BUCKET
: InfluxDB bucket name
-
Run an example script.
query.ts
For more examples and information, see the JavaScript client on GitHub.
The URL in the examples depends on your InfluxDB Cloud region.
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, the following resources are available:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.