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

content-type-router

v1.3.0

Published

This is a strictly structured router module designed for internal use only. It assumes all incoming request are either json, text or file/blob via POST method. It doesn't parse flexible parameter in path either.

Downloads

15

Readme

Entrance

You need to pass 4 parameters to the init() function: request, response, environment object and router map.

  • request is the same object from http.createServer callback.
  • response is the same object from http.createServer callback.
  • env is anything you want to pass to your handler. For example database object.
  • map is a string/function mapping const. It indicates which handler function should a request with specific path be mapped to.
const router = require('mime-router');
const file = require('./local_modules/object/file.js'); // Your handler module
const test = require('./local_modules/object/test.js'); // Your handler module
const map = {
    '/test/server': test.server,
    '/file/upload': file.upload,
};
const env = {
    database: null // Let's say you want to pass a database to the handler too
}
const server = http.createServer(function (req, res) {
    router.init(req, res, env, map);
});
server.listen(process.env.PORT || 8000);

Processing

  • If the request contentType is application/json, the module will process and transform the body into a json object.
  • If the request contentType is text/plain, the module will pass the text directly.
  • If the request contentType is almost everything else, the module will assume it's a file and form up an object like this:
{
    "buffer": [],
    "contentType": "image/png",
    "category": "image"
}

Handler

A handler function should always have a signature like this:

function handler(req, res, env, data) {
    // Deal with the data
}

Depends on the Content-Type in request header, data will be:

  • JSON object if Content-Type is "application/json".
  • String if Content-Type is "text/plain".
  • JSON object listing in the Processing section if Content-Type is anything else.