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

Installation

``shell script
$ npm i --save @ethberry/nestjs-sqs
`

Quick Start

$3

Just like you register any other microservice

`ts
import { SQSClient } from "@aws-sdk/client-sqs";
import { SqsServer } from "@ethberry/nestjs-sqs";

const sqs = new SQSClient({
endpoint: "http://localhost:9324",
region: "none",
credentials: {
accessKeyId: "x",
secretAccessKey: "x",
},
});

app.connectMicroservice({
strategy: new SqsServer({
consumerOptions: {
sqs,
queueUrl: "http://localhost:9324/queue/producer.fifo",
},
producerOptions: {
sqs,
queueUrl: "http://localhost:9324/queue/consumer.fifo",
},
}),
});
`

$3

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

`ts
@Controller()
export class SqsController {
@MessagePattern(MESSAGE_TYPE)
public handleMessage(message: any): Promise {
// do something, return result
}

@EventPattern(EVENT_TYPE)
public handleEvent(event: any): Promise {
// do something
}
}
`

$3

`ts
import { SQSClient } from "@aws-sdk/client-sqs";
import { SqsClient, SQS_SERVICE } from "@ethberry/nestjs-sqs";

const sqs = new SQSClient({
endpoint: "http://localhost:9324",
region: "none",
credentials: {
accessKeyId: "x",
secretAccessKey: "x",
},
});

@Module({
imports: [
ClientsModule.register([
{
name: SQS_SERVICE,
customClass: SqsClient,
options: {
consumerUrl: "http://localhost:9324/queue/consumer.fifo",
producerUrl: "http://localhost:9324/queue/producer.fifo",
sqs,
},
},
]),
],
providers: [AppService],
})
class AppModule {}

export class AppService {
constructor(
@Inject(SQS_SERVICE)
private readonly sqsClientProxy: ClientProxy,
) {}

public dispatch(): Promise {
void this.client.emit(EVENT_NAME, {});
}
}
`

$3

`sh
docker compose up -d
npm t
``

License

This project is licensed under the terms of the MIT license.