# @basenative/upload 中文文档

规范地址：https://npmcn.com/package/%40basenative/upload/

版本：3\.0\.0
npm 元数据更新时间：2026-10-31T13:47:08.768Z
中文译文更新时间：2026-10-31T16:18:22.679Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40basenative/upload
原文对照：https://npmcn.com/package/%40basenative/upload/?lang=original
项目主页：https://github.com/DuganLabs/BaseNative/tree/main/packages/upload#readme
源码仓库：https://github.com/DuganLabs/BaseNative

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

- 包体积（解压后）：17.7 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-03-20T05:27:52.943Z
- 最新版本发布：2026-10-31T13:47:08.458Z
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

支持R2和S3适配器的文件上传处理

## 安装

```sh
npm install @basenative/upload
```

也可以使用：`pnpm add @basenative/upload`、`yarn add @basenative/upload`、`bun add @basenative/upload`

## README

# @basenative /上传

> 带有本地、S3和Cloudflare R2存储适配器的文件上传中间件

部分 [BaseNative](https://github.com/DuganLabs/basenative) 生态系统——基于信号的web运行时，基于原生HTML。

## 安装

```bash
npm install @basenative/upload
```

## 快速入门

```js
import { createUploadHandler, createLocalStorage } from '@basenative/upload';
import { createPipeline } from '@basenative/middleware';

const storage = createLocalStorage({ directory: './uploads' });

const upload = createUploadHandler(storage, {
  maxFileSize: 5 * 1024 * 1024, // 5 MB
  allowedTypes: ['image/jpeg', 'image/png', 'image/webp'],
  fieldName: 'avatar',
});

const pipeline = createPipeline().use(upload);
// ctx.state.uploads contains the uploaded file metadata
```

## S3 / R2

```js
import { createS3Storage } from '@basenative/upload';

const storage = createS3Storage({
  bucket: 'my-bucket',
  region: 'us-east-1',
  accessKeyId: process.env.AWS_ACCESS_KEY_ID,
  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
});

// For Cloudflare R2
import { createR2Storage } from '@basenative/upload';
const storage = createR2Storage({ binding: env.MY_BUCKET });
```

## API

### `parseMultipart(body, contentType)`

解析一个 `multipart/form-data` 请求主体。返回零件对象的数组： `{ name, filename, contentType, data, size }`.

### `createUploadHandler(storage, options?)`

创建一个上传中间件。选项:

-   `maxFileSize` -最大文件大小 (以字节为单位) (默认值: 10 MB)。
-   `allowedTypes` -允许的MIME类型的数组 (空 = 所有允许)。
-   `fieldName` -要读取的表单字段名(默认： `'file'`）。
-   `generateFilename(original)` -生成存储文件名的功能。默认值：16字节十六进制前缀+原始名称。

中间件运行后， `ctx.state.uploads` 包含的数组 `{ field, filename, url, size, contentType }` 对象。

### 存储适配器

-   `createLocalStorage(options)` —将文件存储在本地文件系统上。选项: `directory`.
    -   `.put(filename, data, contentType)` -存储文件。返回 `{ url }`.
    -   `.delete(filename)` —删除文件。
-   `createS3Storage(options)` -将文件存储在AWS s3中。选项： `bucket`， `region`， `accessKeyId`， `secretAccessKey`， `prefix`.
-   `createR2Storage(options)` —在Cloudflare R2中存储文件。选项: `binding` (来自工作程序env的R2绑定)， `prefix`.

## 许可证

apache - 2.0

## 常见问题

### @basenative/upload 是什么？

支持R2和S3适配器的文件上传处理

### 如何安装 @basenative/upload？

在项目目录运行 npm install @basenative/upload，或使用 pnpm add / yarn add / bun add。

### @basenative/upload 支持 TypeScript 吗？

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

### @basenative/upload 支持 ESM 还是 CommonJS？

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

### @basenative/upload 可以商用吗？

@basenative/upload 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @basenative/upload 还在维护吗？

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