Gathering detailed insights and metrics for @nestjs/terminus
Gathering detailed insights and metrics for @nestjs/terminus
Installations
npm install @nestjs/terminusDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
20.18.2
NPM Version
9.9.3
Releases
69
Languages
2
TypeScript
JavaScript
TypeScript (99.88%)
JavaScript (0.12%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
711 Stars
3,674 Commits
104 Forks
7 Watchers
25 Branches
43 Contributors
Updated on Jul 16, 2025
Maintainers
3
Package Meta Information
Latest Version
11.0.0
Package Id
@nestjs/terminus@11.0.0
Unpacked Size
288.81 kB
Size
63.60 kB
File Count
177
NPM Version
9.9.3
Node Version
20.18.2
Published on
Jan 25, 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
Dependencies
2
Peer Dependencies
17
Dev Dependencies
66
@commitlint/cli@commitlint/config-angular@grpc/grpc-js@grpc/proto-loader@mikro-orm/core@mikro-orm/mongodb@mikro-orm/mysql@mikro-orm/nestjs@nestjs/axios@nestjs/cli@nestjs/common@nestjs/core@nestjs/microservices@nestjs/mongoose@nestjs/platform-express@nestjs/platform-fastify@nestjs/sequelize@nestjs/swagger@nestjs/testing@nestjs/typeorm@prisma/client@release-it/conventional-changelog@types/express@types/jest@types/node@types/supertest@typescript-eslint/eslint-plugin@typescript-eslint/parseramqp-connection-manageramqplibaxioscli-colorcopyfilesdelete-emptyeslinteslint-config-prettiereslint-import-resolver-typescripteslint-plugin-deprecationeslint-plugin-importeslint-plugin-jesteslint-plugin-unused-importsfastifyhuskyioredisjestkafkajslint-stagedmongoosemysql2natsportfinderprettierprismareflect-metadatarelease-itrolluprollup-plugin-dtsrxjs-compatsequelizesequelize-typescriptsupertestts-jestts-nodetypeormtypescriptwait-port
A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.
Description
This module contains integrated healthchecks for Nest.
Installation
@nestjs/terminus integrates with a lot of cool technologies, such as typeorm, grpc, mongodb, and many more!
In case you have missed a dependency, @nestjs/terminus will throw an error and prompt you to install the required dependency.
So you will only install what is actually required!
1 2npm install --save @nestjs/terminus 3
Usage
- Import the Terminus module
- Make sure the additionally needed modules are available to (e.g.
TypeOrmModule), in case you want to do Database Health Checks.
1// app.module.ts 2 3@Module({ 4 controllers: [HealthController], 5 imports:[ 6 // Make sure TypeOrmModule is available in the module context 7 TypeOrmModule.forRoot({ ... }), 8 TerminusModule 9 ], 10}) 11export class HealthModule { } 12
- Setup your
HealthControllerwhich executes your Health Check.
1// health.controller.ts 2 3@Controller('health') 4export class HealthController { 5 constructor( 6 private health: HealthCheckService, 7 private db: TypeOrmHealthIndicator, 8 ) {} 9 10 @Get() 11 @HealthCheck() 12 readiness() { 13 return this.health.check([ 14 async () => this.db.pingCheck('database', { timeout: 300 }), 15 ]); 16 } 17}
If everything is set up correctly, you can access the healthcheck on http://localhost:3000/health.
1{ 2 "status": "ok", 3 "info": { 4 "database": { 5 "status": "up" 6 } 7 }, 8 "details": { 9 "database": { 10 "status": "up" 11 } 12 } 13}
For more information, see docs. You can find more samples in the samples/ folder of this repository.
Contribute
In order to get started, first read through our Contributing guidelines.
Setup
Setup the development environment by following these instructions:
- Fork & Clone the repository
- Install the dependencies
1pnpm i 2pnpm dev
In order to test the library against a sample, simply go to a sample and run
pnpm start:dev
1cd sample/000-dogs-app 2pnpm start:dev
[!NOTE] Once the library is rebuilt, the
pnpm start:devwithin a sample needs to be restarted in order to pick up the changes.
Test
For unit testing run the following command:
1pnpm test
For e2e testing, a Docker Compose stack is required. Make sure Docker is installed on your machine and run the following command.
1docker compose up -d 2pnpm test:e2e
Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
Stay in touch
- Author - Kamil Myśliwiec and Livio Brunner
- Website - https://nestjs.com
- Twitter - @nestframework
License
Nest is MIT licensed.
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
4 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3
Reason
Found 0/14 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/build-samples.yml:1
- Warn: no topLevel permission defined: .github/workflows/e2e.yml:1
- Warn: no topLevel permission defined: .github/workflows/format.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint.yml:1
- Warn: no topLevel permission defined: .github/workflows/unit-test.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-samples.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/build-samples.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-samples.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/build-samples.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-samples.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/build-samples.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/e2e.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/e2e.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/e2e.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/e2e.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/format.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/format.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/format.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/format.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/format.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/format.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/lint.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/lint.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/lint.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/unit-test.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/unit-test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/unit-test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/unit-test.yml/master?enable=pin
- Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 5 third-party GitHubAction dependencies pinned
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 29 are checked with a SAST tool
Reason
13 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-x4c5-c7rf-jjgv
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-mg2h-6x62-wpwc
- Warn: Project is vulnerable to: GHSA-75v8-2h7p-7m2m
- 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-cxrh-j4jr-qwg3
Score
2.8
/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