nestjs-sqs

Tested with: AWS SQS and ElasticMQ.

Nestjs-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 and bbc/sqs-consumer, and implements some more useful features on top of the basic functionality given by them.

Installation

1$ npm i --save @ssut/nestjs-sqs

Quick Start

Register module

Just register this module:

1@Module({
2  imports: [
3    SqsModule.register({
4      consumers: [],
5      producers: [],
6    }),
7  ],
8})
9class AppModule {}

Quite often you might want to asynchronously pass module options instead of passing them beforehand. In such case, use registerAsync() method like many other Nest.js libraries.

• Use factory

1SqsModule.registerAsync({
2  useFactory: () => {
3    return {
4      consumers: [],
5      producers: [],
6    };
7  },
8});

• Use class

1SqsModule.registerAsync({
2  useClass: SqsConfigService,
3});

• Use existing

1SqsModule.registerAsync({
2  imports: [ConfigModule],
3  useExisting: ConfigService,
4});

Decorate methods

You need to decorate methods in your NestJS providers in order to have them be automatically attached as event handlers for incoming SQS messages:

1import { Message } from '@aws-sdk/client-sqs';
2
3@Injectable()
4export class AppMessageHandler {
5  @SqsMessageHandler(/** name: */ 'queueName', /** batch: */ false)
6  public async handleMessage(message: Message) {}
7
8  @SqsConsumerEventHandler(/** name: */ 'queueName', /** eventName: */ 'processing_error')
9  public onProcessingError(error: Error, message: Message) {
10    // report errors here
11  }
12}

Produce messages

1export class AppService {
2  public constructor(
3    private readonly sqsService: SqsService,
4  ) { }
5
6  public async dispatchSomething() {
7    await this.sqsService.send(/** name: */ 'queueName', {
8      id: 'id',
9      body: { ... },
10      groupId: 'groupId',
11      deduplicationId: 'deduplicationId',
12      messageAttributes: { ... },
13      delaySeconds: 0,
14    });
15  }
16}

Configuration

See here, and note that we have same configuration as bbc/sqs-consumer's. 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.