Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bbc/sqs-producer
Simple scaffolding for applications that produce SQS messages
https://github.com/bbc/sqs-producer
aws awssqs sqs sqs-producer
Last synced: 3 days ago
JSON representation
Simple scaffolding for applications that produce SQS messages
- Host: GitHub
- URL: https://github.com/bbc/sqs-producer
- Owner: bbc
- License: other
- Created: 2014-12-16T08:47:11.000Z (about 10 years ago)
- Default Branch: canary
- Last Pushed: 2024-10-01T20:35:11.000Z (4 months ago)
- Last Synced: 2024-10-15T07:32:35.762Z (3 months ago)
- Topics: aws, awssqs, sqs, sqs-producer
- Language: TypeScript
- Homepage: https://bbc.github.io/sqs-producer/
- Size: 905 KB
- Stars: 204
- Watchers: 36
- Forks: 51
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# sqs-producer
[](https://npmjs.org/package/sqs-producer)
[](https://github.com/bbc/sqs-producer/actions/workflows/test.yml)
[](https://codeclimate.com/github/bbc/sqs-producer/maintainability)
[](https://codeclimate.com/github/bbc/sqs-producer/test_coverage)
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/](https://bbc.github.io/sqs-producer/) for the full API documentation.
## Usage
```js
import { Producer } from "sqs-producer";
import { SQSClient } from "@aws-sdk/client-sqs";
// create simple producer
const producer = Producer.create({
queueUrl: "https://sqs.eu-west-1.amazonaws.com/account-id/queue-name",
region: "eu-west-1",
});
// 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
//
// https://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
});
```
### Credentials
By default the consumer will look for AWS credentials in the places [specified by the AWS SDK](https://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Setting_AWS_Credentials). The simplest option is to export your credentials as environment variables:
```bash
export AWS_SECRET_ACCESS_KEY=...
export AWS_ACCESS_KEY_ID=...
```
If you need to specify your credentials manually, you can use a pre-configured instance of the [SQS Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/classes/sqsclient.html) client.
```js
import { Producer } from "sqs-producer";
import { SQSClient } from "@aws-sdk/client-sqs";
// create simple producer
const producer = Producer.create({
queueUrl: "https://sqs.eu-west-1.amazonaws.com/account-id/queue-name",
region: "eu-west-1",
sqs: new SQSClient({
region: "my-region",
credentials: {
accessKeyId: "yourAccessKey",
secretAccessKey: "yourSecret",
},
}),
});
// send messages to the queue
await producer.send(["msg1", "msg2"]);
```
## Development
### Test
```bash
npm test
```
### Coverage
For coverage report, run the command:
```bash
npm run coverage
```
### Lint
To check for problems using ESLint
```bash
npm 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](https://github.com/bbc/sqs-producer/blob/main/.github/CONTRIBUTING.md) and [code of conduct](https://github.com/bbc/sqs-producer/blob/main/.github/CODE_OF_CONDUCT.md).
## License
SQS Producer is distributed under the Apache License, Version 2.0, see [LICENSE](./LICENSE) for more information.