A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.
\n
\n\n\n\n\n\n\n\n\n \n \n
\n \n\n## Description\n\nThis module contains integrated healthchecks for [Nest](https://github.com/nestjs/nest). These healthchecks run in an internal execution manager based on the [Terminus](https://github.com/godaddy/terminus)-package.\n\n## Installation\n\nIn order to install `@nestjs/terminus` you must install `@godaddy/terminus` - the library which will be used\nto execute the healthchecks.\n\n`@nestjs/terminus` integrates with a lot of cool technologies, such as `typeorm`, `grpc`, `mongodb`, and many more!\nIn most cases you do not want to install all the optional dependencies which would be needed for these integrations.\nTherefore we highly recommend to use the `--no-optional` option. In case you have missed a dependency, `@nestjs/terminus`\nwill throw an error and prompt you to install the required dependency. So you will only install what is actually required!\n\n```bash\n\nnpm install --save @nestjs/terminus @godaddy/terminus --no-optional\n\n```\n\n## Usage\n\nImport the Terminus module with the following options for a healthcheck with a **database** health inidcator.\n\n```typescript\n\nconst getTerminusOptions = (\n db: TypeOrmHealthIndicator,\n): TerminusModuleOptions => ({\n endpoints: [\n {\n // The health check will be available with /health\n url: '/health',\n // All the indicator which will be checked when requesting /health\n healthIndicators: [\n // Set the timeout for a response to 300ms\n async () => db.pingCheck('database', { timeout: 300 })\n ],\n },\n ],\n});\n\n@Module({\n imports:[\n // Make sure TypeOrmModule is available in the module context\n TypeOrmModule.forRoot({ ... }),\n TerminusModule.forRootAsync({\n // Inject the TypeOrmHealthIndicator provided by nestjs/terminus\n inject: [TypeOrmHealthIndicator],\n useFactory: db => getTerminusOptions(db),\n }),\n ],\n})\nexport class HealthModule { }\n\n```\n\nIf everything is set up correctly, you can access the healthcheck on `http://localhost:3000/health`.\n\n```json\n\n{\n \"status\": \"ok\",\n \"info\": {\n \"database\": {\n \"status\": \"up\"\n }\n }\n}\n \n```\n\nFor more information, [see docs](https://docs.nestjs.com/recipes/terminus) or [internal documentation](https://nestjs.github.io/terminus/). You can find further samples in the [samples/](https://github.com/nestjs/terminus/tree/master/sample) folder of this repository.\n\n## Support\n\nNest 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](https://docs.nestjs.com/support).\n\n## Stay in touch\n\n* Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) and [Livio Brunner](https://brunnerliv.io)\n* Website - [https://nestjs.com](https://nestjs.com/)\n* Twitter - [@nestframework](https://twitter.com/nestframework)\n\n## License\n\nNest is [MIT licensed](LICENSE).\n","readmeFilename":"README.md","homepage":"https://github.com/nestjs/terminus#readme","repository":{"url":"git+https://github.com/nestjs/terminus.git"},"bugs":{"url":"https://github.com/nestjs/terminus/issues"}}
![\"Nest](\"https://nestjs.com/img/logo_text.svg\"){kind=logo}
\n![\"NPM](\"https://img.shields.io/npm/v/@nestjs/terminus.svg\")
\n![\"Package](\"https://img.shields.io/npm/l/@nestjs/terminus.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/@nestjs/terminus.svg\")
\n![\"Travis\"](\"https://api.travis-ci.org/nestjs/terminus.svg?branch=master\")
\n![\"Linux\"](\"https://img.shields.io/travis/nestjs/terminus/master.svg?label=linux\")
\n![\"Discord\"/](\"https://img.shields.io/badge/discord-online-brightgreen.svg\"){kind=icon}
\n![\"Backers](\"https://opencollective.com/nest/backers/badge.svg\"){kind=icon}
\n![\"Sponsors](\"https://opencollective.com/nest/sponsors/badge.svg\"){kind=icon}
\n ![](\"https://img.shields.io/badge/Donate-PayPal-dc3d53.svg\"/){kind=icon}
\n ![](\"https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow\")
\n