@loopback/docs

--- lang: en title: 'API docs: health' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/health permalink: /doc/en/lb4/apidocs.health.html ---  [Home](./index.md) > [@loopback/health](./health.md) ## health package A component to report health status using [@cloudnative/health](https://github.com/CloudNativeJS/cloud-health). ## Classes <table><thead><tr><th> Class </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [HealthComponent](./health.healthcomponent.md) </td><td markdown="1"> A component providing health status </td></tr> </tbody></table> ## Namespaces <table><thead><tr><th> Namespace </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [HealthBindings](./health.healthbindings.md) </td><td markdown="1"> Binding keys used by this component. </td></tr> <tr><td markdown="1"> [HealthTags](./health.healthtags.md) </td><td markdown="1"> Binding tags for health related services </td></tr> </tbody></table> ## Variables <table><thead><tr><th> Variable </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [DEFAULT\_HEALTH\_OPTIONS](./health.default_health_options.md) </td><td markdown="1"> </td></tr> </tbody></table> ## Type Aliases <table><thead><tr><th> Type Alias </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [HealthConfig](./health.healthconfig.md) </td><td markdown="1"> Configuration for health component with optional properties </td></tr> <tr><td markdown="1"> [HealthOptions](./health.healthoptions.md) </td><td markdown="1"> Options for health component </td></tr> <tr><td markdown="1"> [LiveCheck](./health.livecheck.md) </td><td markdown="1"> Functions for liveness check </td></tr> <tr><td markdown="1"> [ReadyCheck](./health.readycheck.md) </td><td markdown="1"> Functions for readiness check </td></tr> </tbody></table>