npmpackage.info

Gathering detailed insights and metrics for @nestjs/terminus

Other packages similar to @nestjs/terminus

@nestjs-mod/terminus

1.14.2

Terminus integration provides readiness/liveness health checks for NestJS-mod (Wrapper for https://www.npmjs.com/package/@nestjs/terminus)

@anchan828/nest-bull-terminus

3.2.23

The terminus of [Bull](https://github.com/OptimalBits/bull) module for [Nest](https://github.com/nestjs/nest).

@anchan828/nest-bullmq-terminus

3.2.23

The terminus of [BullMQ](https://github.com/taskforcesh/bullmq) module for [Nest](https://github.com/nestjs/nest).

@goodandco/nest-health

2.0.2

Health package based for NestJS app based on @nestjs/terminus package

Gathering detailed insights and metrics for @nestjs/terminus

@nestjs/terminus - 11.0.0 | npmpackage.info

@nestjs/terminus

Terminus module for Nest framework (node.js) 🤖

11.0.0

702

MIT

TypeScript

23.56 kB

100,654,634 3.6

Installations

npm install @nestjs/terminus

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.18.2

NPM Version

9.9.3 Score

67.9

Supply Chain

82.9

Quality

80.1

Maintenance

100

Vulnerability

96.7

License

Pull Requests

Open

13

Total

2,533

Closed

250

Merged

2,270

Issues

Open

9

Total

132

Closed

123

Releases

Release 11.0.0

11.0.0

Updated on Jan 25, 2025

Release 11.0.0-beta.1

11.0.0-beta.1

Updated on Jan 25, 2025

Release 11.0.0-beta.0

11.0.0-beta.0

Updated on Jan 23, 2025

Release 10.3.0

10.3.0

Updated on Jan 23, 2025

Release 10.2.3

10.2.3

Updated on Feb 18, 2024

Release 10.2.2

10.2.2

Updated on Feb 07, 2024

View All 69 releases

Languages

TypeScript

JavaScript

TypeScript (99.88%)

JavaScript (0.12%)

Developer

nestjs

Download Statistics

Total Downloads

100,654,634

Last Day

30,177

Last Week

966,036

Last Month

3,840,095

Last Year

40,271,606

GitHub Statistics

MIT License

702 Stars

3,674 Commits

103 Forks

7 Watchers

25 Branches

43 Contributors

Updated on May 05, 2025

Bundle Size

91.60 kB

Minified

23.56 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 43 Contributors

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

100,654,634

Last Day

11.2%

30,177

Compared to previous day

Last Week

12.9%

966,036

Compared to previous week

Last Month

-9%

3,840,095

Compared to previous month

Last Year

35.2%

40,271,606

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

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 HealthController which 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:dev within 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.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

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

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.

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

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

0

Token-Permissions

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

0

Pinned-Dependencies

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

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

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

SAST

Determines if the project uses static code analysis.

Score

3.6

/10

Last Scanned on 2025-05-05

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 @nestjs/terminus

Other packages similar to @nestjs/terminus

@nestjs/terminus

Installations

Developer Guide

Yes

CommonJS

20.18.2

9.9.3

Score

Pull Requests

13

2,533

250

2,270

Issues

9

132

123

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

91.60 kB

23.56 kB

Maintainers

Package Meta Information

Total Downloads

100,654,634

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Description

Installation

Usage

Contribute

Setup

Test

Support

Stay in touch

License

10

10

10

10

2

0

0

0

0

0

0

0

0

3.6

/10