npmpackage.info

Gathering detailed insights and metrics for @pickk/nest-sqs

Other packages similar to @pickk/nest-sqs

@pickk/nestjs-sqs

1.0.3

Gathering detailed insights and metrics for @pickk/nest-sqs

@pickk/nest-sqs - 2.0.7 | npmpackage.info

@pickk/nest-sqs

(Deprecated) now using @pickk/nestjs-sqs

2.0.7

MIT

TypeScript

25.04 kB

1.7

Installations

npm install @pickk/nest-sqs

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

14.17.1

NPM Version

6.14.13 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

TypeScript

JavaScript

Shell

TypeScript (88.54%)

JavaScript (7.5%)

Shell (3.95%)

Developer

ybh1760

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

54 Commits

1 Branches

3 Contributors

Updated on Jan 28, 2023

Maintainers

View All 3 Contributors

Package Meta Information

Latest Version

2.0.7

Package Id

@pickk/nest-sqs@2.0.7

Unpacked Size

25.04 kB

Size

7.30 kB

File Count

NPM Version

6.14.13

Node Version

14.17.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

@pickk/nest-sqs

@pickk/nest-sqs is forked version of @ssut/nestjs-sqs

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. this library is only for Amazon SQS.

Installation

1$ npm i --save @pickk/nest-sqs

Quick Start

Register module

For use @pickk/nest-sqs You have to perform two methods to register a module. First you have to register Amazon SQS config options.

1@Module({
2  imports: [
3    SqsModule.forRootAsync({
4      imports:[ConfigModule],
5      useFactory:(configService)=>{
6        // return SQS.Types.ClientConfiguration & accountNumber(string type)
7        return {...}
8      },
9      injects:[ConfigSerivce]
10    }),
11  ],
12})
13class AppModule {}

Second you have to register queues.

1SqsModule.registerQueues([
2  {
3    name: 'queueName',
4    type: 'ALL' // 'ALL'|'CONSUMER'|'PRODUCER'
5    consumerOptions?: {},
6    producerOptions?: {}
7  },
8  ...
9]);

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@SqsProcess(/** name: */'queueName)
2export class AppMessageHandler {
3  @SqsMessageHandler(/** batch: */ false)
4  public async handleMessage(message: AWS.SQS.Message) {}
5
6  @SqsConsumerEventHandler(/** eventName: */ SqsConsumerEvent.PROCESSING_ERROR)
7  public onProcessingError(error: Error, message: AWS.SQS.Message) {
8    // report errors here
9  }
10}

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

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

License

Determines if the project has defined a license.

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

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

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/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

Other packages similar to @pickk/nest-sqs

@pickk/nest-sqs

Installations

Developer Guide

Yes

CommonJS

14.17.1

6.14.13

Pull Requests

0

0

0

Issues

0

0

0

Releases

Unable to fetch releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

@pickk/nest-sqs

Installation

Quick Start

Register module

Decorate methods

Produce messages

Configuration

License

10

10

0

0

0

0

0

0

0

0

1.7

/10

Other packages similar to @pickk/nest-sqs