From 6329b576042d6f6ed7d7415683ef09d8e05bbf1f Mon Sep 17 00:00:00 2001 From: Jack Ye Date: Wed, 4 Feb 2026 16:07:58 -0800 Subject: [PATCH] docs: update nodejs docs for storage options APIs (#2978) Regenerate TypeScript docs to include the new initialStorageOptions() and latestStorageOptions() methods added in #2966. Co-authored-by: Claude Opus 4.5 --- .github/workflows/nodejs.yml | 1 + docs/src/js/classes/Table.md | 43 ++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index 1f7cfdef5..6e121cc56 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -8,6 +8,7 @@ on: paths: - Cargo.toml - nodejs/** + - docs/src/js/** - .github/workflows/nodejs.yml - docker-compose.yml diff --git a/docs/src/js/classes/Table.md b/docs/src/js/classes/Table.md index 67a94bf6f..e3b575948 100644 --- a/docs/src/js/classes/Table.md +++ b/docs/src/js/classes/Table.md @@ -367,6 +367,27 @@ Use [Table.listIndices](Table.md#listindices) to find the names of the indices. *** +### initialStorageOptions() + +```ts +abstract initialStorageOptions(): Promise> +``` + +Get the initial storage options that were passed in when opening this table. + +For dynamically refreshed options (e.g., credential vending), use +[Table.latestStorageOptions](Table.md#lateststorageoptions). + +Warning: This is an internal API and the return value is subject to change. + +#### Returns + +`Promise`<`undefined` \| `null` \| `Record`<`string`, `string`>> + +The storage options, or undefined if no storage options were configured. + +*** + ### isOpen() ```ts @@ -381,6 +402,28 @@ Return true if the table has not been closed *** +### latestStorageOptions() + +```ts +abstract latestStorageOptions(): Promise> +``` + +Get the latest storage options, refreshing from provider if configured. + +This method is useful for credential vending scenarios where storage options +may be refreshed dynamically. If no dynamic provider is configured, this +returns the initial static options. + +Warning: This is an internal API and the return value is subject to change. + +#### Returns + +`Promise`<`undefined` \| `null` \| `Record`<`string`, `string`>> + +The storage options, or undefined if no storage options were configured. + +*** + ### listIndices() ```ts