koa-ok
Koa middleware providing a health check ping route that always returns a 200 OK
response.
Install
npm install --save koa-ok
API
Returns an async function that plugs into a Koa middleware stack.
The path
argument accepts a String
that defines the URL path to match on. This must include a leading /
character (eg: /ping
, /_health
).
Any requests matching the path
will return a text/plain
response with the body set to OK
. This will also halt further processing of the middleware chain.
Usage
const koa = const ok = const app = app app
License
Copyright 2018 Digivizer Pty Ltd.
This project is open source under the terms of the ISC license. See the LICENSE
file included with this software distribution for more information.