@loopback/docs/site/apidocs/health.md

Documentation files rendered at [https://loopback.io](https://loopback.io)

---
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
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/health](./health.md)

## health package

A component to report health status using [@cloudnative/health](https://github.com/CloudNativeJS/cloud-health)<!-- -->.

## Classes

|  Class | Description |
|  --- | --- |
|  [HealthComponent](./health.healthcomponent.md) | A component providing health status |

## Namespaces

|  Namespace | Description |
|  --- | --- |
|  [HealthBindings](./health.healthbindings.md) | Binding keys used by this component. |
|  [HealthTags](./health.healthtags.md) | Binding tags for health related services |

## Variables

|  Variable | Description |
|  --- | --- |
|  [DEFAULT\_HEALTH\_OPTIONS](./health.default_health_options.md) |  |

## Type Aliases

|  Type Alias | Description |
|  --- | --- |
|  [HealthConfig](./health.healthconfig.md) | Configuration for health component with optional properties |
|  [HealthOptions](./health.healthoptions.md) | Options for health component |
|  [LiveCheck](./health.livecheck.md) | Functions for liveness check |
|  [ReadyCheck](./health.readycheck.md) | Functions for readiness check |