# healthchecks.io

> Ping a healthchecks.io endpoint on a schedule

Latest version **2.2.0** (published 2021-06-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install healthchecks.io
pnpm add healthchecks.io
yarn add healthchecks.io
bun add healthchecks.io
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.0 |
| Published | 2021-06-01 |
| First published | 2017-05-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 11.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Josh Wulf |
| Maintainers | sitapati |
| Keywords | healthchecks.io |

## Links

- npm: https://www.npmjs.com/package/healthchecks.io
- Repository: https://github.com/jwulf/healthchecks.io
- Homepage: https://github.com/jwulf/healthchecks.io#readme
- Issues: https://github.com/jwulf/healthchecks.io/issues
- npm.io page: https://npm.io/package/healthchecks.io

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^2.6.6
- [@types/node](https://npm.io/package/@types/node.md) ^8.10.59

## Recent versions

- 2.2.0 (latest) — 2021-06-01
- 2.1.1 — 2019-11-18
- 2.1.0 — 2019-11-17
- 2.0.0 — 2019-09-25
- 1.2.0 — 2019-07-13
- 1.1.4 — 2018-04-03
- 1.1.3 — 2018-04-03
- 1.1.2 — 2018-04-03
- 1.1.1 — 2018-03-31
- 1.1.0 — 2017-10-22
- 1.0.10 — 2017-06-07
- 1.0.9 — 2017-05-22
- 1.0.8 — 2017-05-12
- 1.0.7 — 2017-05-12
- 1.0.6 — 2017-05-11
- … 6 more at https://npm.io/package/healthchecks.io/versions

## README

# healthchecks.io

The legendary [healthchecks.io](https://healthchecks.io) npm module. 

**Literally the simplest way to monitor the availability of your JavaScript application - _for free!_**

Healthchecks.io is a free service that allows you to monitor the availability of your application. Receive notifications when your app goes down via email, Slack, Telegram message, or a number of other integrations.

This JavaScript modules allows you to ping a healthchecks.io endpoint on a schedule.

## To use

Install the package using `npm` or `yarn`:

```
# if you use npm

npm i -S healthchecks.io 
```
```
# if you use yarn

yarn add healthchecks.io 
```

Example usage:

```
import { healthcheck } from 'healthchecks.io'; // TypeScript
const healthcheck = require('healthcheck').healthcheck: // JavaScript

const url = 'https://hchk.io/f55d2579-8dc2-4149-83f4-263cabe334c0';

// Ping healthcheck endpoint every 15 minutes

const check = healthcheck(url, 15);

check.on('error', err => console.log('Error pinging healthcheck', err));

check.stop(); // can restart with check.start()
```

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