# @cat-factory/provider-s3 中文文档

规范地址：https://npmcn.com/package/%40cat-factory/provider-s3/

版本：0\.2\.493
npm 元数据更新时间：2026-11-06T13:56:25.722Z
中文译文更新时间：2026-11-09T05:51:24.354Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40cat-factory/provider-s3
原文对照：https://npmcn.com/package/%40cat-factory/provider-s3/?lang=original
源码仓库：https://github.com/kibertoad/cat-factory

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

- 包体积（解压后）：14.9 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-06-28T16:42:10.611Z
- 最新版本发布：2026-11-06T13:56:25.357Z
- 近 30 天下载量：5722（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：470（近 12 个月 470 个）

## 中文简介

Opt-in AWS S3 blob后端用于代理架构局二进制-艺术存储抽象. 在一个 S3 桶上执行内核 二进制BlobBackend 端口 .

## 安装

```sh
npm install @cat-factory/provider-s3
```

也可以使用：`pnpm add @cat-factory/provider-s3`、`yarn add @cat-factory/provider-s3`、`bun add @cat-factory/provider-s3`

## README

# @ cat- factory/ professor- s3 (中文(简体) )

选入 **AWS S3 导弹** (或S3相容) 猫因子二进制文物的blob后端: 执行内核 `BinaryBlobBackend` 左上方有一个S3桶.

## 为什么这是它自己的包

Blob 后端可插件: 文物 **元数据** 总是住在运行时间的数据库,但 页:1 **字节** 可以去任何地方(Cloudflare R2,即本地文件系统Postgres,或S3). S3开入 重型 `@aws-sdk/client-s3`,所以它作为自己的选入包 仅仅部署 选择 S3 取决于 。 即便如此,SDK还是进口的 **懒得第一I/ 欧**模块中 加载:表面静态导入 `S3BinaryBlobBackend` 把它的容器装上电线,但部署 最终运行 `db`编号 :`fs`没有blob后端 从不支付SDK的负载费用;SDK是 只有S3时才进来 `put`编号 :`get`编号 :`delete` 实际执行.

月台的商店不会是同一端口 还有一个步骤: 在您身上注册 部署 `BinaryStoreRegistry` 所以一个账户可以选择它。 见 [`backend/docs/custom-binary-stores.md`](https://github.com/kibertoad/cat-factory/blob/main/backend/docs/custom-binary-stores.md)。 。 。 .

## 扶持它

软件包输出一个类:

-   `S3BinaryBlobBackend`(单位:千美元) `BinaryBlobBackend` (单位:千美元)`put` 编号 : `get` 编号 : `delete`)由一个 `S3BinaryBlobBackendConfig`。 。 。 .

### 节点/ 本地外观

节点外观按类型选择后端 `BuildBlobBackend` 切换(参见 `backend/runtimes/node/src/container.ts`; 计 数 `s3` 大小写从账户创建后端 内容存储配置 :

```ts
import { S3BinaryBlobBackend } from '@cat-factory/provider-s3'

case 's3':
  if (!opts.s3) return null
  return new S3BinaryBlobBackend({
    ...opts.s3,                                              // region, bucket, prefix, endpoint, forcePathStyle
    ...(opts.s3Credentials ? { credentials: opts.s3Credentials } : {}),
  })
```

账户选择 S3 后端( 和供应区域 / 桶 + 证书) **内容存储设置 UI**;外观从这个配置中构建出后端. 选择 `credentials` 是故意的, 并回到 **环境 AWS 证书链** (咨询) 角色, `AWS_*` env:在AWS上运行并附带角色的部署的正确行为. (UI需要明确的密钥,所以无密钥路径只能通过所写的配置到达) 另一个频道。 )

> **运行时间到达.** S3系接线 **节点/ 本地** 外观. 云花岗工人使用 **资源2** 作为它的原生blob后端,所以它不拉入 `@aws-sdk/client-s3`缩放 (多语种) 节点部署应更可取 `s3` 超过 `fs` 后端, 其本地磁盘 字节被其他复制品所看不见,在被重新部署时丢失.

## S3相容仓库

点 `endpoint` 在非AWS S3 API(MINIO, Ceph等)和设置 `forcePathStyle: true` (须 由大多数S3兼容的商店进行. 可选 `prefix` (例如:. `artifacts/`) 加入每个 文物的存储钥匙.

## 配置( E)`S3BinaryBlobBackendConfig`(中文(简体) )

| 选项 | 目的 |
| --- | --- |
| `region` | AWS区域(必需). |
| `bucket` | 目标桶(需要). |
| `prefix` | 可选密钥前缀, 如 . `artifacts/`,加入了文物的存储密钥. |
| `endpoint` | S3兼容商店的可选自定义端点(MINIO等). |
| `forcePathStyle` | 强制路径式地址(大多数S3兼容商店需要). |
| `credentials` | 明确 `{ accessKeyId, secretAccessKey, sessionToken? }`; 省略使用默认的 AWS 证书链. |

## 相关

猫因子选入的一部分 **AWS 堆栈** 并行 [`@cat-factory/provider-bedrock`](https://github.com/kibertoad/cat-factory/tree/main/backend/packages/provider-bedrock) (LLM模型)和 [`@cat-factory/eks`](https://github.com/kibertoad/cat-factory/tree/main/backend/packages/eks) (跑者+环境后端). 每一个都具有独立性并进行登记 进入它自己的接缝:只将你们所用的东西混合在一起.

## 常见问题

### @cat-factory/provider-s3 是什么？

Opt-in AWS S3 blob后端用于代理架构局二进制-艺术存储抽象\. 在一个 S3 桶上执行内核 二进制BlobBackend 端口 \.

### 如何安装 @cat-factory/provider-s3？

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

### @cat-factory/provider-s3 支持 TypeScript 吗？

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

### @cat-factory/provider-s3 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cat-factory/provider-s3 可以商用吗？

@cat-factory/provider-s3 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @cat-factory/provider-s3 的下载量有多少？

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

### @cat-factory/provider-s3 还在维护吗？

最新版本 0\.2\.493 发布于 2026/11/06（2 天前）；至今共发布 470 个版本，其中过去 12 个月发布了 470 个；首次发布于 2026/06/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。