@flatfile/plugin-job-handler

这个 @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 对象,允许定制成功的工作状态.

安装

npm i @flatfile/plugin-job-handler

导入

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

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

listener.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
    }
  })
);