sqs-producer

Enqueues messages onto a given SQS queue.

Installation

To install this package, enter the following command into your terminal (or the variant of whatever package manager you are using):

npm install sqs-producer

Node Version

We will only support Node versions that are actively or security supported by the Node team. If you are still using an Node 14, please use a version of this library before the v3.2.1 release, if you are using Node 16, please use a version before the v3.3.0 release.

Documentation

Visit https://bbc.github.io/sqs-producer/ for the full API documentation.

Usage

1import { Producer } from 'sqs-producer';
2import { SQSClient } from '@aws-sdk/client-sqs';
3
4// create simple producer
5const producer = Producer.create({
6  queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
7  region: 'eu-west-1'
8});
9
10// send messages to the queue
11await producer.send(['msg1', 'msg2']);
12
13// get the current size of the queue
14const size = await producer.queueSize();
15console.log(`There are ${size} messages on the queue.`);
16
17// send a message to the queue with a specific ID (by default the body is used as the ID)
18await producer.send([
19  {
20    id: 'id1',
21    body: 'Hello world'
22  }
23]);
24
25// send a message to the queue with
26// - delaySeconds (must be an number contained within 0 and 900)
27// - messageAttributes
28await producer.send([
29  {
30    id: 'id1',
31    body: 'Hello world with two string attributes: attr1 and attr2',
32    messageAttributes: {
33      attr1: { DataType: 'String', StringValue: 'stringValue' },
34      attr2: { DataType: 'Binary', BinaryValue: new Buffer('binaryValue') }
35    }
36  },
37  {
38    id: 'id2',
39    body: 'Hello world delayed by 5 seconds',
40    delaySeconds: 5
41  }
42]);
43
44// send a message to a FIFO queue
45//
46// note that AWS FIFO queues require two additional params:
47// - groupId (string)
48// - deduplicationId (string)
49//
50// deduplicationId can be excluded if content-based deduplication is enabled
51//
52// https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html
53await producer.send({
54  id: 'testId',
55  body: 'Hello world from our FIFO queue!',
56  groupId: 'group1234',
57  deduplicationId: 'abcdef123456' // typically a hash of the message body
58});

Credentials

By default the consumer will look for AWS credentials in the places specified by the AWS SDK. The simplest option is to export your credentials as environment variables:

1export AWS_SECRET_ACCESS_KEY=...
2export AWS_ACCESS_KEY_ID=...

If you need to specify your credentials manually, you can use a pre-configured instance of the SQS Client client.

1import { Producer } from 'sqs-producer';
2import { SQSClient } from '@aws-sdk/client-sqs';
3
4// create simple producer
5const producer = Producer.create({
6  queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
7  region: 'eu-west-1',
8  sqs: new SQSClient({
9    region: 'my-region',
10    credentials: {
11      accessKeyId: 'yourAccessKey',
12      secretAccessKey: 'yourSecret'
13    }
14  })
15});
16
17// send messages to the queue
18await producer.send(['msg1', 'msg2']);

Development

Test

1npm test

Coverage

For coverage report, run the command:

1npm run coverage

Lint

To check for problems using ESLint

1npm run lint

Contributing

We welcome and appreciate contributions for anyone who would like to take the time to fix a bug or implement a new feature.

But before you get started, please read the contributing guidelines and code of conduct.

License

SQS Producer is distributed under the Apache License, Version 2.0, see LICENSE for more information.