# @edgestore/react 中文文档

规范地址：https://npmcn.com/package/%40edgestore/react/

版本：1\.0\.1
npm 元数据更新时间：2026-10-24T04:11:57.513Z
中文译文更新时间：2026-11-13T06:49:32.586Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40edgestore/react
原文对照：https://npmcn.com/package/%40edgestore/react/?lang=original
项目主页：https://edgestore.dev/
源码仓库：https://github.com/edgestorejs/edgestore

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

- 包体积（解压后）：129 kB，66 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.22\.0
- 运行依赖：1 个
- peer 依赖：react \>=16\.8\.0，react-dom \>=16\.8\.0
- 首次发布：2023-08-03T12:58:40.334Z
- 最新版本发布：2026-10-24T04:11:57.123Z
- 近 30 天下载量：7442（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：76（近 12 个月 25 个）

## 中文简介

从React/Next.js轻松地上传文件

## 安装

```sh
npm install @edgestore/react
```

也可以使用：`pnpm add @edgestore/react`、`yarn add @edgestore/react`、`bun add @edgestore/react`

## README

# 文档

检查官员 [文档](https://edgestore.dev/) 更多信息.

# 快速启动

## 下一个. js 设置

### 安装

先安装所需的软件包.

```shell
npm install @edgestore/server @edgestore/react
```

### 环境变量

那就去你身边 [盘子](https://dashboard.edgestore.dev/),创建新工程,并复制环境变量的密钥.

```shell
EDGESTORE_ACCESS_KEY=your-access-key
EDGESTORE_SECRET_KEY=your-secret-key
```

### 后端

现在,我们可以为我们的Next.js应用程序创建后端代码.  
EdgeStore与Next.js两种应用程序兼容(`pages router` 财务报告和审定财务报表 `app router`) (中文(简体) ).

下面的例子就是用EdgeStore可以创建的最简单的桶. 只是一个简单的文件桶,没有验证,任何有链接的人都可以访问.

应用程序中可以有多个桶,每个桶都有自己的配置.

```ts
import { initEdgeStore } from '@edgestore/server';
import { createEdgeStoreNextHandler } from '@edgestore/server/adapters/next/app';

const es = initEdgeStore.create();

/**
 * This is the main router for the EdgeStore buckets.
 */
const router = es.router({
  publicFiles: es.fileBucket(),
});

const handler = createEdgeStoreNextHandler({
  router,
});

export { handler as GET, handler as POST };

/**
 * This type is used to create the type-safe client for the frontend.
 */
export type EdgeStoreRouter = typeof router;
```

### 前端

现在让我们启动我们的背景提供者.

```tsx
'use client';

import { createEdgeStoreProvider } from '@edgestore/react';
import { type EdgeStoreRouter } from '../app/api/edgestore/[...edgestore]/route';

const { EdgeStoreProvider, useEdgeStore } =
  createEdgeStoreProvider<EdgeStoreRouter>();

export { EdgeStoreProvider, useEdgeStore };
```

然后把我们的应用程序和供应商包裹起来.

```tsx
import { EdgeStoreProvider } from '../lib/edgestore';
import './globals.css';

// ...

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <body>
        <EdgeStoreProvider>{children}</EdgeStoreProvider>
      </body>
    </html>
  );
}
```

### 上传文件

你可以用这个 `useEdgeStore` 钩子可以访问一个类型安全前端客户端并使用它来上传文件.

```tsx
import * as React from 'react';
import { useEdgeStore } from '../lib/edgestore';

export default function Page() {
  const [file, setFile] = React.useState<File>();
  const { edgestore } = useEdgeStore();

  return (
    <div>
      <input
        type="file"
        onChange={(e) => {
          setFile(e.target.files?.[0]);
        }}
      />
      <button
        onClick={async () => {
          if (file) {
            const res = await edgestore.publicFiles.upload({
              file,
              onProgressChange: (progress) => {
                // you can use this to show a progress bar
                console.log(progress);
              },
            });
            // you can run some server action or api here
            // to add the necessary data to your database
            console.log(res);
          }
        }}
      >
        Upload
      </button>
    </div>
  );
}
```

### 替换文件

通过传递 `replaceTargetUrl` 选项,可以将已有文件替换为新文件. 它会在上传完成后自动删除旧文件.

您也可以使用同名文件上传文件,但在这种情况下,由于CDN缓存,您可能还会暂时看到旧文件.

两种方法都删除旧文件, 所以桶需要 `beforeDelete`,就像删除.

```tsx
const res = await edgestore.publicFiles.upload({
  file,
  options: {
    replaceTargetUrl: oldFileUrl,
  },
  // ...
});
```

### 删除文件

```tsx
await edgestore.publicFiles.delete({
  url: urlToDelete,
});
```

## 常见问题

### @edgestore/react 是什么？

从React/Next\.js轻松地上传文件

### 如何安装 @edgestore/react？

在项目目录运行 npm install @edgestore/react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.8\.0）、react-dom（\>=16\.8\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @edgestore/react 支持 TypeScript 吗？

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

### @edgestore/react 支持 ESM 还是 CommonJS？

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

### @edgestore/react 需要什么版本的 Node\.js？

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

### @edgestore/react 可以商用吗？

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

### @edgestore/react 的下载量有多少？

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

### @edgestore/react 还在维护吗？

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