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

@bit-warriors/status

v1.0.1

Published

A utility module to expose an Express.js endpoint to return the health status of an application.

Downloads

3

Readme

@bit-warriors/status

A simple utility module to expose an endpoint to return the health status of an Express.js application, or a Mongoose database connection.

Usage

import express from 'express';
import mongoose from 'mongoose';
import { setupStatus, setupDatabaseStatus } from '@bit-warriors/status';

const app = express();
// Mongoose connection setup...
// Other middleware and configurations...

// Setup status endpoint for the Express app
setupStatus(app);
// Setup status endpoint for Mongoose database connection
setupDatabaseStatus(app, mongoose);

// Start the server
const port = process.env.PORT || 3000;
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

Endpoints

Express App Status Endpoint

  • GET /status - Retrieves the health status of the Express app.
    • Returns:
      {
        "online": true,
        "received": "<timestamp>",
        "environment": "<environment>",
        "uptime": "<uptimeInSeconds>"
      }

Mongoose Database Status Endpoint

  • GET /status-db - Retrieves the health status of the Mongoose database connection.
    • Returns:
      {
        "connected": "true|false",
        "status": "<connectionStatus>",
        "databaseName": "<dbName>"
      }
      • connected: Indicates if the database is connected.
      • status: The current status of the database connection (connected, disconnected, connecting, disconnecting, uninitialized).
      • databaseName: The name of the connected database.