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 🙏

© 2021 – Pkg Stats / Ryan Hefner

lambda-healthcheck-express

v0.1.0

Published

Extends express routes to add a healthcheck endpoint for an AWS Lambda. Enables developers to add any kind of check to be included in the flow and response.

Downloads

8

Readme

dynamic forms healthcheck npm

Summary

Supports AWS lambdas implemented in NodeJs using express for middleware and routing. Once added as a middleware function, the healthcheck module provides a GET endpoint that responds with a JSON body and appropriate HTTP status codes to indiate if the lambda is healthy or not.

Getting started

Required change to package.json for all health checks

The healthcheck module reads a file version.json at the root of the lambda distribution files. Modify package.json by adding a version command to create this file during the build phase:

#package.json
#Adds a version command that writes out the version from the parent package.json and writes it to a file in the deployment folder
"scripts": {
    ...,
    "build": "mkdir -p dist && <current build> && npm run version",
    "version": "jq '. | {version: .version}' package.json > ./dist/version.json"
}

The healthcheck module requires a file named version.json to exist at the root of the files deployed as the lambda. This file is read and the version is returned in the healthcheck response as the first check. If the version.json does not exist, the heathcheck will return a warn status as the initial status.

Default lambda health check

#Server.js
const HealthCheck = require('healthCheck');
...
app.use('/healthCheck', new HealthCheck().handler())

Custom health check

#Server.js
const { HealthCheck, Check } = require('healthCheck');
...
const options = {
    checks: [new Check("custom-check", "pass")]
};

app.use('/healthCheck', new HealthCheck(options).handler())

Development

Use TDD

Testing

npm run test

Deployment

Set auth token environment variable:

export NPM_TOKEN=<token>

Publish NPM

npm publish