# @flatfile/plugin-zip-extractor 中文文档

规范地址：https://npmcn.com/package/%40flatfile/plugin-zip-extractor/

版本：0\.8\.1
npm 元数据更新时间：2026-04-23T23:54:49.691Z
中文译文更新时间：2026-11-14T21:49:19.375Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40flatfile/plugin-zip-extractor
原文对照：https://npmcn.com/package/%40flatfile/plugin-zip-extractor/?lang=original
项目主页：https://github.com/FlatFilers/flatfile-plugins#readme
源码仓库：https://github.com/FlatFilers/flatfile-plugins

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

- 包体积（解压后）：20.5 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：5 个
- peer 依赖：@flatfile/api ^1\.9\.19，@flatfile/listener ^1\.1\.0
- 首次发布：2023-07-31T23:30:36.803Z
- 最新版本发布：2024-12-19T22:29:49.923Z
- 近 30 天下载量：40340（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 0 个）

## 中文简介

在 Flatfile 中解密并上传内容的插件 .

## 安装

```sh
npm install @flatfile/plugin-zip-extractor
```

也可以使用：`pnpm add @flatfile/plugin-zip-extractor`、`yarn add @flatfile/plugin-zip-extractor`、`bun add @flatfile/plugin-zip-extractor`

## README

这个 `@flatfile/plugin-zip-extractor` 插件解压缩了ZIP文件并将其内容上传到Flatfile,由其他提取器进一步处理.

**事件类型 :** `listener.on('file:created')`

**支持的文件类型 :** `.zip`

> 嵌入Flatfile时,该插件应被部署在服务器侧听器中. [学多点](https://npmcn.com/docs/orchestration/listeners#listener-types)

## 参数

#### `options.debug` - 说吧 `default: false` - 说吧 `boolean` - (可选)

这个 `debug` 参数允许您切换打开/关闭帮助调试信件 发展目的.

## API 调用

-   `api.files.download`
-   `api.files.get`
-   `api.files.update`
-   `api.jobs.ack`
-   `api.jobs.complete`
-   `api.jobs.create`
-   `api.jobs.fail`
-   `api.jobs.update`

## 使用量

听好要上传到 Flatfile 的 ZIP 文件 。 文件将被下载、解析并上载到 Flatfile 。 一旦完成,文件将准备在文件区域导入 。 此插件被设计为用于与其他提取器相交, 如 [Excel 提取器](https://npmcn.com/package/%40flatfile/extractors/xlsx-extractor),以提取和处理 ZIP 文件所包含文件的内容。 名称开始的文件 `.` 将被忽略,因为这些通常是系统文件(即:. `.DS_store`) (中文(简体) ).

```bash
npm i @flatfile/plugin-zip-extractor
```

```js
import { ZipExtractor } from "@flatfile/plugin-zip-extractor";
```

**听众.js**

```js
listener.use(ZipExtractor());
```

### 完整示例

在这个例子中 `ZipExtractor` 已初始化,然后在 Flatfile 听器中注册为中间软件。 当JSON文件被上传后,插件会提取出ZIP文件的内容并上传到FlatFile.

```javascript
import { ZipExtractor } from "@flatfile/plugin-zip-extractor";

// Initialize the ZIP extractor
const zipExtractor = ZipExtractor();

// Register the extractor as a middleware for the Flatfile listener
listener.use(zipExtractor);

// When a ZIP file is uploaded, the files will be extracted and uploaded.
```

## 常见问题

### @flatfile/plugin-zip-extractor 是什么？

在 Flatfile 中解密并上传内容的插件 \.

### 如何安装 @flatfile/plugin-zip-extractor？

在项目目录运行 npm install @flatfile/plugin-zip-extractor，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@flatfile/api（^1\.9\.19）、@flatfile/listener（^1\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flatfile/plugin-zip-extractor 支持 TypeScript 吗？

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

### @flatfile/plugin-zip-extractor 支持 ESM 还是 CommonJS？

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

### @flatfile/plugin-zip-extractor 需要什么版本的 Node\.js？

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

### @flatfile/plugin-zip-extractor 可以商用吗？

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

### @flatfile/plugin-zip-extractor 的下载量有多少？

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

### @flatfile/plugin-zip-extractor 还在维护吗？

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