# @flatfile/plugin-job-handler 中文文档

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

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

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

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

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

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

## 中文简介

处理 Flatfile 任务的插件 .

## 安装

```sh
npm install @flatfile/plugin-job-handler
```

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

## README

这个 `@flatfile/plugin-job-handler` 软件包是一个插件,旨在简化处理 Flatfile Jobs 的程序,这是在文件、工作簿或工作表等资源上同步完成的大型工作单位.

**事件类型 :** `listener.on('job:ready')`

## 参数

#### `job` - 说吧 `string` - (必须)

这个 `job` 参数在监听时用作过滤器 `job:ready`。 。 。 .

#### `handler` - 说吧 `function` - (必须)

这个 `handler` 参数是一个执行代码的回调。 它接受两个论点: `event` 财务报告和审定财务报表 `tick`。 。 。 .

-   `event`编号: `FlatfileEvent`,给出处理器的背景.
-   `tick`: 可用于更新工作进度的函数。 它接受两个参数:
    -   `progress`: 数字在0至100之间,表示进度百分比.
    -   `message`:可选描述字符串.

援引 `tick` 函数返回解析到任务响应对象的许诺。 然而,使用 `tick` 函数是可选的.

#### `opts.debug` - 说吧 `boolean` - 说吧 `default: false`

这个 `debug` 参数用于启用插件的调试日志.

## 使用量

这个 `jobHandler` 插件管理 Flatfile 任务 。 它会听 `job:ready` 事件并基于 `job` 参数.

当a `job:ready` 事件发生 :

-   这个 `handler` 随 `FlatfileEvent` 和可选 `tick` 函数.
-   这个 `tick` 函数,如果使用,则更新 Job 进度.
-   这个 `handler` 可能会产生一个最终的诺言 `JobResponse` 对象,允许定制成功的工作状态.

#### 安装

```bash
npm i @flatfile/plugin-job-handler
```

#### 导入

```js
import { jobHandler } from "@flatfile/plugin-job-handler";
```

替换 `"domain:operation"` 包含您想要聆听的域和操作.

#### `listener.js`

```js
listener.use(
  jobHandler("domain:operation", async (event, tick) => {
    try {
      // your code here...
      await tick(50, "Halfway there!"); // update Job progress
      // ...continue your code...
      await tick(75, "Three quarters there!"); // update Job progress
      // ...continue your code...
      return {
        outcome: {
          message: "Job complete",
        },
      };
    } catch (error) {
      throw error; // will fail the Job
    }
  })
);
```

## 常见问题

### @flatfile/plugin-job-handler 是什么？

处理 Flatfile 任务的插件 \.

### 如何安装 @flatfile/plugin-job-handler？

在项目目录运行 npm install @flatfile/plugin-job-handler，或使用 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-job-handler 支持 TypeScript 吗？

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

### @flatfile/plugin-job-handler 支持 ESM 还是 CommonJS？

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

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

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

### @flatfile/plugin-job-handler 可以商用吗？

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

### @flatfile/plugin-job-handler 的下载量有多少？

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

### @flatfile/plugin-job-handler 还在维护吗？

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