# @ducktors/storagebus-s3 中文文档

规范地址：https://npmcn.com/package/%40ducktors/storagebus-s3/

版本：0\.12\.1
npm 元数据更新时间：2026-06-12T11:21:35.475Z
中文译文更新时间：2026-11-12T23:45:24.003Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ducktors/storagebus-s3
原文对照：https://npmcn.com/package/%40ducktors/storagebus-s3/?lang=original
项目主页：https://github.com/ducktors/storagebus#readme
源码仓库：https://github.com/ducktors/storagebus

弃用说明：Package renamed to @storagebus/s3\. Please migrate to @storagebus/s3@^1\.0\.0\.

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：15.4 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2022-11-29T12:35:53.479Z
- 最新版本发布：2025-12-19T16:25:53.902Z
- 近 30 天下载量：4400（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 2 个）

## 中文简介

[![npm version](https://img.shields.io/npm/v/@ducktors/storagebus-s3)](https://www.npmjs.com/package/@ducktors/storagebus-s3) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## 安装

```sh
npm install @ducktors/storagebus-s3
```

也可以使用：`pnpm add @ducktors/storagebus-s3`、`yarn add @ducktors/storagebus-s3`、`bun add @ducktors/storagebus-s3`

## README

# @ducktors/ streagebus-s3 (英语)

[![npm version](https://img.shields.io/npm/v/@ducktors/storagebus-s3)](https://www.npmjs.com/package/@ducktors/storagebus-s3) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

AWS S3 存储适配器 [存储总线](https://github.com/ducktors/storagebus)。 。 。 .

## 安装

```bash
npm install @ducktors/storagebus-s3
# or
pnpm add @ducktors/storagebus-s3
# or
yarn add @ducktors/storagebus-s3
```

## 使用量

```typescript
import { Storage } from '@ducktors/storagebus-s3'
import { Readable } from 'node:stream'

// Using explicit credentials
const storage = new Storage({
  bucket: 'your-s3-bucket',
  region: 'us-east-1',
  accessKeyId: 'your-access-key-id',
  secretAccessKey: 'your-secret-access-key',
})

// Or using default credentials (IAM role, environment variables, etc.)
const storageWithDefaultCreds = new Storage({
  bucket: 'your-s3-bucket',
  region: 'us-east-1',
})

async function main() {
  const readable = Readable.from('Hello, world!')

  // Write a file
  const writtenFile = await storage.write('path/to/file.txt', readable)

  // Write with progress tracking
  await storage.write('path/to/large-file.txt', readable, {
    progress: (p) => console.log(`Uploaded: ${p.loaded} bytes`),
  })

  // Write with server-side encryption
  await storage.write('path/to/encrypted.txt', readable, {
    entryption: {
      ServerSideEncryption: 'aws:kms',
      SSEKMSKeyId: 'your-kms-key-id',
    },
  })

  // Check if file exists
  const exists = await storage.exists('path/to/file.txt')

  // Read a file
  const fileStream = await storage.read('path/to/file.txt')

  // Copy a file
  const copiedFile = await storage.copy('path/to/file.txt', 'path/to/copy.txt')

  // Copy to a different bucket
  await storage.copy('path/to/file.txt', 'path/to/copy.txt', {
    destBucket: 'another-bucket',
  })

  // Move a file
  const movedFile = await storage.move('path/to/copy.txt', 'new/path/file.txt')

  // Delete a file
  await storage.remove('path/to/file.txt')
}
```

## API 密码

### 构造选项

| 选项 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `bucket` | `string` | 对 | S3 桶名称 |
| `region` | `string` | 没有 | AWS区域(例如, `us-east-1`(中文(简体) ) |
| `accessKeyId` | `string` | 没有 | AWS 访问密钥ID( 如果使用 IAM 角色或环境变量可选择) |
| `secretAccessKey` | `string` | 没有 | AWS 秘密访问密钥( 如果使用 IAM 角色或环境变量可选择) |
| `debug` | `boolean` | 没有 | 启用调试日志 |
| `logger` | `Logger` | 没有 | 自定义日志实例 |
| `sanitizeKey` | `boolean | (key: string) => string` | 没有 | 将文件密钥设置为安全 |

### 方法

| 方法 | 签署 | 说明 |
| --- | --- | --- |
| `write` | `(key: string, fileReadable: Readable, opts?: WriteOpts) => Promise<string>` | 写一个文件到存储 。 根据文件扩展名自动设置内容类型 |
| `exists` | `(key: string) => Promise<boolean>` | 检查文件是否存在 |
| `read` | `(key: string) => Promise<Readable>` | 从存储中读取文件 |
| `remove` | `(key: string) => Promise<void>` | 从存储中删除文件 |
| `copy` | `(key: string, destKey: string, opts?: CopyOpts) => Promise<string>` | 在桶内或桶间复制文件 |
| `move` | `(key: string, destKey: string, opts?: MoveOpts) => Promise<string>` | 在桶内移动文件 |

### 写入 Opts

| 选项 | 类型 | 说明 |
| --- | --- | --- |
| `progress` | `(p: Progress) => void` | 上传进度的召回功能 |
| `entryption.ServerSideEncryption` | `string` | 服务器侧加密算法( E)`AES256`, (中文(简体) ), `aws:kms`, (中文(简体) ), `aws:kms:dsse`(中文(简体) ) |
| `entryption.SSEKMSKeyId` | `string` | 加密的 KMS 密钥ID |

### 复制对象

| 选项 | 类型 | 说明 |
| --- | --- | --- |
| `destBucket` | `string` | 目标桶( 默认为源桶) |
| `entryption.ServerSideEncryption` | `string` | 服务器侧加密算法 |
| `entryption.SSEKMSKeyId` | `string` | 加密的 KMS 密钥ID |

### 移动 Opts

| 选项 | 类型 | 说明 |
| --- | --- | --- |
| `entryption.ServerSideEncryption` | `string` | 服务器侧加密算法 |
| `entryption.SSEKMSKeyId` | `string` | 加密的 KMS 密钥ID |

## 认证

这个适配器支持多种认证方法:

1.  **全权证书**: 传出 `accessKeyId` 财务报告和审定财务报表 `secretAccessKey` 到构造器
2.  **环境变量**设置 `AWS_ACCESS_KEY_ID` 财务报告和审定财务报表 `AWS_SECRET_ACCESS_KEY`
3.  **IAM 角色**:在AWS基础设施上运行时(EC2,Lambda,ECS等)
4.  **AWS 证书文件**数字 : `~/.aws/credentials`

见 [AWS SDK 证书文件](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html) 更多细节.

## 许可证

麻省理工学院

## 常见问题

### 如何安装 @ducktors/storagebus-s3？

在项目目录运行 npm install @ducktors/storagebus-s3，或使用 pnpm add / yarn add / bun add。

### @ducktors/storagebus-s3 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @ducktors/storagebus-s3 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @ducktors/storagebus-s3 可以商用吗？

@ducktors/storagebus-s3 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @ducktors/storagebus-s3 的下载量有多少？

根据 npm 官方下载统计，@ducktors/storagebus-s3 在 2026/10/13 – 2026/11/11 这 30 天内被下载 4,400 次，日均约 147 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @ducktors/storagebus-s3 还在维护吗？

最新版本 0\.12\.1 发布于 2025/12/20（10 个月前）；至今共发布 8 个版本，其中过去 12 个月发布了 2 个；首次发布于 2022/11/29。作者已将其标记为弃用，新项目建议寻找替代方案。