# kuberhealthy

> javascript implementation of kuberhealthy Go client

Latest version **0.0.15** (published 2021-01-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install kuberhealthy
pnpm add kuberhealthy
yarn add kuberhealthy
bun add kuberhealthy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.15 |
| Published | 2021-01-18 |
| First published | 2020-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.4 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | gw0lf3 |

## Links

- npm: https://www.npmjs.com/package/kuberhealthy
- npm.io page: https://npm.io/package/kuberhealthy

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.21.1

## Recent versions

- 0.0.15 (latest) — 2021-01-18
- 0.0.13 — 2020-05-14
- 0.0.12 — 2020-05-13
- 0.0.11 — 2020-05-13
- 0.0.10 — 2020-05-13
- 0.0.9 — 2020-05-13
- 0.0.8 — 2020-05-13
- 0.0.7 — 2020-05-13
- 0.0.6 — 2020-05-13
- 0.0.5 — 2020-05-13
- 0.0.4 — 2020-05-13
- 0.0.3 — 2020-05-13
- 0.0.2 — 2020-05-13
- 0.0.1 — 2020-05-13

## README

## kuberhealthy-client 🩺 
[![npm version](https://badge.fury.io/js/kuberhealthy.svg)](https://badge.fury.io/js/kuberhealthy)

a simple, asynchronous javascript client for [kuberhealthy](https://github.com/Comcast/kuberhealthy) synthetic checks. 

#### install

```
npm i --save kuberhealthy
```

#### use:

```javascript
const kh = require('kuberhealthy')

// Report failure. Returns Promise.
kh.ReportFailure(['example failure message'])

// Report success. Returns Promise.
kh.ReportSuccess()

```

> _NOTE: KH_REPORTING_URL must be set in your env. This is usually done automatically if running as 'khcheck' on kubernetes._ 

#### example: 
```javascript
const report = async () => {
  try {
    await kh.ReportSuccess()
  } catch (e) {
    console.error(e)
    process.exit(1)
  }
  process.exit(0)
}

report()
```
---

#### credit:

- this client was inspired and based from [kuberhealthy client js](https://github.com/Comcast/kuberhealthy/blob/master/clients/js/README.md)

---
_Source: https://npm.io/package/kuberhealthy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._