healthz-module
v1.0.5
Published
NestJS health module based on Terminus
Downloads
9
Readme
Welcome to healthz-module 👋
NestJS health module based on Terminus
🏠 Homepage
Install
npm install healthz-module --save
Usage
Add to your module
next options:
HealthModule.register({
checkServices: {
mongodb: [
{
connectionName: '', // DB connection name
connectionUrl: '', // DB connection uri
},
{
connectionName: '', // DB connection name
connectionUrl: '' // DB connection uri
}
],
redis: [
{
connectionName: '', // Redis connection name
connectionUrl: '' // Redis connection uri
}
]
},
})
where checkServices
options is:
| Module options | Values | Required | |---|---|---| | mongodb | MongoDB options | no | | redis | Redis options | no |
After that health check
available on https://localhost/healthz
Run tests
npm run test
Author
👤 Yaroslav Kuznetsov [email protected]
🤝 Contributing
Contributions, issues and feature requests are welcome!Feel free to check issues page.
Show your support
Give a ⭐️ if this project helped you!
This README was generated with ❤️ by readme-md-generator