node-ironio-2

iron.io client fork

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
node-ironio-2
0.5.04 years ago4 years agoMinified + gzip package size for node-ironio-2 in KB

Readme

node-ironio
node-ironio is a Node.js client for IronMQ, IronWorker, and IronCache. See http://www.iron.io for more details. node-ironio is inspired by seebees' ironmq module: https://github.com/seebees/ironmq

Install

npm install node-ironio

Examples

var ironio = require('node-ironio')('OAuth token'),
  project = ironio.projects('Project ID');

// IronMQ
var q = project.queues('myqueue');

// Get a message
q.get(function(err, message) {
  // do something with the message
  // then delete it
  message.del(function(err) {});
  // need more time?
  // touch the message
  message.touch(function(err) {});

  // can't process the message
  // release the message
  message.release(function(err) {});
});

// Enqueue a message
q.post('message', function(err, res) {});

// IronCache
var c = project.caches('mycache');

// Add an item to the cache
c.put('key', 'value', function(err) {});

// Get an item from the cache
c.get('key', function(err, val) {
  // do something with the val
});

// IronWorker

// Enqueue a task
project.tasks.queue(
  {
    code_name: 'code name',
    payload: 'payload',
    priority: 0,
    delay: 0,
    label: 'label name',
    cluster: 'default',
  },
  function(err, res) {}
);

See the test directory for more examples.

Future Work

  • IronWorker code package endpoints
  • CI for uploading IronWorker modules
  • Better configuration handling
  • More documentation and examples