From b591d638d0e61d1f8dc9ba9434cc47972e0a45e9 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Thu, 16 Mar 2023 00:28:29 +0700 Subject: [PATCH] Update Node SDK docs --- docs/sdks/overview/node.mdx | 87 +++++++++++++++++++++++++++---------- 1 file changed, 65 insertions(+), 22 deletions(-) diff --git a/docs/sdks/overview/node.mdx b/docs/sdks/overview/node.mdx index 37928933f..58002392f 100644 --- a/docs/sdks/overview/node.mdx +++ b/docs/sdks/overview/node.mdx @@ -6,7 +6,7 @@ If you're working with Node.js, the official [infisical-node](https://github.com ## Installation -Run `npm` to add `infisical` to your project. +Run `npm` to add `infisical-node` to your project. ```bash npm install infisical-node --save @@ -14,10 +14,63 @@ npm install infisical-node --save ## Initialization -Set up `infisical` asynchronously as early as possible in your application by importing and initializing the global instance with `infisical.connect([options])`. +Set up the Infisical client asynchronously as early as possible in your application by importing and initializing the global instance with `infisical.connect(options)`. This methods fetches back all the secrets in the project and environment accessible by the token passed in `options`. +### infisical.connect(options) + +Updates the global instance of the Infisical client with a connection to an Infisical project and fetches back secrets if supplied with an [Infisical Token](/getting-started/dashboard/token). + + + + + An [Infisical Token](/getting-started/dashboard/token) scoped to a project + and environment + + + Your self-hosted absolute site URL including the protocol (e.g. + `https://app.infisical.com`) + + + Whether or not debug mode is on + + + Whether or not to attach fetched secrets to `process.env` + + + + +### infisical.createConnection(options) + +Returns a local instance of the Infisical client with a connection to an Infisical project and fetches back secrets if supplied with an [Infisical Token](/getting-started/dashboard/token). + +This method is useful if you wish to connect to two or more Infisical projects within your app. + + + + + An [Infisical Token](/getting-started/dashboard/token) scoped to a project + and environment + + + Your self-hosted absolute site URL including the protocol (e.g. + `https://app.infisical.com`) + + + Whether or not debug mode is on + + + + ```js @@ -53,33 +106,23 @@ This methods fetches back all the secrets in the project and environment accessi -`infisical.connect([options])` - -| Option | Description | Default Value | -| --------- | -------------------------------------------------------------------------------------------- | --------------------------- | -| `token` | An [Infisical Token](/getting-started/dashboard/token) scoped to a project and environment | `None` | -| `siteURL` | Your self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`) | `https://app.infisical.com` | -| `debug` | Whether or not debug mode is on | `false` | - - - If you need to connect to multiple Infisical projects, you can use - `infisical.createConnection([options])` to return a local instance of - `infisical`. - - ## Usage -To get the value of secret, pass the name of its key into `infisical.get()`. +To get the value of a secret, use `infisical.get(key)`. + +### infisical.get(key) + +Return the value of the secret with the specified `key`. Note that the Infisical client falls back to `process.env` if `token` is `undefined` during the +initialization step or if a value for the secret is not found in the fetched secrets. + + + The key of the secret + ```js const value = infisical.get("SOME_KEY"); ``` - - `infisical` falls back to `process.env` if `token` is `undefined` during - initialization or if a value is not found in the secrets fetched. - - ## Example with Express ```js