@eggjs/background-task

安装
npm i --save @eggjs/background-task
使用量
import { BackgroundTaskHelper } from '@eggjs/background-task';
@ContextProto()
export default class BackgroundService {
@Inject()
private readonly backgroundTaskHelper: BackgroundTaskHelper;
async backgroundAdd() {
this.backgroundTaskHelper.run(async () => {
// do the background task
});
}
}
背景情况
tegg 在请求完成后释放请求上下文 。 所以请使用 process.nextTick, (中文(简体) ), setTimeout, (中文(简体) ), setInterval 请求中并不安全.
请使用 backgroundTaskHelper,发布进程将等待所有背景任务完成.
超时
发布过程会等待任务完成,但不会永远完成. 默认的超时为 5s, 如果任务花费超过 5s, 两种解决方式
- 使用该
SingletonProto 做这项工作, SingletonProto 从不释放
- 设置较长的超时
backgroundTaskHelper.timeout
关于 @eggjs/background-task 的常见问题
@eggjs/background-task 是什么?
tgg 的背景任务工具
如何安装 @eggjs/background-task?
在项目目录运行 npm install @eggjs/background-task,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:egg(4.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。
@eggjs/background-task 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@eggjs/background-task 支持 ESM 还是 CommonJS?
以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@eggjs/background-task 需要什么版本的 Node.js?
package.json 的 engines 字段要求 Node.js >=22.18.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@eggjs/background-task 可以商用吗?
@eggjs/background-task 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@eggjs/background-task 的下载量有多少?
根据 npm 官方下载统计,@eggjs/background-task 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,776 次,日均约 126 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@eggjs/background-task 还在维护吗?
最新版本 4.1.0 发布于 2026/10/07(1 个月前);至今共发布 39 个版本,其中过去 12 个月发布了 33 个;首次发布于 2025/10/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。