fifo-process-queue v1.2.1

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:

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:

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, 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.