From 8df22302fd6df3ce169b3fca3f31b1ababd18989 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard <62331820+DanielHougaard@users.noreply.github.com> Date: Sun, 24 Dec 2023 17:11:03 +0400 Subject: [PATCH] Updated Node docs --- docs/sdks/languages/node.mdx | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/sdks/languages/node.mdx b/docs/sdks/languages/node.mdx index 34cce93ab..d6dfc7564 100644 --- a/docs/sdks/languages/node.mdx +++ b/docs/sdks/languages/node.mdx @@ -104,6 +104,11 @@ Import the SDK and create a client instance with your [Machine Identity](/docume An access token obtained from the machine identity login endpoint. + + Time-to-live (in seconds) for refreshing cached secrets. + If manually set to 0, caching will be disabled, this is not recommended. + + Your self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`) @@ -113,6 +118,11 @@ Import the SDK and create a client instance with your [Machine Identity](/docume + +### Caching + +The SDK caches every secret and updates it periodically based on the provided cacheTTL. For example, if cacheTTL of 300 is provided, then a secret will be refetched every 5 minutes. The SDK first attempts to return the cached secret, but if no secret is found it'll make a request to get the fresh secret. Every time the secret is fetched from the cache, the cached secret expiry is reset. + ## Working with Secrets ### client.listSecrets(options) @@ -143,7 +153,11 @@ Retrieve all secrets within the Infisical project and environment that client is The path from where secrets should be fetched from. - + + Whether or not to set the fetched secrets to the process environment. If true, you can access the secrets like so `process.env["SECRET_NAME"]`. + + + Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)