Cloudq-consumer NPM

CloudQ Consumer

This module is a javascript api wrapper for consuming CloudQ Jobs.

example

var consumer = require('cloudq-consumer');

consumer({
  server: 'http://token:secret@localhost:3000/',
  queue: 'foo',
  interval: 2000
}).consume(function(job, complete, log) {
  ...
  //Do worker stuff here
  ...
  complete(null, job.id, function() { log.info('done'); } );
});

api

constructor

consumer(config)

config object server - name of the cloudq server (include auth in url) queue - name of the queue to monitor to consume jobs from interval - amount of time in between checks in milliseconds

the constructor returns a consumer instance with the following methods:

consume

consume

consume(function(job, complete, log) { complete(null, 'success', function() { }); });

The consume method get invoked every time a job is found and returned on the queue.

This is where you can handle your worker processing, the consume method takes a function which will be passed two paramters.

job - this is the job object being passed from CloudQ { id: 'XXXXX', klass: 'foo', args: .... }
complete - this is a callback method that takes the following parameters:
- error - if no error then pass null
- id - in this param is the job id, so that the complete task can tell cloudq I am finished.
log - optional parameter to the bunyan logging system in case you want to log info on your worker