sqs-producer
Version:
Enqueues messages onto a given SQS queue
113 lines (93 loc) • 2.98 kB
Markdown
sqs-producer
====================
[](https://npmjs.org/package/sqs-producer)
[](https://travis-ci.org/bbc/sqs-producer?branch=master)
[](https://codeclimate.com/github/BBC/sqs-producer)
[](https://codeclimate.com/github/BBC/sqs-producer)
Enqueues messages onto a given SQS queue
## Installation
```
npm install sqs-producer --save
```
## Usage
```js
var Producer = require('sqs-producer');
// create simple producer
var producer = Producer.create({
queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
region: 'eu-west-1'
});
// create custom producer (supporting all opts as per the API docs: http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html#constructor-property)
var producer = Producer.create({
queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
region: 'eu-west-1'
accessKeyId: 'yourAccessKey',
secretAccessKey: 'yourSecret'
});
// send messages to the queue
producer.send(['msg1', 'msg2'], function(err) {
if (err) console.log(err);
});
// get the current size of the queue
producer.queueSize(function (err, size) {
if (err) console.log(err);
console.log('There are', size, 'messages on the queue.');
});
// send a message to the queue with a specific ID (by default the body is used as the ID)
producer.send([{
id: 'id1',
body: 'Hello world'
}], function(err) {
if (err) console.log(err);
});
// send a message to the queue with
// - delaySeconds (must be an number contained within 0 and 900)
// - messageAttributes
producer.send([
{
id: 'id1',
body: 'Hello world with two string attributes: attr1 and attr2',
messageAttributes: {
attr1: { DataType: 'String', StringValue: 'stringValue' },
attr2: { DataType: 'Binary', BinaryValue: new Buffer('binaryValue') }
}
},
{
id: 'id2',
body: 'Hello world delayed by 5 seconds',
delaySeconds: 5
}
], function(err) {
if (err) console.log(err);
});
// send a message to a FIFO queue
//
// note that AWS FIFO queues require two additional params:
// - groupId (string)
// - deduplicationId (string)
//
// deduplicationId can be excluded if content-based deduplication is enabled
//
// http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html
producer.send({
body: 'Hello world from our FIFO queue!',
groupId: 'group1234',
deduplicationId: 'abcdef123456' // typically a hash of the message body
}, function(err) {
if (err) console.log(err);
});
```
## Test
```
npm test
```
## Coverage
For coverage report, run the command:
```
npm run coverage
```
## JSLint
To check for problems using JSLint
```
npm run lint
```