频道队列

有频道的队列管理库 .

关于

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

看看这个 API 文档。 。 。 .

安装

简单运行 :

npm install @buttercup/channel-queue --save

使用量

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

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);

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

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
});

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

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 电话 :

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

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

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

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

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

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

堆叠

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

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数字 :

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数字 :

channel.enqueue(someTask);
channel.enqueue(someTask);

// Later:
await channel.waitForEmpty();

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

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

开发和支持的节点版本

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

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

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