Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcanno/best-queue
Queue in runtime based promise
https://github.com/jcanno/best-queue
async await promise queue task
Last synced: 22 days ago
JSON representation
Queue in runtime based promise
- Host: GitHub
- URL: https://github.com/jcanno/best-queue
- Owner: Jcanno
- License: mit
- Created: 2020-03-13T14:38:08.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T07:21:41.000Z (3 months ago)
- Last Synced: 2024-11-19T21:38:58.700Z (about 1 month ago)
- Topics: async, await, promise, queue, task
- Language: TypeScript
- Homepage:
- Size: 1.36 MB
- Stars: 36
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.org/package/best-queue)
[](https://www.npmjs.org/package/best-queue)
[](https://www.npmjs.org/package/best-queue)
[](https://www.npmjs.org/package/best-queue)
[](https://www.npmjs.org/package/best-queue)
English|[简体中文](https://github.com/Jcanno/best-queue/blob/master/README.zh-CN.md)
## Introduction
`best-queue` let you control tasks in a queue.
It's easy to execute task one by one with interval time in queue like this:
```js
Queue -> task -> wait(interval) -> task -> wait(interval) -> task -> finish
```
How about adding async task in queue:
```js
Queue -> Promise.resolve(task) -> wait(interval) -> Promise.resolve(task) -> wait(interval) -> Promise.resolve(task) -> finish
```
What if we want to execute two tasks at the same time to support concurrency in queue:
```js
Queue -> Promise.all([Promise.resolve(task), Promise.resolve(task)]) -> wait(interval) -> Promise.all([Promise.resolve(task), Promise.resolve(task)]) -> wait(interval) -> Promise.all([Promise.resolve(task), Promise.resolve(task)]) -> finish
```
But if one async task takes too much time because of network reason, the batch of task need to wait until the slow task resolve, we can do something make queue more efficient in theory.
That's `best-queue` do. See image below.
## Install
type in the command line to install with:
```js
npm i best-queue
```
## Usage
Import as an ES Module:
```js
import { createQueue } from "best-queue";
```
Require in Node:
```js
const { createQueue } = require("best-queue");
```
Use Script source(Exposed `BQueue` as global var):
```js
```
## **API**
| Attribute/Method | Description | Type | Default |
| :------------------------------- | -------------------------------------------------------------- | :--------------------------------------------------- | -------------------------------------------------------- |
| createQueue | create a queue | (tasks: unkonwn[], options: Options) => Promise | |
| options | create a queue by options | Object | {
max: 1,
interval: 0,
recordError: false
} |
| options.max | max concurrence task at the same time, default and min to 1 | Number | 1 |
| options.interval | the interval time between tow tasks(milliscond), default to 0 | Number | 0 |
| options.recordError | record error task instead of reject queue when task gone error | Boolean | false |
| pause() | `pause` the queue, queue stop to execute task | Function(): void |
| resume() | rerun the queue | Function(): void |
| subscribe(listener: Listener) | listener fired a task done | Function(({taskStatus: 'success' \| 'error', data: unknown, taskIndex: number, progress: number}) => void): () => void |
## Example
```js
import { createQueue } from "best-queue";
// simulate async task
function asyncTask() {
return new Promise((resolve) => {
setTimeout(() => {
resolve(1);
}, 1000);
});
}
const asyncTasks = [asyncTask, asyncTask];
/**
* createQueue returns enhanced promise
*/
const queue = createQueue(asyncTasks, {
max: 1,
interval: 1 * 1000,
recordError: false,
});
queue.then((result) => {
console.log(result);
});
const unsubscribe = queue.subscribe(({ taskIndex }) => {
// queue will be paused after first task
taskIndex === 0 && queue.pause();
});
setTimeout(() => {
// queue paused after first task done, it will rerun the queue
queue.resume();
}, 1500);
```
## Lisence
Copyright (c) 2020 Jacano Licensed under the MIT license.