Skip to content

docs: add Bun.S3Client apis.#52

Open
lynhan318 wants to merge 1 commit intoImBIOS:mainfrom
lynhan318:patch-1
Open

docs: add Bun.S3Client apis.#52
lynhan318 wants to merge 1 commit intoImBIOS:mainfrom
lynhan318:patch-1

Conversation

@lynhan318
Copy link
Copy Markdown

@lynhan318 lynhan318 commented Mar 6, 2026

Add instruction force using build in Bun.S3Client

Closes #

📑 Description

✅ Checks

  • My pull request adheres to the code style of this project
  • If my code requires changes to the documentation I have updated the documentation as required.
  • All the tests have passed

ℹ Additional Information

Summary by CodeRabbit

  • Documentation
    • Updated API recommendations to guide users toward Bun.S3Client for S3 operations.

Add instruction force using build in Bun.S3Client
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 6, 2026

⚠️ No Changeset found

Latest commit: 702c9b7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 6, 2026

📝 Walkthrough

Walkthrough

A single line is added to CLAUDE.md recommending Bun.S3Client for S3 operations while explicitly advising against aws-sdk usage. No existing content is modified.

Changes

Cohort / File(s) Summary
Documentation Update
CLAUDE.md
Added API recommendation for S3 client usage, specifying Bun.S3Client as the preferred choice and explicitly noting to avoid aws-sdk.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A whisker twitches, S3 gleams bright,
Bun's client hops in—the proper sight!
aws-sdk? No, we hop away,
New guidance written, hip-hip-hooray! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding Bun.S3Client API documentation as recommended in the CLAUDE.md file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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 and usage tips.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Mar 6, 2026

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

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 the current code and only fix it if needed.

Inline comments:
In `@CLAUDE.md`:
- Line 22: Update the incorrect reference to Bun's S3 API: replace the
usage/mention of Bun.S3Client with the official import form so examples and docs
show importing S3Client directly (e.g., reference the symbol S3Client and the
import pattern import { S3Client } from "bun" instead of Bun.S3Client) so
readers use the correct API.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0f09afdd-e92e-47aa-ad0f-937dba499c69

📥 Commits

Reviewing files that changed from the base of the PR and between abd35da and 702c9b7.

📒 Files selected for processing (1)
  • CLAUDE.md

- `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
- `Bun.redis` for Redis. Don't use `ioredis`.
- `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
- `Bun.S3Client` for S3. Don't use `aws-sdk`.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check for S3Client references in the codebase

echo "=== Searching for S3Client in TypeScript definitions ==="
fd -e d.ts -x rg -l "S3Client" {} 2>/dev/null || echo "No .d.ts files with S3Client found"

echo ""
echo "=== Searching for S3Client in source files (ts/js/tsx/jsx) ==="
rg "S3Client" --type ts --type js --type tsx --type jsx 2>/dev/null | head -20 || echo "No S3Client references found in source files"

echo ""
echo "=== Checking for any aws-sdk references ==="
rg "aws-sdk" --type ts --type js --type tsx --type jsx 2>/dev/null | head -20 || echo "No aws-sdk references found"

echo ""
echo "=== Listing all files in repo to understand structure ==="
git ls-files | head -30

Repository: ImBIOS/bun-node

Length of output: 1438


🌐 Web query:

Bun S3Client API official documentation

💡 Result:

Official Bun documentation for S3Client (Bun’s built-in S3 API):

https://bun.com/docs/runtime/s3

This page documents import { S3Client } from "bun" and related S3 helpers (e.g., s3, write, client.file(), etc.). [1]


Correct the S3Client API reference to match official Bun syntax.

The API does exist, but the guideline references it incorrectly. Bun's official documentation shows the S3 API is imported as import { S3Client } from "bun", not accessed via Bun.S3Client. Update the line to reflect the correct import pattern so developers follow the proper syntax.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` at line 22, Update the incorrect reference to Bun's S3 API:
replace the usage/mention of Bun.S3Client with the official import form so
examples and docs show importing S3Client directly (e.g., reference the symbol
S3Client and the import pattern import { S3Client } from "bun" instead of
Bun.S3Client) so readers use the correct API.

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.

1 participant