seneca-kue v0.1.1-alpha.1

A Seneca.js job queue plugin

seneca-kue

A plugin that allows you to create and use queues, wrapped around the kue library

If you're using this module, and need help, you can:

• Post a GitHub issue
• Complain to @Wardormeur

If you are new to Seneca in general, please take a look at senecajs.org. We have everything from tutorials to sample apps to help get you up and running quickly.

This is not an official plugin maintained by the seneca team, use at your own risks :)

BEWARE : by a limitation of Kue itself, there cannot be more than one Kue per process.

Install

To install, simply use npm. Remember you will need to install Seneca.js if you haven't already.

npm install seneca
npm install seneca-kue

Usage in the same process

var s = require('seneca')()
var assert = require('assert')

var task = {
  task: 'my task',
  param: 42
}

s.use('kue-queue')

s.add({
  task: 'my task'
}, function(args, cb) {
  assert.equal(args.param, 42)
  cb()
  s.act({ role: 'kue-queue', cmd: 'stop' })
})

s.act({ role: 'kue-queue', cmd: 'start' })
s.act({ role: 'kue-queue', cmd: 'enqueue', msg: task })

Options

It is possible to pass additional options when registering the queue plugin, as shown below

var s = require('seneca')()
var assert = require('assert')

s.use('kue-queue', {
  role: 'myQQ'
})

• role, default: 'kue-queue'. This is the role to be used for start, stop and enqueue commands, you can change it in case of a conflict with other action patterns or if you want to register two different queues.

It is possible to pass additional options when creating a job or when running the worker, like delaying or repository Refer to the examples for more, or to kue's documentation as the library's goal is to be a wrapper for seneca

License

Copyright Matteo Collina and Senecajs.org contributors, 2015-2016, Licensed under MIT.