# admin-plugin-healthcheck

> Plugin adds a healthcheck endpoint to the admin interface

Latest version **1.1.0** (published 2017-05-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install admin-plugin-healthcheck
pnpm add admin-plugin-healthcheck
yarn add admin-plugin-healthcheck
bun add admin-plugin-healthcheck
```

## 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.1.0 |
| Published | 2017-05-01 |
| First published | 2017-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Ben Ripkens |
| Maintainers | bripkens |
| Keywords | admin, admin-plugin, healthcheck |

## Links

- npm: https://www.npmjs.com/package/admin-plugin-healthcheck
- Repository: https://github.com/bripkens/admin
- Homepage: https://github.com/bripkens/admin#readme
- Issues: https://github.com/bripkens/admin/issues
- npm.io page: https://npm.io/package/admin-plugin-healthcheck

## Dependencies (1)

- [bluebird](https://npm.io/package/bluebird.md) ^3.5.0

## Recent versions

- 1.1.0 (latest) — 2017-05-01
- 1.0.0 — 2017-03-07

## README

# admin-plugin-healthcheck   [![Node.js admin plugin system](https://img.shields.io/badge/plugin-admin-brightgreen.svg)](https://github.com/bripkens/admin) [![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg)](https://github.com/Flet/semistandard)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Contents

- [Installation](#installation)
- [Usage](#usage)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Installation

```
npm install --save admin-plugin-healthcheck
```

## Usage

```javascript
admin.configure({
  plugins: [
    require('admin-plugin-healthcheck')({
      checks: {
        random() {
          const v = Math.random();
          if (v > 0.8) {
            throw new Error('Random value >0.8');
          } else if (v > 0.3) {
            return "Healthy like an application that isn't used.";
          } else {
            return Promise.reject('Something bad happened here…');
          }
        }
      }
    })
  ]
});
```

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