# @arkstack/jobs 中文文档

规范地址：https://npmcn.com/package/%40arkstack/jobs/

版本：0\.22\.2
npm 元数据更新时间：2026-11-07T14:01:00.076Z
中文译文更新时间：2026-11-06T21:00:15.629Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40arkstack/jobs
原文对照：https://npmcn.com/package/%40arkstack/jobs/?lang=original
项目主页：https://arkstack.toneflix.net/guide/jobs
源码仓库：https://github.com/arkstack-hq/arkstack

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

- 包体积（解压后）：22.7 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：2 个
- peer 依赖：@h3ravel/musket ^2\.2\.13，@arkstack/contract ^0\.22\.2
- 首次发布：2026-06-21T12:02:27.127Z
- 最新版本发布：2026-11-07T14:00:59.707Z
- 近 30 天下载量：2346（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：93（近 12 个月 93 个）

## 中文简介

Arkstack 的工作模块, 提供可调度的工作班次.

## 安装

```sh
npm install @arkstack/jobs
```

也可以使用：`pnpm add @arkstack/jobs`、`yarn add @arkstack/jobs`、`bun add @arkstack/jobs`

## README

# @ arkstack/ 工作

[![@arkstack/jobs](https://img.shields.io/npm/dt/@arkstack/jobs?style=flat-square&label=@arkstack/jobs&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F@arkstack/jobs)](https://www.npmjs.com/package/@arkstack/jobs)

Arkstack 的工作模块,提供可调度的工作班和一个调度员 [`@arkstack/queue`](https://npmcn.com/package/%40arkstack/queue)。 。 。 .

`@arkstack/jobs` 这是 **撰写** 层; `@arkstack/queue` 是运输工具。 这个包裹给你 `Job` 基类,该 `dispatch()` 帮助者,以及一个登记册 这样工人可以重建你的工作类别 从存储的有效载荷.

## 写作

```bash
ark make:job SendWelcomeEmail
```

```ts
// src/app/jobs/SendWelcomeEmail.ts
import { Job } from '@arkstack/jobs'

export class SendWelcomeEmail extends Job {
  constructor(public userId: number) {
    super()
  }

  async handle() {
    // ... send the email
  }
}
```

## 调度

```ts
import { dispatch } from '@arkstack/jobs'
import { SendWelcomeEmail } from '@app/jobs/SendWelcomeEmail'

// static helper
await SendWelcomeEmail.dispatch(user.id)
await SendWelcomeEmail.dispatch(user.id).onQueue('mail').withDelay(60)
await SendWelcomeEmail.dispatchSync(user.id) // run inline now

// functional helper
await dispatch(new SendWelcomeEmail(user.id))
await dispatch(new SendWelcomeEmail(user.id), { queue: 'mail', delay: 60 })
```

默认 `sync` 队列连接任务立即运行。 配置 a `database` 或者说 `redis` 连接( 见 `@arkstack/queue`经营一个工人 背景中的进程任务 :

```bash
ark queue:work
```

## 设置

导入 `@arkstack/jobs` 任何连接队列(去)序列化的地方 自动。 用于明确的靴子钩(下至) `@arkstack/database/setup`:

```ts
import '@arkstack/jobs/setup'
```

## 重建如何运作

每个 `Job` 登记本身 `JobRegistry` 当建造。 当a 工人弹出有效载荷,登记簿重建实例(通过 并指定序列化 `data` 回到这里。 专职工人 **进程**中,确保您的工作模块被导入——或呼叫 `JobRegistry.register(MyJob)` ——所以名字在处理前就已经知道.

覆盖 `serialize()` 在一份定制有效载荷的工作.

## 常见问题

### @arkstack/jobs 是什么？

Arkstack 的工作模块, 提供可调度的工作班次\.

### 如何安装 @arkstack/jobs？

在项目目录运行 npm install @arkstack/jobs，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@h3ravel/musket（^2\.2\.13）、@arkstack/contract（^0\.22\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @arkstack/jobs 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/arkstack\_\_jobs 是否存在。

### @arkstack/jobs 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @arkstack/jobs 可以商用吗？

@arkstack/jobs 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @arkstack/jobs 的下载量有多少？

根据 npm 官方下载统计，@arkstack/jobs 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,346 次，日均约 78 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @arkstack/jobs 还在维护吗？

最新版本 0\.22\.2 发布于 2026/11/07（今天）；至今共发布 93 个版本，其中过去 12 个月发布了 93 个；首次发布于 2026/06/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。