asynchronous function queue with adjustable concurrency
npm install @synaptiko/queue``
____ __ _____ __ _____
/ __
/ /_/ / /_/ / __/ /_/ / __/
\__, /\__,_/\___/\__,_/\___/
/_/
``
Asynchronous function queue with adjustable concurrency.
This module exports a class Queue that implements most of the Array API. Pass async functions (ones that accept a callback or return a promise) to an instance's additive array methods. Processing begins when you call q.start().
javascript
var queue = require('../')var q = queue({ results: [] })
// add jobs using the familiar Array API
q.push(function (cb) {
const result = 'two'
cb(null, result)
})
q.push(
function (cb) {
const result = 'four'
cb(null, result)
},
function (cb) {
const result = 'five'
cb(null, result)
}
)
// jobs can accept a callback or return a promise
q.push(function () {
return new Promise(function (resolve, reject) {
const result = 'one'
resolve(result)
})
})
q.unshift(function (cb) {
const result = 'one'
cb(null, result)
})
q.splice(2, 0, function (cb) {
const result = 'three'
cb(null, result)
})
// use the timeout feature to deal with jobs that
// take too long or forget to execute a callback
q.timeout = 100
q.on('timeout', function (next, job) {
console.log('job timed out:', job.toString().replace(/\n/g, ''))
next()
})
q.push(function (cb) {
setTimeout(function () {
console.log('slow job finished')
cb()
}, 200)
})
q.push(function (cb) {
console.log('forgot to execute callback')
})
// jobs can also override the queue's timeout
// on a per-job basis
function extraSlowJob (cb) {
setTimeout(function () {
console.log('extra slow job finished')
cb()
}, 400)
}
extraSlowJob.timeout = 500
q.push(extraSlowJob)
// jobs can also opt-out of the timeout altogether
function superSlowJob (cb) {
setTimeout(function () {
console.log('super slow job finished')
cb()
}, 1000)
}
superSlowJob.timeout = null
q.push(superSlowJob)
// get notified when jobs complete
q.on('success', function (result, job) {
console.log('job finished processing:', job.toString().replace(/\n/g, ''))
console.log('The result is:', result)
})
// begin processing, get notified on end / failure
q.start(function (err) {
if (err) throw err
console.log('all done:', q.results)
})
`Install
dependency if
your environment does not have it by default (eg. browser, react-native). Test
npm test
API
$3
Constructor. may contain inital values for:
* q.concurrency
*
*
* Instance methods
$3
cb, if passed, will be called when the queue empties or when an error occurs.$3
Stops the queue. can be resumed with .$3
Stop and empty the queue immediately.Instance methods mixed in from
Array
Mozilla has docs on how these methods work here. Note that does not copy the queue.
$3
$3
$3
$3
$3
$3
$3
$3
$3
Properties
$3
Max number of jobs the queue should process concurrently, defaults to Infinity.$3
Milliseconds to wait for a job to execute its callback. This can be overridden by specifying a timeout property on a per-job basis.$3
Ensures the queue is always running if jobs are available. Useful in situations where you are using a queue only for concurrency control.$3
An array to set job callback arguments on.$3
Jobs pending + jobs to process (readonly).Events
$3
Immediately before a job begins to execute.$3
After a job executes its callback.$3
After a job passes an error to its callback.$3
After q.timeout milliseconds have elapsed and a job has not executed its callback.$3
After all jobs have been processedReleases
The latest stable release is published to npm. Abbreviated changelog below:
* 6.0
* Add start event before job begins (@joelgriffith)
* Add timeout property on a job to override the queue's timeout (@joelgriffith)
* 5.0
* Updated TypeScript bindings (@Codex-)
* 4.4
* Add results feature
* 4.3
* Add promise support (@kwolfy)
* 4.2
* Unref timers on end
* 4.1
* Add autostart feature
* 4.0
* Change license to MIT
* 3.1.x
* Add .npmignore
* 3.0.x
* Change the default concurrency to Infinity
* Allow to accept an optional callback executed on q.emit('end')`This work is free. You can redistribute it and/or modify it under the
terms of the MIT License.
See LICENSE for full details.