Gathering detailed insights and metrics for @maxrakkar/nestjs-sqs
Gathering detailed insights and metrics for @maxrakkar/nestjs-sqs
A project to make SQS easier to use within NestJS, with decorator-based handling and seamless NestJS-way integration.
Installations
npm install @maxrakkar/nestjs-sqsDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
>=14.0.0
Node Version
18.14.0
NPM Version
9.3.1
Releases
5
Languages
1
TypeScript
TypeScript (100%)
Developer
ssut
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
243 Stars
60 Commits
57 Forks
9 Watchers
1 Branches
17 Contributors
Updated on Jul 10, 2025
Maintainers
1
Package Meta Information
Latest Version
1.3.0-awsv3-3
Package Id
@maxrakkar/nestjs-sqs@1.3.0-awsv3-3
Unpacked Size
23.65 kB
Size
6.85 kB
File Count
15
NPM Version
9.3.1
Node Version
18.14.0
Published on
Mar 21, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
2
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:
1@Injectable() 2export class AppMessageHandler { 3 @SqsMessageHandler(/** name: */ 'queueName', /** batch: */ false) 4 public async handleMessage(message: AWS.SQS.Message) { 5 } 6 7 @SqsConsumerEventHandler(/** name: */ 'queueName', /** eventName: */ 'processing_error') 8 public onProcessingError(error: Error, message: AWS.SQS.Message) { 9 // report errors here 10 } 11}
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.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 13/30 approved changesets -- score normalized to 4
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/ssut/nestjs-sqs/publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/ssut/nestjs-sqs/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/ssut/nestjs-sqs/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/ssut/nestjs-sqs/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/ssut/nestjs-sqs/publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/ssut/nestjs-sqs/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/ssut/nestjs-sqs/test.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/ssut/nestjs-sqs/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/ssut/nestjs-sqs/test.yml/master?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'packages' permission set to 'write': .github/workflows/publish.yml:55
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish.yml:53
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 14 are checked with a SAST tool
Reason
16 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-cj7v-w2c7-cp7c
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
- Warn: Project is vulnerable to: GHSA-9crc-q9x8-hgqq
Score
2.9
/10
Last Scanned on 2025-06-30
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