sqs-consumer

sqs-consumer

Build SQS-based applications without the boilerplate. Just define a function that receives an SQS message and call a callback when the message has been processed.

Installation

npm install sqs-consumer

Usage

var Consumer = require('sqs-consumer');

var app = new Consumer({
  queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
  region: 'eu-west-1',
  handleMessage: function (message, done) {
    // do some work with `message`
    done();
  }
});

app.start();

• The queue is polled continuously for messages using long polling.
• Messages are deleted from the queue once done() is called.
• Calling done(err) with an error object will cause the message to be left on the queue. An SQS redrive policy can be used to move messages that cannot be processed to a dead letter queue.

API

new Consumer(options)

Creates a new SQS consumer.

Options

• queueUrl - String - The SQS queue URL
• region - String - The AWS region
• handleMessage - Function - A function to be called whenever a message is receieved. Receives an SQS message object as its first argument and a function to call when the message has been handled as its second argument (i.e. handleMessage(message, done)).
• waitTime - Number - An optional time in milliseconds to wait after recieving a message before requesting another one. This enables you to throttle the rate at which messages will be received. (default 100);
• sqs - Object - An optional AWS SQS object to use if you need to configure the client manually

consumer.start()

Start polling the queue for messages.

Events

Each consumer is an EventEmitter and emits the following events:

Event	Params	Description
error	err	Fired when an error occurs interacting with the queue or processing the message.
message_received	message	Fired when a message is received.
message_processed	message	Fired when a message is successfully processed and removed from the queue.