From 1da350e5a0b5fa147ab7cdce647c83ee2e630a06 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Fri, 23 Oct 2026 10:10:38 +0000 Subject: [PATCH] SK-3225: Fix FlowVault Node README retry/timeout defaults and host; link FlowVault from root README --- README.md | 2 ++ flowvault/README.md | 7 ++++--- flowvault/samples/vault-api/insert-records.ts | 2 +- .../samples/vault-api/timeout-and-retry-config-example.ts | 4 ++-- 4 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5f765097..1cd33b79 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ Securely handle sensitive data at rest, in-transit, and in-use with the Skyflow SDK for Node.js, Deno, Bun, and Cloudflare Workers. +> **Using a Flow DB vault?** This README covers the `skyflow-node` package. For FlowVault, install `skyflow-flowvault-node` instead and follow the [FlowVault Node SDK README](flowvault/README.md). Install only one of the two packages. + [![CI](https://img.shields.io/static/v1?label=CI&message=passing&color=green?style=plastic&logo=github)](https://github.com/skyflowapi/skyflow-node/actions) [![GitHub release](https://badge.fury.io/js/skyflow-node.svg)](https://www.npmjs.com/package/skyflow-node) [![License](https://img.shields.io/github/license/skyflowapi/skyflow-node)](https://github.com/skyflowapi/skyflow-node/blob/main/LICENSE) diff --git a/flowvault/README.md b/flowvault/README.md index 323a9adf..64e883fb 100644 --- a/flowvault/README.md +++ b/flowvault/README.md @@ -17,6 +17,7 @@ detokenize, tokenize, and attach files to records in a Flow DB vault. - [Initialize the client](#initialize-the-client) - [Vault operations](#vault-operations) - [Custom request headers](#custom-request-headers) +- [Timeouts and retries](#timeouts-and-retries) - [Error handling](#error-handling) - [Samples](#samples) - [License](#license) @@ -45,7 +46,7 @@ import { Skyflow, InsertRequest, Env, LogLevel, SkyflowError } from 'skyflow-flo const skyflowClient = new Skyflow({ vaultConfigs: [{ vaultId: 'your-vault-id', - clusterId: 'your-cluster-id', // from the vault URL: https://{clusterId}.vault.skyflowapis.com + clusterId: 'your-cluster-id', // from the vault URL: https://{clusterId}.skyvault.skyflowapis.com env: Env.PROD, // DEV, STAGE, SANDBOX, or PROD credentials: { token: 'your-bearer-token' }, }], @@ -294,8 +295,8 @@ const skyflowClient = new Skyflow({ vaultId: 'vault-id', clusterId: 'cluster-id', credentials: { token: 'bearer-token' }, - timeout: 30, // overall per-call timeout in seconds (incl. retries). Default 60. - maxRetries: 2, // retry attempts after the first failure (408/429/5xx). Default off. + timeout: 30, // timeout in seconds for each attempt, applied again to each retry. Default 60. + maxRetries: 2, // retry attempts after the first failure (408/429/5xx). Default 2; 0 turns retries off. vaultUrl: 'https://cluster-id.skyvault.skyflowapis.com', // optional — override the derived URL }], }); diff --git a/flowvault/samples/vault-api/insert-records.ts b/flowvault/samples/vault-api/insert-records.ts index b3e2c4b2..2d594853 100644 --- a/flowvault/samples/vault-api/insert-records.ts +++ b/flowvault/samples/vault-api/insert-records.ts @@ -19,7 +19,7 @@ async function performSecureDataInsertion(): Promise { vaultConfigs: [ { vaultId: '', - clusterId: '', // from the vault URL: https://{clusterId}.vault.skyflowapis.com + clusterId: '', // from the vault URL: https://{clusterId}.skyvault.skyflowapis.com env: Env.PROD, // DEV, STAGE, SANDBOX, or PROD credentials, }, diff --git a/flowvault/samples/vault-api/timeout-and-retry-config-example.ts b/flowvault/samples/vault-api/timeout-and-retry-config-example.ts index 1fd6a8e0..dec17f94 100644 --- a/flowvault/samples/vault-api/timeout-and-retry-config-example.ts +++ b/flowvault/samples/vault-api/timeout-and-retry-config-example.ts @@ -11,8 +11,8 @@ import { * * The flowvault SDK honors these VaultConfig fields (applied to the generated * client's request layer at client construction): - * timeout overall per-call timeout in seconds, incl. retries + backoff. Default 60. - * maxRetries retry attempts after the first failure (408/429/5xx). Default off. + * timeout timeout in seconds for each attempt, applied again to each retry. Default 60. + * maxRetries retry attempts after the first failure (408/429/5xx). Default 2; 0 turns retries off. * vaultUrl override the vault URL derived from clusterId/env. * * NOTE: the finer-grained connect/read/write timeouts and retry-delay knobs from