@studiohyperdrive/express-status
v2.0.1
Published
Express status-page solution used at Studio Hyperdrive
Downloads
41
Readme
Express Status
Express status-page solution used at Studio Hyperdrive
Table of contents
Getting Started
Install the package
# NPM
npm install --save @studiohyperdrive/express-status
# Yarn
yarn add --save @studiohyperdrive/express-status
Usage
import { ExpressStatusRouter } from '@studiohyperdrive/express-status';
...
// Exposes '/status' in the router.
app.use(ExpressStatusRouter);
ExpressStatusRouter
An Express Router that exposes GET /status
.
Usage:
import { ExpressStatusRouter } from '@studiohyperdrive/express-status';
...
app.use(ExpressStatusRouter);
ExpressStatusController
The controller that takes care of handling the route callback. Using the controller gives you the flexibility of adding your own endpoint.
Usage:
import { ExpressStatusController } from '@studiohyperdrive/express-status';
...
const expressStatusController = new ExpressStatusController();
router.route('/status').get(expressStatusController.get);