im-queue 是一个 Node.js 的队列管理库，它能够帮助你快速构建高效的队列系统。
安装
我们可以通过 npm 进行安装：
npm install im-queue
使用
用 im-queue 可以非常方便地创建一个队列对象：
-- -------------------- ---- ------- ----- ----- - -------------------- ----- ----- - --- ------- ------------ - -- ---- - --- ------------ -- - ----------------- ------ --- ------------ -- - ----------------- ------ --- ------------ -- - ----------------- -------- --- --------------
这里创建了一个并发数为 2 的队列对象 queue，然后向队列中添加了三个任务，通过 queue.start() 启动队列。
API
im-queue 提供了一些常用的 API：
Queue
const Queue = require('im-queue');是一个构造函数，用于创建一个新的队列对象。
queue.add
queue.add(task: Function | Promise, priority: number = 0): Promise
添加一个任务到队列中，可以传入 priority 参数来调整执行顺序。
queue.start
queue.start(): Promise
开始执行队列中的任务。
queue.pause
queue.pause(): Promise
暂停队列中的任务。如果任务已经在执行，则会等待当前任务执行完再暂停队列。
queue.resume
queue.resume(): Promise
继续队列中的任务。
queue.clear
queue.clear(): Promise
清除队列中的所有任务。
queue.resolve
queue.resolve(): Promise
结束队列的所有任务，强制执行 finally 函数。
queue.isEmpty
queue.isEmpty(): boolean
检查队列是否为空。
queue.isPaused
queue.isPaused(): boolean
检查队列是否已暂停。
queue.isRunning
queue.isRunning(): boolean
检查队列是否在运行。
queue.pending
queue.pending: number
返回队列中等待执行的任务数量。
queue.running
queue.running: number
返回队列中正在执行的任务数量。
queue.completed
queue.completed: number
返回队列中已经执行完成的任务数量。
示例
-- -------------------- ---- -------
----- ----- - --------------------
----- ----- - --- -------
------------ -
---
----- ----- - ------------ -- -
------ --- ----------------- -- -
----------------- --- --------
------------- -- -
----------------- --- -------
----------
-- ------
---
---
----- ----- - ------------ -- -
----------------- ------
---
------------ -- -
----------------- --------
---
---------------------- ------ -- -
----------------------------- --------
---
----------------------- ------ -- -
----------------------------- ---------
---
----------------------- ------ ---- -- -
----------------------------- ---------
-------------------
---
------------------- ------ ----------------------- -- -
---------------- -------
-------------- -- -
-------------------
---运行上述示例，可以看到队列中第一个任务需要等待 1 秒才能完成。
总结
im-queue 是一个方便、易用的 Node.js 队列管理库，它可以帮助我们快速构建高效的队列系统。在实际应用中，我们可以通过更多的 API 来扩展它的能力，例如：drain 事件、next 方法等。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671cb30d0927023822813