npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@sigfox/koa-health-check

v1.0.1

Published

Koa middleware mounting the GET /health route returning the app status depending on ctx.isShutdown existence.

Downloads

2

Readme

koa-health-check

Koa middleware mounting the route GET /health.

When use it?

You can use this module if you need a route returning the health status of your Koa app.

Features

Mount GET /health to your Koa app, this route verifies the existence of a field in the Koa's context, and will set the status to 503 if that field exists, otherwise 200.

Install

npm install @sigfox/koa-health-check

Usage

  • fieldToVerify (String) (default: "isShutdown"): The name of the field in the ctx that /health will search for, if that field exists and is truthy, a 503 status will be responded.
const Koa = require('koa');
const healthCheck = require('@sigfox/koa-health-check');

const HEALTH_CHECK_DELAY = 2000;

const app = new Koa().use(healthCheck());

const server = app.listen();

process.on('SIGTERM', () => {
  app.context.isShutdown = true;
  console.warn(`Received SIGTERM signal, respecting health check delay ${HEALTH_CHECK_DELAY}ms...`);
  setTimeout(() => server.close(), HEALTH_CHECK_DELAY);
});

Test

npm test

Licence

This project is licensed under the MIT License - see the LICENSE file for details.