ak-throttled-queue

Throttled queue for node.js. Async functions only. No guarantee for sync functions.

Example

1// autostart false
2
3const ThrottledQueue = require('ak-throttled-queue');
4
5const queue = new ThrottledQueue({
6  interval: 1000,
7  concurrency: 5,
8  autostart: false
9});
10
11// note if autostart is false, you cannot await the fn execution if you are in the same scope since this will block
12// this below wont work!
13
14const result = await queue.push(async () => {
15  return new Promise(resolve =>
16    setTimeout(() => {
17      resolve('resolved');
18    }, 1000)
19  );
20});
21
22queue.start();
23
24// this will work
25
26const resultPromise = queue.push(async () => {
27  return new Promise(resolve =>
28    setTimeout(() => {
29      resolve('resolved');
30    }, 1000)
31  );
32});
33
34queue.start();
35
36const result = await resultPromise;
37
38// autostart true (default)
39
40const queue = new ThrottledQueue({
41  interval: 1000,
42  concurrency: 5
43});
44// this will work
45
46const result = await queue.push(async () => {
47  return new Promise(resolve =>
48    setTimeout(() => {
49      resolve('resolved');
50    }, 1000)
51  );
52});
53
54// queue end with drain = true
55
56const endPromise = queue.end();
57
58// this will throw an error, because queue is in ending state
59queue.push(async () => {});
60
61await endPromise;
62
63// this will work, since queue is clean and finished draining
64queue.push(async () => {});
65
66// queue end with drain = false (all queued functions will be rejected with an error
67const queue = new ThrottledQueue({
68  interval: 1000,
69  concurrency: 5,
70  autostart: false
71});
72const queueFnPromise = queue.push(async () => {});
73
74await queue.end({ drain: false });
75
76try {
77  await queueFnPromise;
78} catch (error) {
79  console.log(error);
80  // > Error: queue stopped, aborting!
81}

Commiting

The project uses commitlint so please follow the commit message guidelines there:

commitlint

1yarn commit # runs a commit promt with semver conform commit messages

Workflow

Adding new features/fixes

Create a PR with your code to the develop branch. Please take care that your PR title follows the semantic message format

Once your PR is reviewed and approved, merge it via a SQUASH MERGE commit. Please take care that the title of your squash merge commit is a valid semantic message format

Releases

To trigger a new release simply create and merge a PR to the main branch.