Skip to content

docs(azure): fix Azure Table Storage package name and complete options list#791

Open
MFA-G wants to merge 2 commits into
unjs:mainfrom
MFA-G:docs/azure-table-storage-options
Open

docs(azure): fix Azure Table Storage package name and complete options list#791
MFA-G wants to merge 2 commits into
unjs:mainfrom
MFA-G:docs/azure-table-storage-options

Conversation

@MFA-G

@MFA-G MFA-G commented Jun 26, 2026

Copy link
Copy Markdown

Fixes #681

The Azure Table Storage driver docs had a few inaccuracies, all verified against src/drivers/azure-storage-table.ts:

Wrong package name

The install instructions referenced @azure/data-table, but the published package — and the driver's own import (from "@azure/data-tables") — use the plural @azure/data-tables. Following the old instructions installs a non-existent package. Fixed both the prose and the :pm-install block.

Broken link

Removed the dangling [data-tables]() line, which rendered as an empty link.

Incomplete options list

The Options list was truncated mid-entry (a dangling -) and only documented accountName, tableName, partitionKey and accountKey. Added the missing options to match AzureStorageTableOptions:

  • sasKey — SAS key for AzureSASCredential
  • connectionString — connection string (Node.js only)
  • pageSize — entries per request, defaults to 1000 (also the max, enforced in the driver)

Auth note fix

The AzureSASCredential authentication bullet referenced a sasToken option that doesn't exist; the actual option is sasKey.

Docs-only change. No code touched.

Summary by CodeRabbit

  • Documentation
    • Clarified Azure Table Storage driver usage and setup guidance.
    • Updated the package install name to the current Azure Tables package.
    • Expanded authentication details, including SAS credential and Node-only connection string support.
    • Improved options guidance with clearer precedence rules and added the new pageSize setting with its default and maximum.

- Correct package name from `@azure/data-table` to `@azure/data-tables`
  in the install instructions (the published package and the driver import
  both use the plural `data-tables`).
- Remove the broken empty `[data-tables]()` link.
- Complete the truncated Options list: document `sasKey`,
  `connectionString` and `pageSize` to match the driver options.
- Fix authentication note that referenced a non-existent `sasToken`
  option (the option is `sasKey`).

Fixes unjs#681
@MFA-G MFA-G requested a review from pi0 as a code owner June 26, 2026 07:50
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 18198843-0575-40cd-892b-716708bcf7f3

📥 Commits

Reviewing files that changed from the base of the PR and between 7391f83 and 4a1059d.

📒 Files selected for processing (1)
  • docs/2.drivers/azure.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/2.drivers/azure.md

📝 Walkthrough

Walkthrough

Updates the Azure Table Storage docs to rework the usage text, correct the install package name, and expand authentication and options documentation for sasKey, connectionString, and pageSize.

Changes

Azure Table Storage documentation

Layer / File(s) Summary
Usage and package name
docs/2.drivers/azure.md
The usage introduction is reworded, the placeholder link is removed, and the install package name changes to @azure/data-tables.
Auth and options details
docs/2.drivers/azure.md
The authentication list now documents sasKey and Node-only connectionString, and the options list adds precedence text plus pageSize with its default and limit.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

A bunny hopped through Azure docs,
Swapped in the right install and polished nooks.
sasKey twinkled, pageSize too,
connectionString joined the crew.
🐰✨ The burrow’s notes now shine anew.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly states the docs fix for Azure Table Storage package name and options list.
Linked Issues check ✅ Passed The changes address the issue by correcting the package name and documenting sasKey, connectionString, and pageSize.
Out of Scope Changes check ✅ Passed The edits are limited to related Azure Table Storage documentation cleanup and option clarifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/2.drivers/azure.md`:
- Around line 255-256: The authentication precedence text for `sasKey` and
`connectionString` is backwards in the Azure driver docs. Update those
descriptions in the Azure markdown so they match the fallback chain implemented
in `AzureStorageTable` initialization logic from
`src/drivers/azure-storage-table.ts` (where `accountKey`, then `sasKey`, then
`connectionString` are chosen via `else if`). Make `sasKey` say it is only used
when `accountKey` is not provided, and make `connectionString` say it is only
used when neither `accountKey` nor `sasKey` is provided.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 36fc47cd-da7b-4ee4-a809-1eacde891f9c

📥 Commits

Reviewing files that changed from the base of the PR and between 2727956 and 7391f83.

📒 Files selected for processing (1)
  • docs/2.drivers/azure.md

Comment thread docs/2.drivers/azure.md Outdated
@MFA-G

MFA-G commented Jun 27, 2026

Copy link
Copy Markdown
Author

Good catch. Fixed in 4a1059d — the precedence is accountKeysasKeyconnectionString (via else if fallthrough in the driver), so I updated the descriptions to say accountKey takes precedence over sasKey, and both take precedence over connectionString (matching the wording used in the Blob Storage section).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Azure Table Storage docs are incomplete, and refer to invalid pkg @azure/data-table

1 participant