Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #5622 from influxdata/5619-npm-init-y-influx-node-app-not-found 

fix(influxdb): npm -y <package-name> expects an existing template
pull/5631/head^2
Jason Stirnaman 2024-10-02 11:25:49 -05:00 committed by GitHub
parent c40aec66f6 b3a0077204
commit 45e6699683
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 69 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
content/influxdb/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install.md
View File

@ -33,11 +33,13 @@ prepend:
3. In your terminal, create a directory for your Node.js project and change to it. 3. In your terminal, create a directory for your Node.js project and change to it.
```sh ```sh
mkdir influx-node-app && cd $_ mkdir influx-node-app && cd influx-node-app
``` ```
4. Enter the following command to generate an npm package for your project. 4. Enter the following command to generate an npm package for your project.
The `npm` package manager is included with Node.js.
- `npm`: the package manager included with Node.js
- `-y`: uses defaults for the package and bypasses prompts
```sh ```sh
npm init -y npm init -y
@ -53,15 +55,21 @@ Follow these steps to initialize the TypeScript project:
```sh ```sh
npm i -g typescript && npm i --save-dev @types/node npm i -g typescript && npm i --save-dev @types/node
``` ```
2. Create a TypeScript configuration with default values.
2. Enter the following command to create a TypeScript configuration
(`tsconfig.json`) with default values:
```sh ```sh
tsc --init tsc --init
``` ```
3. Run the TypeScript compiler. To recompile your code automatically as you make changes, pass the `watch` flag to the compiler.
3. Run the TypeScript compiler.
To recompile your code automatically as you make changes, pass the `--watch, -w` flag to the compiler.
<!--pytest.mark.skip-->
```sh ```sh
tsc -w -p tsc --watch
``` ```
## Install dependencies ## Install dependencies

20
content/influxdb/cloud-serverless/reference/client-libraries/v2/javascript/nodejs/install.md
View File

@ -35,11 +35,13 @@ Install the Node.js JavaScript client library to write data to InfluxDB {{% prod
3. In your terminal, create a directory for your Node.js project and change to it. 3. In your terminal, create a directory for your Node.js project and change to it.
```sh ```sh
mkdir influx-node-app && cd $_ mkdir influx-node-app && cd influx-node-app
``` ```
4. Enter the following command to generate an npm package for your project. 4. Enter the following command to generate an npm package for your project.
The `npm` package manager is included with Node.js.
- `npm`: the package manager included with Node.js
- `-y`: uses defaults for the package and bypasses prompts
```sh ```sh
npm init -y npm init -y
@ -55,15 +57,21 @@ Follow these steps to initialize the TypeScript project:
```sh ```sh
npm i -g typescript && npm i --save-dev @types/node npm i -g typescript && npm i --save-dev @types/node
``` ```
2. Create a TypeScript configuration with default values.
2. Enter the following command to create a TypeScript configuration
(`tsconfig.json`) with default values:
```sh ```sh
tsc --init tsc --init
``` ```
3. Run the TypeScript compiler. To recompile your code automatically as you make changes, pass the `watch` flag to the compiler.
3. Run the TypeScript compiler.
To recompile your code automatically as you make changes, pass the `--watch, -w` flag to the compiler.
<!--pytest.mark.skip-->
```sh ```sh
tsc -w -p tsc --watch
``` ```
## Install dependencies ## Install dependencies
@ -84,7 +92,7 @@ It only works with InfluxDB v2 management APIs.
The client examples include an [`env`](https://github.com/influxdata/influxdb-client-js/blob/master/examples/env.js) module for accessing your InfluxDB properties from environment variables or from `env.js`. The client examples include an [`env`](https://github.com/influxdata/influxdb-client-js/blob/master/examples/env.js) module for accessing your InfluxDB properties from environment variables or from `env.js`.
The examples use these properties to interact with the InfluxDB API. The examples use these properties to interact with the InfluxDB API.
Set environment variables or update `env.js` with your InfluxDB [bucket](/influxdb/cloud-serverless/organizations/buckets/), [organization](/influxdb/cloud-serverless/organizations/), [token](/influxdb/cloud-serverless/security/tokens/), and [url](/influxdb/cloud-serverless/reference/urls/). Set environment variables or update `env.js` with your InfluxDB [bucket](/influxdb/cloud-serverless/organizations/buckets/), [organization](/influxdb/cloud-serverless/organizations/), [token](/influxdb/cloud-serverless/security/tokens/), and [URL](/influxdb/cloud-serverless/reference/urls/).
```sh ```sh
export INFLUX_URL=https://{{< influxdb/host >}} export INFLUX_URL=https://{{< influxdb/host >}}

18
content/influxdb/clustered/reference/client-libraries/v2/javascript/nodejs/install.md
View File

@ -33,11 +33,13 @@ prepend:
3. In your terminal, create a directory for your Node.js project and change to it. 3. In your terminal, create a directory for your Node.js project and change to it.
```sh ```sh
mkdir influx-node-app && cd $_ mkdir influx-node-app && cd influx-node-app
``` ```
4. Enter the following command to generate an npm package for your project. 4. Enter the following command to generate an npm package for your project.
The `npm` package manager is included with Node.js.
- `npm`: the package manager included with Node.js
- `-y`: uses defaults for the package and bypasses prompts
```sh ```sh
npm init -y npm init -y
@ -53,15 +55,21 @@ Follow these steps to initialize the TypeScript project:
```sh ```sh
npm i -g typescript && npm i --save-dev @types/node npm i -g typescript && npm i --save-dev @types/node
``` ```
2. Create a TypeScript configuration with default values.
2. Enter the following command to create a TypeScript configuration
(`tsconfig.json`) with default values:
```sh ```sh
tsc --init tsc --init
``` ```
3. Run the TypeScript compiler. To recompile your code automatically as you make changes, pass the `watch` flag to the compiler.
3. Run the TypeScript compiler.
To recompile your code automatically as you make changes, pass the `--watch, -w` flag to the compiler.
<!--pytest.mark.skip-->
```sh ```sh
tsc -w -p tsc --watch
``` ```
## Install dependencies ## Install dependencies

40
content/influxdb/v2/api-guide/client-libraries/nodejs/install.md
View File

@ -21,31 +21,47 @@ aliases:
2. Ensure that InfluxDB is running and you can connect to it. 2. 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](/influxdb/v2/reference/urls/). For information about what URL to use to connect to InfluxDB OSS or InfluxDB Cloud, see [InfluxDB URLs](/influxdb/v2/reference/urls/).
3. Start a new Node.js project. 3. Create a directory for your new Node.js project, and then change to the
The `npm` package manager is included with Node.js. directory--for example, enter the following command into your terminal:
```sh ```sh
npm init -y influx-node-app mkdir influx-node-app && cd influx-node-app
``` ```
4. Enter 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
```sh
npm init -y
```
## Install TypeScript ## Install TypeScript
Many of the client library examples use [TypeScript](https://www.typescriptlang.org/). Follow these steps to initialize the TypeScript project. Many of the client library examples use [TypeScript](https://www.typescriptlang.org/).
Follow these steps to initialize the TypeScript project:
1. Install TypeScript and type definitions for Node.js. 1. Install TypeScript and type definitions for Node.js.
```sh ```sh
npm i -g typescript && npm i --save-dev @types/node npm i -g typescript && npm i --save-dev @types/node
``` ```
2. Create a TypeScript configuration with default values.
2. Enter the following command to create a TypeScript configuration
(`tsconfig.json`) with default values:
```sh ```sh
tsc --init tsc --init
``` ```
3. Run the TypeScript compiler. To recompile your code automatically as you make changes, pass the `watch` flag to the compiler.
3. Run the TypeScript compiler.
To recompile your code automatically as you make changes, pass the `--watch, -w` flag to the compiler.
<!--pytest.mark.skip-->
```sh ```sh
tsc -w -p tsc --watch
``` ```
## Install dependencies ## Install dependencies
@ -76,7 +92,7 @@ The client examples include an [`env`](https://github.com/influxdata/influxdb-cl
The examples use these properties to interact with the InfluxDB API. The examples use these properties to interact with the InfluxDB API.
{{% /note %}} {{% /note %}}
1. Set environment variables or update `env.mjs` with your InfluxDB [bucket](/influxdb/v2/admin/buckets/), [organization](/influxdb/v2/admin/organizations/), [token](/influxdb/v2/admin/tokens/), and [url](/influxdb/v2/reference/urls/). 1. Set environment variables or update `env.mjs` with your InfluxDB [bucket](/influxdb/v2/admin/buckets/), [organization](/influxdb/v2/admin/organizations/), [token](/influxdb/v2/admin/tokens/), and [URL](/influxdb/v2/reference/urls/).
```sh ```sh
export INFLUX_URL=http://localhost:8086 export INFLUX_URL=http://localhost:8086
@ -89,7 +105,9 @@ The examples use these properties to interact with the InfluxDB API.
- *`YOUR_ORG`*: InfluxDB organization ID - *`YOUR_ORG`*: InfluxDB organization ID
- *`YOUR_BUCKET`*: InfluxDB bucket name - *`YOUR_BUCKET`*: InfluxDB bucket name
2. Run an example script. 2. Run one of the [`influxdb-client-js` example scripts](https://github.com/influxdata/influxdb-client-js/tree/master/examples/).
<!--pytest.mark.skip-->
```sh ```sh
query.ts query.ts