https://github.com/alexalvess/event-message-broker
How can we work with AWS SNS (Simple Notification Service), SQS (Simple Queue Service), andAWS EventBridge as a Message Broker using NodeJS in a EDA (Event-Driven Architecture)
https://github.com/alexalvess/event-message-broker
event-bridge-scheduler event-driven eventbus message-broker message-bus message-queue sns-topic sqs-queue
Last synced: 8 months ago
JSON representation
How can we work with AWS SNS (Simple Notification Service), SQS (Simple Queue Service), andAWS EventBridge as a Message Broker using NodeJS in a EDA (Event-Driven Architecture)
- Host: GitHub
- URL: https://github.com/alexalvess/event-message-broker
- Owner: alexalvess
- License: mit
- Created: 2024-01-08T19:09:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T19:04:41.000Z (over 1 year ago)
- Last Synced: 2024-07-08T23:54:24.243Z (over 1 year ago)
- Topics: event-bridge-scheduler, event-driven, eventbus, message-broker, message-bus, message-queue, sns-topic, sqs-queue
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/event-broadcast
- Size: 429 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Message Bus SDK for AWS Resources
[](https://www.npmjs.com/package/aws-message-bus-package)
## Table of Contents
* [Getting Started](#getting-Started)
* [API](#api)
## Getting Started
**1. Install**
```shell
npm install aws-message-bus-package
```
**2. Config File**
You need to create a config.json file in your root/src project and input some AWS informations, like bellow:
```json
{
"host": "localhost",
"port": 4566,
"region": "eu-west-2",
"account": "000000000000",
"snsArn": "arn:aws:sns",
"sqsArn": "arn:aws:sqs",
"awsHost": "localhost.localstack.cloud",
"tags": [
{ "Key": "team", "Value": "your-team-name" },
{ "Key": "appName", "Value": "your-app-name" }
],
"testMode": false
}
```
**3. Sample Usage**
```javascript
const { Infrastructure } = require('aws-message-bus-package');
async () => await Infrastructure.createQueue('your-queue-name');
async () => await Infrastructure.createTopic('your-topic-name');
async () => await Infrastructure.bindTopic('your-topic-name', 'your-queue-name');
```
## API
### `Infrastructure.createQueue('queue-name')`
Create a new SQS queue
### `Infrastructure.bindTopic('topic-name', 'queue-name')`
* Create a new SNS topic, if not exists
* Subscribe a SNS topic in a SQS queue
### `Service.publishMessage('topic-name', {CONTENT})`
Send a message to SNS topic to do broadcast
* Content: any kind of type/object, this will be transformed into a JSON format
### `Service.sendMessage('queue-name', {CONTENT}, {PARAMS})`
Send a message to SQS queue direct
* Content: any kind of type/object, this will be transformed into a JSON format
* Params: [SQS.Types.SendMessageRequest](https://github.com/aws/aws-sdk-js/blob/7bcd9ab0d0b623ac99730a051a9758068910e9b3/clients/sqs.d.ts#L751)
* **You don't need to inform:**
* MessageBody
* MessageAttributes
* QueueUrl
### `Service.scheduleMessage('topic-name', {CONTENT}, [SCHEDULED_DATE])`
Send a message to EventBridge informing the SNS topic with the destination. This message will be consumed when it arrives on the scheduled date.
* Content: any kind of type/object, this will be transformed into a JSON format
### `Service.handleConsumerMessage('queue-name', {RESILIENCE_PARAMS})`
Handle a consumer to consume queue messages
* Resilience Params:
* maxRetryCount: max number of attempts until send to DLQ
* delaySeconds: the time that will wait between attempts