# @buttercup/channel-queue 中文文档

规范地址：https://npmcn.com/package/%40buttercup/channel-queue/

版本：1\.5\.0
npm 元数据更新时间：2024-12-11T16:02:36.438Z
中文译文更新时间：2026-11-08T20:36:10.485Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40buttercup/channel-queue
原文对照：https://npmcn.com/package/%40buttercup/channel-queue/?lang=original
项目主页：https://github.com/buttercup/channel-queue#readme
源码仓库：https://github.com/buttercup/channel-queue

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

- 包体积（解压后）：36.1 kB，17 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2017-10-20T18:44:13.109Z
- 最新版本发布：2024-12-11T16:02:36.239Z
- 近 30 天下载量：2849（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

有频道的队列管理库

## 安装

```sh
npm install @buttercup/channel-queue
```

也可以使用：`pnpm add @buttercup/channel-queue`、`yarn add @buttercup/channel-queue`、`bun add @buttercup/channel-queue`

## README

# 频道队列

有频道的队列管理库 .

![Tests status](https://github.com/buttercup/channel-queue/actions/workflows/test.yml/badge.svg) [![npm version](https://badge.fury.io/js/%40buttercup%2Fchannel-queue.svg)](https://www.npmjs.com/package/@buttercup/channel-queue)

## 关于

这个库提供了一个由频道(或"主题")组织而成的队列系统,它允许对同步方法执行进行更精细的控制. 它允许通过频道(以字符串命名)排队任务——任务在完成上个任务后按顺序执行. 它还允许三个优先级别: **常规**, (中文(简体) ), **高级** 财务报告和审定财务报表 **尾声**。 。 。 .

看看这个 [API 文档](https://npmcn.com/package/%40buttercup/channel-queue/API.md)。 。 。 .

## 安装

简单运行 :

```shell
npm install @buttercup/channel-queue --save
```

## 使用量

最简单的用法就是将一些任务排队:

```typescript
import { ChannelQueue } from "@buttercup/channel-queue";

const queue = new ChannelQueue();
const work = queue.channel("myChannel").enqueue(() => 123);
// 'work' will resolve with 123

const someChannel = queue.channel("someChannel");
someChannel.enqueue(job1);
someChannel.enqueue(job2);
someChannel.enqueue(job3);
```

您可以将任务设置为高优先级, 从而将任务凌驾于其它任务之上 :

```typescript
import { ChannelQueue, TaskPriority } from "@buttercup/channel-queue";

const queue = new ChannelQueue();
const workChannel = queue.channel("work");
// some other tasks added to the queue...
workChannel.enqueue(importantJobMethod, TaskPriority.High).then(result => {
    // 'result' is the resolved result from the 'importantJobMethod' function
});
```

任务也可以作为“ 低” 优先级运行, 或者在 **尾声** 队列结束 :

```typescript
import { ChannelQueue, TaskPriority } from "@buttercup/channel-queue";

const queue = new ChannelQueue();
const workChannel = queue.channel("work");
// some other tasks added to the queue...
workChannel.enqueue(runNearEnd, TaskPriority.Tail);
```

### 处理错误

无论一个被排入的任务是否失败,频道都会在完成后继续处理.

默认情况下, 如果选中任务 `enqueue` 扔出一个错误,它会扔到 `enqueue` 电话 :

```typescript
// The following throws:
await channel.enqueue(() => Promise.reject(new Error("Fails!")));
```

您可以通过设置来禁用被排列的函数抛出错误 `tasksThrow` 改为 `false`数字 :

```typescript
channel.tasksThrow = false;
// The following will not throw:
await channel.enqueue(() => Promise.reject(new Error("Fails!")));
```

禁用此选项只使用 `waitForEmpty` 与 `throwForFailures` 设置为 `true`。这使得您可以延迟错误处理,直到等待频道:

```typescript
channel.tasksThrow = false;
channel.enqueue(() => /* ... */)
channel.enqueue(() => Promise.reject(new Error("Fails!")));

// Later:
await channel.waitForEmpty({ throwForFailures: true });
```

### 堆叠

项目可以被"打包",指如果指定,项目只能被限制在队列中的1个待处理项目. 同一堆栈的所有项目 _名称_ 将仅排队于同一项目,而不创建更多任务。 排序时可指定堆栈 :

```typescript
import { ChannelQueue } from "@buttercup/channel-queue";

const queue = new ChannelQueue();
const workChannel = queue.channel("work");

const promise1 = workChannel.enqueue(saveWorkFn, undefined, /* Stack ID */ "save");
// work start
const promise2 = workChannel.enqueue(saveWorkFn, undefined, "save");
const promise3 = workChannel.enqueue(saveWorkFn, undefined, "save");
// promise2 and promise3 will be equal, as promise2 was still in the queue when promise3
```

### 并行执行

任务可以同时使用 `ParallelChannel` 课。 您可以通过调用来创建并行频道, 以代替常规频道 `ChannelQueue#createParallelChannel`数字 :

```typescript
import { ChannelQueue } from "@buttercup/channel-queue";

const queue = new ChannelQueue();
const workChannel = queue.createParallelChannel("work");
workChannel.enqueue(someTask);

// The same channel can be fetched later using the familiar channel() method:
queue.channel("work"); // The parallel channel
```

平行渠道,如其名称所暗示的,可以并行地运行任务. 与其像普通频道那样头到尾地运行它们,平行频道可以同时执行许多任务. 也可以限制在一定数量 _线程_ (默认为 2) 通过调用 `queue.createParallelChannel("name", 5)` (何处) `5` 是同时任务的最大数量.

默认的并行渠道不会同时执行不同优先级的任务. 这意味着,如果当前运行中的任务是高优先级的,就不会开始正常的优先级任务. 此特性可以通过运行被禁用 `parallelChannel.canRunAcrossTaskTypes = true`。 。 。 .

### 等待和清除

您可以通过使用 : `waitForEmpty`数字 :

```typescript
channel.enqueue(someTask);
channel.enqueue(someTask);

// Later:
await channel.waitForEmpty();
```

您可以清除所有排列在 `Channel` 拨打 `clear()`数字 :

```typescript
queue.channel("myChannel").clear();
```

## 开发和支持的节点版本

此库意在与 NodeJS 版本一起使用 **6个** 及后会.

要贡献, 复制此工程并运行 `npm install` 在开始发展之前.

测试一下,只要运行 `npm test`。 。 。 .

## 常见问题

### @buttercup/channel-queue 是什么？

有频道的队列管理库

### 如何安装 @buttercup/channel-queue？

在项目目录运行 npm install @buttercup/channel-queue，或使用 pnpm add / yarn add / bun add。

### @buttercup/channel-queue 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @buttercup/channel-queue 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @buttercup/channel-queue 可以商用吗？

@buttercup/channel-queue 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @buttercup/channel-queue 的下载量有多少？

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

### @buttercup/channel-queue 还在维护吗？

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