# @edgefirst-dev/r2-file-storage 中文文档

规范地址：https://npmcn.com/package/%40edgefirst-dev/r2-file-storage/

版本：1\.3\.0
npm 元数据更新时间：2025-05-23T22:48:42.178Z
中文译文更新时间：2026-11-14T13:48:37.176Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40edgefirst-dev/r2-file-storage
原文对照：https://npmcn.com/package/%40edgefirst-dev/r2-file-storage/?lang=original
项目主页：https://edgefirst-dev.github.io/r2-file-storage
源码仓库：https://github.com/edgefirst-dev/r2-file-storage

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

- 包体积（解压后）：9.4 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- peer 依赖：@cloudflare/workers-types ^4\.20250523\.0，@mjackson/file-storage ^0\.6\.1
- 首次发布：2024-09-05T19:57:16.920Z
- 最新版本发布：2025-05-23T22:48:41.793Z
- 近 30 天下载量：2019（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

使用 R2 作为存储后端的 @mjackson/ file- storage 的实现 .

## 安装

```sh
npm install @edgefirst-dev/r2-file-storage
```

也可以使用：`pnpm add @edgefirst-dev/r2-file-storage`、`yarn add @edgefirst-dev/r2-file-storage`、`bun add @edgefirst-dev/r2-file-storage`

## README

# @ dedgefirst-dev/r2 文件存储

执行 [@mjackson/ 文件存储](https://github.com/mjackson/remix-the-web/tree/main/packages/file-storage) 用R2作为存储后端.

## 特征

-   简单、直观的密钥/值 API( 如 [网络存储](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API)不过 `File`s 代替字符串)
-   通用软件 `FileStorage` 用于各种 Cloudflare R2 的类.
-   全部保留 `File` 元数据包括 `file.name`, (中文(简体) ), `file.type`,以及 `file.lastModified`

## 安装

从 npm 或 GitHub 包注册处安装;

```sh
bun add @edgefirst-dev/r2-file-storage
```

## 使用量

```ts
import { R2FileStorage } from "@edgefirst-dev/r2-file-storage";

let storage = new R2FileStorage(r2); // Get r2 from your Cloudflare bindings

let file = new File(["hello world"], "hello.txt", { type: "text/plain" });
let key = "hello-key";

// Set the file in storage.
await storage.set(key, file);

let file = await storage.put(key, file);

// Then, sometime later...
let fileFromStorage = await storage.get(key);
// All of the original file's metadata is intact
fileFromStorage.name; // 'hello.txt'
fileFromStorage.type; // 'text/plain'

// To remove from storage
await storage.remove(key);

await storage.list({ prefix: "hello" }); // List all files with keys starting with "hello"
```

## 许可证

见 [自由主义](https://npmcn.com/package/%40edgefirst-dev/r2-file-storage/LICENSE)

## 作者

-   [塞尔吉奥·沙拉姆布里](https://sergiodxa.com/)

## 常见问题

### @edgefirst-dev/r2-file-storage 是什么？

使用 R2 作为存储后端的 @mjackson/ file- storage 的实现 \.

### 如何安装 @edgefirst-dev/r2-file-storage？

在项目目录运行 npm install @edgefirst-dev/r2-file-storage，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@cloudflare/workers-types（^4\.20250523\.0）、@mjackson/file-storage（^0\.6\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @edgefirst-dev/r2-file-storage 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/edgefirst-dev\_\_r2-file-storage 是否存在。

### @edgefirst-dev/r2-file-storage 支持 ESM 还是 CommonJS？

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

### @edgefirst-dev/r2-file-storage 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @edgefirst-dev/r2-file-storage 可以商用吗？

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

### @edgefirst-dev/r2-file-storage 的下载量有多少？

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

### @edgefirst-dev/r2-file-storage 还在维护吗？

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