barbeque v0.2.4

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 = {
  // host: 'localhost'
  // port: 6379,
  // namespace: 'test'
}

Worker

var Barbeque = require('barbeque'),
    bbq = new Barbeque(config);

bbq.process('add', function (task, done) {
  done(null, task.data.x + task.data.y);
});

//--> New worker created that process `add` tasks.

Task

var Barbeque = require('barbeque'),
    bbq = new Barbeque(config);

bbq.create('add', {
  x: 2,
  y: 3
}).save();

//--> New task saved to Redis DB and notified workers.

Admin UI

var Barbeque = require('barbeque'),
    bbq = new Barbeque();

bbq.admin();

• See more comprehensive examples here.

API

.admin()                   // start admin UI
.create(type, data)        // create an instance of Task
.listen()                  // listen to redis updates
.process(type, processfn)  // start a processor of a specific task type
.processAll(obj)           // obj: {key:type,val:data} and nestable
.query(query, cb)          // query: string id, array of string ids, or filter object
.queryDetail(query, cb)    // query: string id, array of string ids, or filter object
.run(processFn, data, cb)  // immediately run a task
.update(taskId, task, cb)  // update task

Task

.save(optionalCallback)    // enqueue task to the task queue
.priority(priority)        // specify task priority (lower value: higher priority)
.ttl(ttl)                  // auto-expire task (in ms)

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