awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify getSecret and caching behavior in docs

Browse Source
This commit is contained in:
Tuan Dang
2023-04-26 12:11:46 +03:00
parent dbfa4f5277
commit 492bf39243
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/sdks/languages/node.mdx
View File

@@ -98,7 +98,11 @@ Import the SDK and create a client instance with your Infisical token.
</Expandable>
</ResponseField>
## Usage
## 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 5 minutes after the first fetch; if the fetch fails, the cached secret is returned.
## Working with Secrets
### infisical.getSecret(secretName, options)
@@ -109,7 +113,7 @@ const value = secret.secretValue; // get its value
Retrieve a secret from Infisical.
By default, `getSecret()` returns a personal secret. If not found, it returns a shared secret, or tries to retrieve the value from `process.env`.
By default, `getSecret()` fetches and returns a personal secret. If not found, it returns a shared secret, or tries to retrieve the value from `process.env`. If a secret is fetched, `getSecret()` caches it to reduce excessive calls and re-fetches periodically based on the `cacheTTL` option (default is `300` seconds) when initializing the client — for more information, see the caching section.
<ResponseField name="secretName" type="string" required>