Request: Update dependencies to support for NestJS 11 libraries

[zackdotcomputer]

Is there an existing issue that is already proposing this?

• I have searched the existing issues

Is your feature request related to a problem? Please describe it

Currently, running the instructions for Setting up a Healthcheck on the NestJS homepage breaks because this library doesn't allow version 11 as a peer dependency.

Describe the solution you'd like

Package.json updated to include v11 support, and a v11.0.0 published of this library

Teachability, documentation, adoption, migration strategy

This will bring the documentation back into an accurate and implementable state

What is the motivation / use case for changing the behavior?

Desire to keep using this library going forward

[BrunnerLivio]

I planned to upgrade @nestjs/terminus latest this weekend. Keeping you posted!

[tejastn10]

Thanks a lot 🙇

[kessiler]

I'm also interested on this 👍

[BrunnerLivio]

Beta is available! 🎉

Feel free to try it out

# npm
npm install @nestjs/terminus@beta
# pnpm
pnpm add @nestjs/termminus@beta
# yarn
yarn add @nestjs/terminus@beta

For most users, no migration path is needed.

---

For users who have implemented a custom health indicator, an enhanced API is now available. However, the existing API will continue to function as-is without requiring any changes.

The new and improved HealthIndicatorService provides a streamlined way to indicate whether a health indicator is up or down.

Warning

Please note that the HealthIndicator and HealthCheckError classes have been marked as deprecated and are scheduled for removal in the next major release, version 12.0.0.

@Injectable()
export class DogHealthIndicator {
  constructor(
    private readonly dogService: DogService,
    private readonly healthIndicatorService: HealthIndicatorService,
  ) {}

  async isHealthy(key: string) {
    const indicator = this.healthIndicatorService.check(key);

    const dogs = await this.dogService.getDogs();
    const badboys = dogs.filter((dog) => dog.state === DogState.BAD_BOY);
    const isHealthy = badboys.length === 0;

    if (!isHealthy) {
      return indicator.down({
        badboys: badboys.length,
      });
    }

    return indicator.up();
  }
}

Further samples using the new HealthIndicatorService can be found in samples/000-dogs-app or the provided health indicators by Terminus

---

Please let me know if you have any doubts or questions regarding the upgrade. It should be seamless!

[moussa-b]

I've just tested with these values for the version of NestJS, works without issue

{
  "dependencies": {
    "@nestjs/common": "^11.0.5",
    "@nestjs/config": "^4.0.0",
    "@nestjs/core": "^11.0.5",
    "@nestjs/jwt": "^11.0.0",
    "@nestjs/mapped-types": "^2.1.0",
    "@nestjs/passport": "^11.0.5",
    "@nestjs/platform-express": "^11.0.5",
    "@nestjs/swagger": "^11.0.3",
    "@nestjs/terminus": "^11.0.0-beta.0",
    "@nestjs/throttler": "^6.4.0"
  }
}