Barbeque for Node.js
Barbeque
is Redis-based task queue library for Node.js, inspired by Celery and Kue.
Installation
$ npm install barbeque
Usage
var config = {
}
Worker
var Barbeque = require('barbeque'),
bbq = new Barbeque(config);
bbq.process('add', function (task, done) {
done(null, task.data.x + task.data.y);
});
Task
var Barbeque = require('barbeque'),
bbq = new Barbeque(config);
bbq.create('add', {
x: 2,
y: 3
}).save();
Admin UI
var Barbeque = require('barbeque'),
bbq = new Barbeque();
bbq.admin();
API
.admin()
.create(type, data)
.listen()
.process(type, processfn)
.processAll(obj)
.query(query, cb)
.queryDetail(query, cb)
.run(processFn, data, cb)
.update(taskId, task, cb)
Task
.save(optionalCallback)
.priority(priority)
.ttl(ttl)
Worker Events
.on('error', function (err))
.on('active', function (task))
.on('processing', function (task))
.on('complete', function (task))
.on('failed', function (task))
.on('inactive', function (task))
.on('log', function (task, msg))
.on('progress', function (task, percent))
Credits
See the contributors.
License
The MIT License (MIT)
Copyright (c) 2013-2014 Pilwon Huh
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.