{"_id":"@0th/terminus","_rev":"1-bdee7bd7a60680361f310f8331426dc3","name":"@0th/terminus","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@0th/terminus","version":"1.0.0","description":"Nest - modern, fast, powerful node.js web framework (@terminus)","repository":{"type":"git","url":"git+https://github.com/nestjs/terminus.git"},"license":"MIT","author":{"name":"Livio Brunner"},"main":"dist/index.js","scripts":{"build":"gulp","build:all":"gulp build:all","clean":"gulp clean","lint":"eslint \"lib/**/*.ts\" --fix","precommit":"lint-staged","prepublish":"npm run build","prepublish:next":"npm run build","publish:next":"npm publish --access public --tag next","prepublish:npm":"npm run build","publish:npm":"npm publish --access public","test":"npm run test:ut","test:e2e":"jest --config=e2e/jest-e2e.json --detectOpenHandles --forceExit","test:ut":"jest --config=jest.json --detectOpenHandles","test:ut:cov":"npm run test:ut -- --coverage","release":"release-it"},"lint-staged":{"*.ts":["prettier --write"]},"dependencies":{"check-disk-space":"2.1.0","deprecate":"^1.1.1"},"devDependencies":{"@commitlint/cli":"12.0.1","@commitlint/config-angular":"12.0.1","@compodoc/compodoc":"1.1.11","@godaddy/terminus":"4.6.0","@grpc/proto-loader":"0.5.6","@nestjs/common":"7.6.13","@nestjs/core":"7.6.13","@nestjs/microservices":"7.6.13","@nestjs/mongoose":"7.0.2","@nestjs/platform-express":"7.6.13","@nestjs/platform-fastify":"7.6.13","@nestjs/sequelize":"0.2.0","@nestjs/swagger":"4.8.0","@nestjs/testing":"7.6.13","@nestjs/typeorm":"7.1.5","@release-it/conventional-changelog":"2.0.1","@types/deprecate":"1.1.0","@types/express":"4.17.9","@types/jest":"26.0.21","@types/mongoose":"5.7.36","@types/node":"14.14.35","@types/sequelize":"4.28.9","@typescript-eslint/eslint-plugin":"4.19.0","@typescript-eslint/parser":"4.19.0","amqp-connection-manager":"3.2.2","amqplib":"0.7.1","eslint":"7.22.0","eslint-config-prettier":"8.1.0","eslint-plugin-import":"2.22.1","fastify":"3.13.0","fastify-formbody":"5.0.0","grpc":"1.24.5","gulp":"4.0.2","gulp-clean":"0.4.0","gulp-debug":"4.0.0","gulp-typescript":"5.0.1","husky":"5.2.0","jest":"26.6.3","lint-staged":"10.5.4","mongoose":"5.10.9","mysql":"2.18.1","mysql2":"2.2.5","nats":"2.0.0","portfinder":"1.0.28","prettier":"2.2.1","redis":"3.0.2","reflect-metadata":"0.1.13","release-it":"14.5.0","rxjs":"6.6.6","rxjs-compat":"6.6.6","sequelize":"5.22.3","sequelize-typescript":"1.1.0","sort-package-json":"1.49.0","supertest":"6.1.3","ts-jest":"26.5.4","ts-node":"9.1.1","typeorm":"0.2.31","typescript":"4.0.3"},"peerDependencies":{"@nestjs/common":"^7.0.0","@nestjs/core":"^7.0.0","reflect-metadata":"^0.1.13","rxjs":"^6.5.4"},"husky":{"hooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -c .commitlintrc.json -E HUSKY_GIT_PARAMS"}},"gitHead":"f5ee2c2c2a8e399c188d302487eb32bc43499581","bugs":{"url":"https://github.com/nestjs/terminus/issues"},"homepage":"https://github.com/nestjs/terminus#readme","_id":"@0th/terminus@1.0.0","_nodeVersion":"14.16.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-GlROQBITME/JAsQEQW8Cudy+2Toic2CbyWqWIb84PIwkY2Jko4TpG6QNBDdGQkGq6oIfhim9YhOX7IFGapJimw==","shasum":"bb2304842a3afb89a94164cec990b614573b84bf","tarball":"https://registry.npmjs.org/@0th/terminus/-/terminus-1.0.0.tgz","fileCount":106,"unpackedSize":193477,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgWbnmCRA9TVsSAnZWagAAAn0QAIGBgJpymxm6XOUh1XFw\nb8klHvfmX8PTVgtIiUnDz1R9+DmjesuOl1LOHdF0bUEDagT/xGm5EJPnaEzQ\nqEQYdYPGobT1yp7NNUsKY0tfXTgHyTuBGK8hfSlR/vRmvXfqcnj8/zPdHmn5\nIILvseRyoV9NgX+o4MTCebYj2AQdl4eQ/OTm/NqEZWrayKpmcA8mGxNZEvJd\n4IeJiCRL7FnRAjpVVDNJ8fPdMYbqDeXn9XR6zMeAE0MvrdIrr4eSqDT6dSsF\n71nP9bYBFxMfl7cZ6yAQTcKrwOGzBzUwN1jzSPIv7FJvh/ybDWun6nQMiHAT\ncLToWX6ZWTWULP+AByukVIecIg7/CGiU9YwYXnjaf90A3yWDJyUiKUC7TUIb\nJLGRKPSFzGcUW4w2CUUcbTjQcNEgFzCgxXQ8LLRsVOu9Uc6HZZk3PTa/kGLi\nG3OxvtobCB/PhQv+f+LCIeLIU6h+wopm+fUqBy6zrfaQmWn5+rTuRoMxdoQx\n/L88NKGVFRbJ+6h+gernlQumemVk4PSp1HFAKFGGfBnKhCTIGp/UC44WgI7d\nWXmo//CeuxbFaGBfcBOOztclC16UG68zdKdhx0CZnvjwEf/pCiM+MNozOuQN\nznSTntWIS0dg5oV5xTeeqmmXfugwJsrhveDmll7FnUSbUjrGQgeLJXwn9XpJ\nd+PM\r\n=QsWl\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA3SxaZkcBjCkiPUV3vVTGHdgECh1nPxx7pT4/e+fKMdAiEA2wFF/OHOBFENqeYMNf3CDmFm4MuGfQ3GCa7GTQTWVZw="}]},"_npmUser":{"name":"abt0","email":"timur.abdumuminov@gmail.com"},"directories":{},"maintainers":[{"name":"abt0","email":"timur.abdumuminov@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminus_1.0.0_1616493029565_0.7054267748402183"},"_hasShrinkwrap":false}},"time":{"created":"2021-03-23T09:50:29.333Z","1.0.0":"2021-03-23T09:50:29.748Z","modified":"2022-04-04T10:26:15.381Z"},"maintainers":[{"name":"abt0","email":"timur.abdumuminov@gmail.com"}],"description":"Nest - modern, fast, powerful node.js web framework (@terminus)","homepage":"https://github.com/nestjs/terminus#readme","repository":{"type":"git","url":"git+https://github.com/nestjs/terminus.git"},"author":{"name":"Livio Brunner"},"bugs":{"url":"https://github.com/nestjs/terminus/issues"},"license":"MIT","readme":"

\n \"Nest\n

\n\n

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

\n

\n\"NPM\n\"Package\n\"NPM\n\"Discord\"/\n\"Backers\n\"Sponsors\n \n \n

\n \n\n## Description\n\nThis module contains integrated healthchecks for [Nest](https://github.com/nestjs/nest).\n\n## Installation\n\n`@nestjs/terminus` integrates with a lot of cool technologies, such as `typeorm`, `grpc`, `mongodb`, and many more!\nIn case you have missed a dependency, `@nestjs/terminus` will throw an error and prompt you to install the required dependency.\nSo you will only install what is actually required!\n\n```bash\n\nnpm install --save @nestjs/terminus\n\n```\n\n## Usage\n\n1. Import the Terminus module\n2. Make sure the additionally needed modules are available to (e.g. `TypeOrmModule`), in case you want to do Database Health Checks.\n\n```typescript\n// app.module.ts\n\n@Module({\n controllers: [HealthController],\n imports:[\n // Make sure TypeOrmModule is available in the module context\n TypeOrmModule.forRoot({ ... }),\n TerminusModule\n ],\n})\nexport class HealthModule { }\n\n```\n\n3. Setup your `HealthController` which executes your Health Check.\n\n```typescript\n// health.controller.ts\n\n@Controller('health')\nexport class HealthController {\n constructor(\n private health: HealthCheckService,\n private db: TypeOrmHealthIndicator,\n ) {}\n\n @Get()\n @HealthCheck()\n readiness() {\n return this.health.check([\n async () => this.db.pingCheck('database', { timeout: 300 }),\n ]);\n }\n}\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 \"details\": {\n \"database\": {\n \"status\": \"up\"\n }\n }\n}\n \n```\n\nFor more information, [see docs](https://docs.nestjs.com/recipes/terminus).\nYou can find more 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"}