npmpackage.info

Gathering detailed insights and metrics for @nestjs/terminus

Other packages similar to @nestjs/terminus

@nestjs-mod/terminus

1.13.3

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

@goodandco/nest-health

2.0.2

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

@godaddy/terminus

4.12.1

[![Join Slack](https://img.shields.io/badge/Join%20us%20on-Slack-e01563.svg)](https://godaddy-oss.slack.com/) [![Build Status](https://github.com/godaddy/terminus/actions/workflows/cicd.yml/badge.svg)](https://github.com/godaddy/terminus/actions/workflows

@goopen/nestjs-ioredis-provider

1.1.1

Tiny NestJS provider for ioredis

Gathering detailed insights and metrics for @nestjs/terminus

@nestjs/terminus

Terminus module for Nest framework (node.js) 🤖

10.2.3

679

MIT

TypeScript

23.71 kB

80,665,451 2.6

Installations

npm install @nestjs/terminus

Pull Requests

Open

26

Total

2,439

Closed

217

Merged

2,196

Issues

Open

10

Total

125

Closed

115

Releases

Release 10.2.3

10.2.3

Published on 18 Feb 2024

Release 10.2.2

10.2.2

Published on 07 Feb 2024

Release 10.2.2-beta.0

10.2.2-beta.0

Published on 31 Jan 2024

Release 10.2.1

10.2.1

Published on 26 Jan 2024

Release 10.2.0

10.2.0

Published on 27 Nov 2023

Release 10.2.0-beta.0

10.2.0-beta.0

Published on 27 Nov 2023

View all 65 releases

Developer

nestjs

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

16.20.2

NPM Version

8.19.4 Statistics

679 Stars

3,537 Commits

99 Forks

8 Watching

34 Branches

43 Contributors

Updated on 24 Nov 2024

Bundle Size

92.39 kB

Minified

23.71 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (99.51%)

JavaScript (0.4%)

Shell (0.1%)

Total Downloads

Cumulative downloads

Total Downloads

80,665,451

Last day

2.6%

167,607

Compared to previous day

Last week

3.7%

842,489

Compared to previous week

Last month

15.3%

3,469,777

Compared to previous month

Last year

27.1%

33,830,208

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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

1npm install
2
3# To rebuild the project, run
4npm run build

Test

For unit testing run the following command:

1npm run test

For e2e testing, make sure you have docker installed

1docker-compose up -d
2npm run 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

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

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 2

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: GitHub-owned 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:23: 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: GitHub-owned 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:24: 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:11: 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:13: 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:19: 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:11: 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:13: 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:19: 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: GitHub-owned 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:23: update your workflow using https://app.stepsecurity.io/secureworkflow/nestjs/terminus/unit-test.yml/master?enable=pin
Info: 0 out of 15 GitHub-owned GitHubAction dependencies pinned
Info: 5 out of 5 npmCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

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

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.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2024-11-18

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

Pull Requests

26

2,439

217

2,196

Issues

10

125

115

Releases

Developer

Developer Guide

CommonJS

Yes

16.20.2

8.19.4

Statistics

Bundle Size

92.39 kB

23.71 kB

Languages

Total Downloads

80,665,451

Daily Downloads

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

2

0

0

0

0

0

0

0

0

0

2.6

/10