https://github.com/delvedor/workq
A super tiny work queue
https://github.com/delvedor/workq
jobs queue workflow
Last synced: 10 months ago
JSON representation
A super tiny work queue
- Host: GitHub
- URL: https://github.com/delvedor/workq
- Owner: delvedor
- License: mit
- Created: 2017-10-16T13:52:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-30T14:38:27.000Z (over 6 years ago)
- Last Synced: 2024-12-27T12:33:32.815Z (over 1 year ago)
- Topics: jobs, queue, workflow
- Language: JavaScript
- Homepage:
- Size: 22.5 KB
- Stars: 37
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# workq
[](http://standardjs.com/) [](https://travis-ci.org/delvedor/workq) [](https://coveralls.io/github/delvedor/workq?branch=master)
A super tiny work queue.
It can handle nested queues, the order of execution is guaranteed.
The top level queue will start automatically once you add at least one job in the queue, the nested queues will start once the `done` callback has been called; you cannot add more jobs in the current queue after `done` has been called.
If you need a shared queue between multiple files pass the option `{ singleton: true }` in every file you need it.
## Install
```
npm i workq --save
```
## Usage
```js
const q = require('workq')()
q.add(job)
function job (child, done) {
// perform some work
// you can add nested jobs!
child.add(nestedJob)
done()
})
function nestedJob (child, done) {
// perform some work
done()
})
```
Async/await and promises are supported as well!
```js
const q = require('workq')()
q.add(job)
// there is no need to call `done`!
async function job (child) {
// perform some work
// you can add nested jobs!
child.add(nestedJob)
})
async function nestedJob (child) {
// perform some work
})
```
If you need to know when a queue has finished all its jobs, you can use the `drain` api.
*Note that in the top queue the drain hook can be called multiple times.*
```js
const q = require('workq')()
q.drain(done => {
// the current queue has finished its jobs
// async await is supported as well
done()
})
q.add(job)
function job (child, done) {
// perform some work
// you can add nested jobs!
child.add(nestedJob)
done()
})
function nestedJob (child, done) {
// perform some work
done()
})
```
If you need to pass some parameter to the job, just add them after the function in `add`:
```js
const q = require('workq')()
q.add(job, 'hello', 42)
function job (child, greeting, num, done) {
console.log(greeting, num) // 'hello' 42
done()
})
```
If needed you can also use the `child` method to create custom child queues. The child queues will be executed once the current queue has finished its execution.
```js
const q = require('workq')()
const childq = q.child()
q.add(job, 'hello', 42)
childq.add(job, 'hello', 42)
function job (child, greeting, num, done) {
console.log(greeting, num) // 'hello' 42
done()
})
```
## License
Licensed under [MIT](./LICENSE).