sqs-producer
Enqueues messages onto a given SQS queue
Installation
npm install sqs-producer
Usage
const { Producer } = require('sqs-producer');
// create simple producer
const 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)
const 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
await producer.send(['msg1', 'msg2']);
// get the current size of the queue
const size = await producer.queueSize();
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)
await producer.send([{
id: 'id1',
body: 'Hello world'
}]);
// send a message to the queue with
// - delaySeconds (must be an number contained within 0 and 900)
// - messageAttributes
await 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
}
]);
// 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
await producer.send({
id: "testId",
body: 'Hello world from our FIFO queue!',
groupId: 'group1234',
deduplicationId: 'abcdef123456' // typically a hash of the message body
});
Development
Test
npm test
Coverage
For coverage report, run the command:
npm run coverage
Lint
To check for problems using ESLint
npm run lint
375 Oct 15, 2022
53.2k Dec 31, 2022
14.3k Jan 1, 2023
5.3k Dec 30, 2022
4.7k Dec 23, 2022
4.4k Jan 4, 2023
2.1k Dec 16, 2022
179 Oct 26, 2022
14.1k Dec 31, 2022
1.4k Dec 26, 2022
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
6 Dec 3, 2022
2 Jan 25, 2022
113 Dec 6, 2022
3 Jan 20, 2022
8 Oct 18, 2022
189 Jan 3, 2023
8 Dec 28, 2022