bloody-simple-sqs

Bloody simple SQS

A bloody simple SQS client for Node.js, based on the official AWS sdk.

Features

• Exposes promise and callback interfaces;
• Battle-tested under heavy load;
• Distributed under the MIT license, i.e. you can use it in open-source and commercial projects.

Installation

$ npm install bloody-simple-sqs

Requirements

• Node.js 0.8+

Quick start

Create a new SQS instance

var SQS = require('bloody-simple-sqs');

var sqs = new SQS({
 queueName: 'i-am-queue',
 accessKeyId: 'AKIA-access-key',
 secretAccessKey: 'secret-access-key',
 region: 'us-east-1'
});

Append message to queue

sqs.add({a: 1, b: 2})
  .then(function (data) {
    console.log('Message sucessfully appended to queue with id ' + data.id); 
  })
  .catch(function (err) {
    console.error(err);
  });

Retrieve and remove message from queue

sqs.poll({limit: 1, timeout: 20})
  .then(function (message) {
    if (message) {
      console.log(message); 
    } else {
      console.log('The queue is empty');
    }
  })
  .catch(function (err) {
    console.error(err);
  });

API Docs

For further information on Bloody Simple SQS methods please refer to the API Docs.

Contributors

Author: Dimitrios C. Michalakos

Acknowledgements

This project would not be without the extraordinary work of:

• Amazon Web Services (https://github.com/aws/aws-sdk-js)
• Petka Antonov (https://github.com/petkaantonov/bluebird)

License

MIT

Changelog

0.2.8 - 2014-12-17

• Expose #clear() method to remove all messages from queue
• Update the API docs with #clear()
• Update aws-sdk to v.2.1.2