https://github.com/nestjs-packages/sqs
AWS SQS module for Nest framework (node.js) 👷
https://github.com/nestjs-packages/sqs
nest nestjs queue sqs typescript
Last synced: 6 months ago
JSON representation
AWS SQS module for Nest framework (node.js) 👷
- Host: GitHub
- URL: https://github.com/nestjs-packages/sqs
- Owner: nestjs-packages
- License: mit
- Created: 2021-07-19T10:20:00.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T19:56:51.000Z (7 months ago)
- Last Synced: 2025-03-28T01:14:42.157Z (6 months ago)
- Topics: nest, nestjs, queue, sqs, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@nestjs-packages/sqs
- Size: 1.43 MB
- Stars: 81
- Watchers: 1
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Description
@nestjs-packages/sqs is a project to make SQS easier to use and control some required flows with NestJS. This module provides decorator-based message handling suited for simple use.
This library internally uses [bbc/sqs-producer](https://github.com/bbc/sqs-producer) and [bbc/sqs-consumer](https://github.com/bbc/sqs-consumer)
## Installation
```sh
$ npm i --save @nestjs-packages/sqs
# or
$ yarn add @nestjs-packages/sqs
```
## Quick Start
### SqsModule
#### forRootAsync
For use SqsModule, You have to set SQS configurations. you can set SQS configurations by forRootAsync method.
after forRootAsync method called, every sqs produers and consumers use SQS configurations returned by forRootAsync useFactory method
```ts
@Module({
imports: [
SqsModule.forRootAsync({
imports: [ConfigModule],
useFactory: (configService) => {
const config: SqsConfigOption = {
region: configService.region,
endpoint: configService.endpoint,
accountNumber: configService.accountNumber,
credentials: {
accessKeyId: configService.accessKeyId,
secretAccessKey: configService.secretAccessKey,
},
};
return new SqsConfig(config);
},
inject: [ConfigService],
}),
],
})
class AppModule {}
```
#### registerQueue
Second you have to register queues. register queues means create sqs-producer and sqs-consumer by queueOptions that passed into registerQueue parameter
default type of queueOption is 'ALL'
```ts
SqsModule.registerQueue(
{
name: 'queueName',
type?: SqsQueueType.Consumer // 'ALL'|'CONSUMER'|'PRODUCER'
consumerOptions?: {},
producerOptions?: {}
},
...
);
```
### consume message
You need to decorate providers and methods in your NestJS providers in order to have them be automatically attached as message(event) handlers for incoming SQS messages
```ts
@SqsProcess(/** name: */ queueName)
export class AppMessageHandler {
@SqsMessageHandler(/** batch: */ false)
public async handleMessage(message: AWS.SQS.Message) {}
@SqsConsumerEventHandler(/** eventName: */ SqsConsumerEvent.PROCESSING_ERROR)
public onProcessingError(error: Error, message: AWS.SQS.Message) {
// report errors here
}
}
```
You need to pass queueName to SqsProcess decorator. unless SqsModule won't register Consumer.
One class can only handle one queue. so if you want to enroll dead letter queue, you have to make new class that handle dead letter queue
### Produce messages
SqsService needs to be injected to produce the message.
```ts
@Injectable()
export class AppService {
public constructor(
private readonly sqsService: SqsService,
) { }
public async dispatchSomething() {
await this.sqsService.send(/** name: */ 'queueName', {
id: 'id',
body: { ... },
groupId: 'groupId',
deduplicationId: 'deduplicationId',
messageAttributes: { ... },
delaySeconds: 0,
});
}
}
```
### Configuration
See [here](https://github.com/DEV-MUGLES/nestjs-sqs/blob/master/lib/sqs.types.ts), and note that we have same configuration as [bbc/sqs-consumer's](https://github.com/bbc/sqs-consumer).
In most time you just need to specify both `name` and `queueUrl` at the minimum requirements.
## License
This project is licensed under the terms of the MIT license.
