@kronos-integration/service-health/README.md

collects and reports system health status

[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)
[![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/service-health.svg?style=flat-square)](https://github.com/Kronos-Integration/service-health/issues)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FKronos-Integration%2Fservice-health%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/Kronos-Integration/service-health/goto)
[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Known Vulnerabilities](https://snyk.io/test/github/Kronos-Integration/service-health/badge.svg)](https://snyk.io/test/github/Kronos-Integration/service-health)
[![Coverage Status](https://coveralls.io/repos/Kronos-Integration/service-health/badge.svg)](https://coveralls.io/github/Kronos-Integration/service-health)

# @kronos-integration/service-health

collects and reports system health status

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

*   [ServiceHealth](#servicehealth)
    *   [autostart](#autostart)
    *   [isHealthy](#ishealthy)
    *   [name](#name)

## ServiceHealth

**Extends Service**

Collects health state form all components
Currently we only check that there is no service is in failed state

### autostart

Start immediate

Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true

### isHealthy

Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if there are no failed services

### name

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'health'

# install

With [npm](http://npmjs.org) do:

```shell
npm install @kronos-integration/service-health
```

# license

BSD-2-Clause