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

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

---
lang: en
title: 'API docs: health.healthoptions'
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.healthoptions.html
---

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

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

## HealthOptions type

Options for health component

**Signature:**

```typescript
export type HealthOptions = {
    disabled?: boolean;
    healthPath: string;
    readyPath: string;
    livePath: string;
    openApiSpec?: boolean;
};
```