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

scrawny

v1.0.0

Published

A simple, lightweight, and easy to use request logger for Node.js

Downloads

67

Readme

Scrawny

An open-source, light-weight, simple request logger for Node.js.

Installation

You can install Scrawny by running any of the following command:

npm install scrawny

OR

yarn add scrawny

Usage

Using Scrawny is very easy and here's how to do it. It also has built-in typescript declarations.

Typescript and ES6

import express, { Express } from "express";
import scrawny from "Scrawny";

const app: Express = express();

app.use(
  scrawny({
    /* options */
  })
);

app.listen(3000, () => {
  console.log("Listening on port 3000");
});

JavaScript - CommonJS

const express = require("express");
const { default: scrawny } = require("Scrawny");

const app = express();

app.use(
  scrawny({
    /* options */
  })
);

app.listen(3000, () => {
  console.log("Listening on port 3000");
});

Options

Note: These are optional.

  • allowed: an array of data you want to log.
  • format: a string containing your required format of the data you want to log. While using this option, you don't need to use the allowed option.
  • dateFormat: type of date format you want to use (default: UTC, others: ISO, "Locale").
  • log: a boolean value to enable/disable the logger; default is false so it doesn't run in production.

    You can enable this only in development mode by passing log: process.env.NODE_ENV !== "production", to the options.

Allowed Fields

allowed: [
      "status",
      "host",
      "method",
      "url",
      "protocol",
      "path",
      "body",
      "params",
      "query",
      "time",
    ],
  • status: the status code of the response.
  • host: the hostname of the current server.
  • method: the HTTP method of the request.
  • url: the full URL of the request.
  • protocol: the protocol of the request.
  • path: the path/route of the request.
  • body: the body of the request.
  • params: the params of the request.
  • query: the query of the request.
  • time: the time it took to respond.
  • date: the date of the request.

Format - SAMPLE

{
  format: "[STATUS] [METHOD] [PATH] [TIME]";
}

Note: You can use the following fields:

  • [STATUS]
  • [METHOD]
  • [PATH]
  • [TIME]
  • [DATE]
  • [HOST]
  • [PROTOCOL]
  • [BODY]
  • [PARAMS]
  • [QUERY]

It is also case-insensitive.

Found bugs? Let me know! You can also fork this project on GitHub and tinker with it.