Skip to content

docs: add Bun.S3Client apis. #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lynhan318 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Bun.S3Client apis. #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Default to using Bun instead of Node.js.
- `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

@coderabbitai coderabbitai bot Mar 6, 2026

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.

- `WebSocket` is built-in. Don't use `ws`.
- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
- Bun.$`ls` instead of execa.
Expand Down