Have ideas to improve npm?Join in the discussion! »

    @shopify/koa-liveness-ping
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    @shopify/koa-liveness-ping

    Build Status Build Status License: MIT npm version

    A package for creating liveness ping middleware for use with Koa.

    A liveness ping is a URL at which your application will respond with a 200 whenever your server is running. It can be used, for example, for liveness checks in Kubernetes deployments.

    Installation

    $ yarn add @shopify/koa-liveness-ping

    Usage

    import Koa from 'koa';
    import ping from '@shopify/koa-liveness-ping';
    
    const app = new Koa();
    
    // set up any error or loggin middlewares
    
    app.use(ping());
    
    // other routing middlewares should go after the liveness ping

    This middleware can also be mounted at any path via koa-mount (Learn more).

    Note: Mount the liveness ping middleware before all other routing-related middleware in order to ensure it can respond quickly and reliably.

    Keywords

    none

    Install

    npm i @shopify/koa-liveness-ping

    DownloadsWeekly Downloads

    934

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    6.49 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar