Gathering detailed insights and metrics for nestjs-asyncapi
Gathering detailed insights and metrics for nestjs-asyncapi
NestJS AsyncAPI module - generate documentation of your event-based services using decorators
Installations
npm install nestjs-asyncapiDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
20.13.1
NPM Version
10.5.2
Releases
26
Languages
3
TypeScript
JavaScript
Shell
TypeScript (98.45%)
JavaScript (1.36%)
Shell (0.19%)
Developer
flamewow
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
215 Stars
970 Commits
37 Forks
3 Watchers
33 Branches
5 Contributors
Updated on Jul 13, 2025
Maintainers
1
Package Meta Information
Latest Version
1.4.0
Package Id
nestjs-asyncapi@1.4.0
Unpacked Size
1.63 MB
Size
355.20 kB
File Count
260
NPM Version
10.5.2
Node Version
20.13.1
Published on
Mar 09, 2025
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
4
Dev Dependencies
33
@nestjs/cli@nestjs/microservices@nestjs/platform-express@nestjs/platform-fastify@nestjs/platform-socket.io@nestjs/schematics@nestjs/testing@nestjs/websockets@types/express@types/jest@types/js-yaml@types/node@types/supertest@types/url-join@typescript-eslint/eslint-plugin@typescript-eslint/parsereslinteslint-config-prettiereslint-plugin-importeslint-plugin-prettierhuskyjestlint-stagedprettierrelease-itsocket.iosocket.io-clientsupertestts-jestts-loaderts-nodetsconfig-pathstypescript
Description
Generate AsyncApi documentation (for event-based services, like websockets) in a similar to nestjs/swagger fashion.
Live Preview
Installation
full installation (with chromium)
1$ npm i --save nestjs-asyncapi
nestjs-async api package doesn't require chromium (which is required by asyncapi lib), so u can skip chromium installation by setting PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true environment variable.
1$ PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true npm i --save nestjs-asyncapi
Quick Start
Include AsyncApi initialization into your bootstrap function.
1async function bootstrap() { 2 const app = await NestFactory.create<NestExpressApplication>(AppModule); 3 4 const asyncApiOptions = new AsyncApiDocumentBuilder() 5 .setTitle('Feline') 6 .setDescription('Feline server description here') 7 .setVersion('1.0') 8 .setDefaultContentType('application/json') 9 .addSecurity('user-password', {type: 'userPassword'}) 10 .addServer('feline-ws', { 11 url: 'ws://localhost:3000', 12 protocol: 'socket.io', 13 }) 14 .build(); 15 16 const asyncapiDocument = await AsyncApiModule.createDocument(app, asyncApiOptions); 17 await AsyncApiModule.setup(docRelPath, app, asyncapiDocument); 18 19 // other bootstrap procedures here 20 21 return app.listen(3000); 22}
AsyncApi module explores Controllers & WebSocketGateway by default.
In most cases you won't need to add extra annotation,
but if you need to define asyncApi operations in a class that's not a controller or gateway use the AsyncApi class
decorator.
Mark pub/sub methods via AsyncApiPub or AsyncApiSub decorators
1class CreateFelineDto { 2 @ApiProperty() 3 demo: string; 4} 5 6@Controller() 7class DemoController { 8 @AsyncApiPub({ 9 channel: 'create/feline', 10 message: { 11 payload: CreateFelineDto 12 }, 13 }) 14 async createFeline() { 15 // logic here 16 } 17 18 @AsyncApiSub({ 19 channel: 'create/feline', 20 message: { 21 payload: CreateFelineDto 22 }, 23 }) 24 async createFeline() { 25 // logic here 26 } 27} 28
For more detailed examples please check out https://github.com/flamewow/nestjs-asyncapi/tree/main/sample sample app.
Do you use this library and like it? Don't be shy to give it a star on github ★
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
dependency not pinned by hash detected -- score normalized to 2
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/base.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/flamewow/nestjs-asyncapi/base.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/base.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/flamewow/nestjs-asyncapi/base.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/base.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/flamewow/nestjs-asyncapi/base.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/base.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/flamewow/nestjs-asyncapi/base.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/code-quality.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/flamewow/nestjs-asyncapi/code-quality.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/code-quality.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/flamewow/nestjs-asyncapi/code-quality.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/first-interaction.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/flamewow/nestjs-asyncapi/first-interaction.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/first-interaction.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/flamewow/nestjs-asyncapi/first-interaction.yaml/main?enable=pin
- Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
- Info: 3 out of 3 npmCommand dependencies pinned
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/base.yml:1
- Warn: no topLevel permission defined: .github/workflows/code-quality.yml:1
- Warn: no topLevel permission defined: .github/workflows/first-interaction.yaml:1
- Info: no jobLevel write permissions found
Reason
Found 0/4 approved changesets -- score normalized to 0
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 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 29 are checked with a SAST tool
Reason
19 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-cj7v-w2c7-cp7c
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-vhxf-7vqr-mrjg
- Warn: Project is vulnerable to: GHSA-mg2h-6x62-wpwc
- Warn: Project is vulnerable to: GHSA-75v8-2h7p-7m2m
- Warn: Project is vulnerable to: GHSA-pppg-cpfq-h7wr
- Warn: Project is vulnerable to: GHSA-hw8r-x6gr-5gjp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-44fp-w29j-9vj5
- Warn: Project is vulnerable to: GHSA-4pg4-qvpc-4q3h
- Warn: Project is vulnerable to: GHSA-g5hg-p3ph-g8qg
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx
- Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
2.6
/10
Last Scanned on 2025-07-07
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