# @eggjs/background-task 中文文档

规范地址：https://npmcn.com/package/%40eggjs/background-task/

版本：4\.1\.0
npm 元数据更新时间：2026-10-07T08:21:21.707Z
中文译文更新时间：2026-11-13T12:53:21.298Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40eggjs/background-task
原文对照：https://npmcn.com/package/%40eggjs/background-task/?lang=original
项目主页：https://github.com/eggjs/egg/tree/next/tegg/core/background-task
源码仓库：https://github.com/eggjs/egg

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

- 包体积（解压后）：7.2 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：3 个
- peer 依赖：egg 4\.2\.0
- 首次发布：2025-10-23T15:39:13.178Z
- 最新版本发布：2026-10-07T08:21:21.038Z
- 近 30 天下载量：3776（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 33 个）

## 中文简介

tgg 的背景任务工具

## 安装

```sh
npm install @eggjs/background-task
```

也可以使用：`pnpm add @eggjs/background-task`、`yarn add @eggjs/background-task`、`bun add @eggjs/background-task`

## README

# `@eggjs/background-task`

[![NPM version](https://img.shields.io/npm/v/@eggjs/background-task.svg?style=flat-square)](https://npmjs.org/package/@eggjs/background-task) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/background-task/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/background-task) [![npm download](https://img.shields.io/npm/dm/@eggjs/background-task.svg?style=flat-square)](https://npmjs.org/package/@eggjs/background-task) [![Node.js Version](https://img.shields.io/node/v/@eggjs/background-task.svg?style=flat)](https://nodejs.org/en/download/)

## 安装

```sh
npm i --save @eggjs/background-task
```

## 使用量

```ts
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 是什么？

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 和提交记录判断。