npmpackage.info

Gathering detailed insights and metrics for @ssut/nestjs-sqs

@ssut/nestjs-sqs

A project to make SQS easier to use within NestJS, with decorator-based handling and seamless NestJS-way integration.

3.0.0

215

MIT

TypeScript

5,989,018 3.2

Installations

npm install @ssut/nestjs-sqs

Pull Requests

Open

2

Total

23

Closed

4

Merged

17

Issues

Open

32

Total

64

Closed

32

Releases

v3.0.0

Published on 14 Jul 2024

v2.3.0

Published on 12 Jul 2024

v2.0.1

Published on 26 Jun 2023

nestjs-sqs 2.0.0

v2.0.0

Published on 27 Apr 2023

View all 4 releases

Developer

ssut

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=18.0.0

Typescript Support

Yes

Node Version

20.15.0

NPM Version

10.7.0 Statistics

215 Stars

58 Commits

53 Forks

9 Watching

1 Branches

16 Contributors

Updated on 27 Nov 2024

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

5,989,018

Last day

9.1%

16,077

Compared to previous day

Last week

7.6%

82,509

Compared to previous week

Last month

12.2%

332,286

Compared to previous month

Last year

64.9%

3,025,123

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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

1npm i --save @ssut/nestjs-sqs @aws-sdk/client-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.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.2

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@ssut/nestjs-sqs

Installations

Pull Requests

2

23

4

17

Issues

32

64

32

Releases

Developer

ssut

Developer Guide

CommonJS

>=18.0.0

Yes

20.15.0

10.7.0

Statistics

Languages

Total Downloads

5,989,018

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

nestjs-sqs

Installation

Quick Start

Register module

Decorate methods

Produce messages

Configuration

License

10

10

10

4

4

0

0

0

0

0

0

0

0

3.2

/10