# apihealthcheck

> API Health check

Latest version **1.0.0** (published 2017-04-17) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-04-17 |
| First published | 2017-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Sabeur Thabti |
| Maintainers | sabeurthabti |
| Keywords | health, healtcheck, express, status, json, ping, status page |

## Links

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

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^2.6.3
- [node-fetch](https://npm.io/package/node-fetch.md) ^1.6.3
- [with-query](https://npm.io/package/with-query.md) ^1.0.2

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-04-17
- 0.0.3 — 2017-03-27
- 0.0.2 — 2017-03-27

## README

# API Health Check
Simple and highly customisable JSON health check builder.

``` javascript
  npm install apihealthcheck --save
```

``` javascript
  yarn add apihealthcheck
```

# Teams using this package:

``` javascript
var status = require('apihealthcheck');

var results = status({
  "name": "some-app",
  "checks": [
    {
      "name": "Yahoo",
      "url" : "http://yahoo.com"
    },
    {
      "name": "Google",
      "url" : "http://google.com"
    }
  ]

}).then( function(data) {
  // {JSON data}
});

```

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