# @arkstack/queue 中文文档

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

版本：0\.22\.2
npm 元数据更新时间：2026-11-07T13:59:42.169Z
中文译文更新时间：2026-11-06T19:41:57.381Z
软件包许可：未声明

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

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

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

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

## 中文简介

Arkstack的队列模块,提供基于驱动的队列运输和工人进行背景处理.

## 安装

```sh
npm install @arkstack/queue
```

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

## README

# @arkstack/队列

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

Arkstack的队列模块,提供基于驱动的队列运输和工人进行背景处理.

`@arkstack/queue` 这是 **运输** 层:连接、司机和工人。 撰写您的工作 [`@arkstack/jobs`](https://npmcn.com/package/%40arkstack/jobs),提供 `Job` 基类和 a `dispatch()` 此软件包上的助手 .

## 连接

| 驱动程序 | 备份商店 | 页:1 |
| --- | --- | --- |
| `sync` | 运行内行 | 默认; 无工作者, 对 dev/ tests 有好处 |
| `database` | 通过表格 `@arkstack/database` | 投票员会用掉它 |
| `redis` | 重新编制清单/类型套件`ioredis`(中文(简体) ) | 分发, 支持延迟 |

## 配置

```ts
// src/config/queue.ts
import type { QueueConfig } from '@arkstack/queue'

export default (): QueueConfig => ({
  default: env('QUEUE_CONNECTION', 'sync'),
  connections: {
    sync: { driver: 'sync' },
    database: { driver: 'database', table: 'jobs', queue: 'default' },
    redis: {
      driver: 'redis',
      host: env('REDIS_HOST', '127.0.0.1'),
      port: env('REDIS_PORT', 6379),
    },
  },
})
```

## 使用量

```ts
import { Queue } from '@arkstack/queue'

await Queue.push(new SendWelcomeEmail(user)) // onto the default connection
await Queue.later(60, new ChargeInvoice(invoiceId)) // after 60 seconds
await Queue.connection('redis').push(job, 'emails') // a specific connection/queue
await Queue.size('emails')
await Queue.clear('emails')
```

## 工人

```bash
ark queue:work                      # daemon on the default connection's default queue
ark queue:work redis --queue=emails
ark queue:work --queue=high,default # priority list: high first, then default
ark queue:work '--queue=*'          # every queue on the connection (quote the *)
ark queue:work --once               # process a single job and exit
ark queue:clear redis --queue=emails
```

`--queue` 取一个队列,一个逗号分隔列表,或 `*`数字 :

-   **没有 `--queue`**: 只有连接的默认队列( t)`queue` . . . . . . . 工作 发往别处 `onQueue(...)` 或一个工作 `queue` 属性为 **没有** 已处理.
-   **列表** (单位:千美元)`--queue=webhook,ocr,default`)是严格的优先级顺序: 环绕工人的第一个工作,它发现在行走列表,所以以后排队 运行时,前一个是空的.
-   **`*`** 运行连接上的每个队列。 这个 `database` 驱动程序 所有队列中最老的应交工作 `redis` 驱动程序发现队列 `SCAN` 和工作他们圆 robin。 将它与名字合并,以优先排序一些: `--queue=webhook,*`。引用任意 `*` 在外壳中(`'--queue=webhook,*'`),或 zsh/bash可能将其扩展为被子.

每一个获得工作的队列都需要一个列出工作的工人(或 `*`),或其工作 永远等待.

在方案方面:

```ts
import { Queue } from '@arkstack/queue'

const worker = Queue.worker('database')
await worker.daemon({ queue: 'default', sleep: 3 })
await worker.daemon({ queue: ['webhook', '*'], sleep: 3 }) // priority list / wildcard
```

自定义驱动程序支持 `*` 以压倒性 `popAny()` 打开 `QueueContract`; 基础 执行只执行默认队列.

一个工作是 **删除** 关于成功, **已发行** 对于又一次尝试失败,和 **标记失败** (援引国际法院 `failed` 钩子) 一旦它耗尽 `tries`。 。 。 .

## 任务 (去) 序列化

司机以外的司机 `sync` 存储序列载荷并需要重建任务 工人身上的情况. `@arkstack/jobs` 为您注册这些策略 手动操作:

```ts
import { Queue } from '@arkstack/queue'

Queue.serializeUsing((job) => ({/* JobPayload */}))
Queue.resolveJobsUsing((payload) => rebuildJob(payload))
```

## 常见问题

### @arkstack/queue 是什么？

Arkstack的队列模块,提供基于驱动的队列运输和工人进行背景处理\.

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

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

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

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

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

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

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

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

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

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

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

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