https://github.com/robtimus/fifo-process-queue
A queue for processing data in FIFO order
https://github.com/robtimus/fifo-process-queue
fifo javascript queue
Last synced: about 1 month ago
JSON representation
A queue for processing data in FIFO order
- Host: GitHub
- URL: https://github.com/robtimus/fifo-process-queue
- Owner: robtimus
- License: apache-2.0
- Created: 2017-12-27T15:40:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-04T14:20:47.000Z (5 months ago)
- Last Synced: 2025-04-24T02:53:47.995Z (about 1 month ago)
- Topics: fifo, javascript, queue
- Language: TypeScript
- Homepage:
- Size: 276 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# fifo-process-queue
[](https://www.npmjs.com/package/fifo-process-queue)
[](https://github.com/robtimus/fifo-process-queue/actions/workflows/build.yml)
[](https://sonarcloud.io/summary/overall?id=robtimus%3Afifo-process-queue)
[](https://sonarcloud.io/summary/overall?id=robtimus%3Afifo-process-queue)
[](https://snyk.io/test/github/robtimus/fifo-process-queue)
A queue for processing data in FIFO order.
Process queues can run in one of two modes:
### FIFO processing mode
In _FIFO processing_ mode, pieces of data are processed one at a time. Only when the previous piece of data has been processed will the next piece of data be processed.
To create a queue in FIFO processing mode, provide only a _processor_ function. This function must take two arguments:
* The data to process. This is the data that was pushed onto the queue.
* A callback function. When the processing is done, this non-argument callback _must_ be called.
Example:
```js
var FIFOProcessQueue = require('fifo-process-queue');
var queue = FIFOProcessQueue(function (data, callback) {
console.log('Processing', data);
setTimeout(function () {
console.log('Finished', data);
callback();
}, 100);
});
queue.push(1);
queue.push(2);
queue.pushAll([3, 4, 5]);
```
### FIFO post-processing mode
In _FIFO post-processing_ mode, pieces of data may be processed in parallel. However, after a piece of data has been processed, a _post-processor_ function is called for the piece of data. Invocations of this post-processor function are performed in FIFO order.
To create a queue in FIFO post-processing mode, provide not only a processor function (see above), but also a post-processor function. This function must take one argument:
* The data to process. This is the data that was pushed onto the queue.
In addition, the maximum number of concurrenty processed pieces of data can be given (at least 1). If this is omitted the queue will not impose any limits.
Example:
```js
var FIFOProcessQueue = require('fifo-process-queue');
var queue = FIFOProcessQueue(function (data, callback) {
console.log('Processing', data);
setTimeout(function () {
console.log('Finished', data);
callback();
}, 100);
}, function (data) {
console.log('Post-processing', data);
}, 10); // maximum 10 pieces of data processed concurrently; optional value
queue.push(1);
queue.push(2);
queue.pushAll([3, 4, 5]);
```
## Using in browsers
Besides using tools like [Browserify](http://browserify.org/), you can also simply include file `index.js` in a script tag. This will register a global function `FIFOProcessQueue` which can be used to create process queues.