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

express-switch

v0.1.2

Published

A pattern matching middleware for express

Downloads

8

Readme

express-switch

NPM Version Build Status Coverage Status

express-switch is a pattern matching middleware for express

Installation

$ npm install express-switch

Parameters

eSwitch(getter, pattern)
  • getter (mandatory) a function that returns the value to match against the pattern
  • pattern (mandatory) an object that describes the different routes to follow depending on the value returned by the getter

Getter

The getter is a function that is responsible to compute the value to match against the cases. This function can be synchronous or asynchronous.

Synchronous

The getter is synchronous when the number of parameters is less than 3. It has to return the value.

prototype

    function (req, res) { /* ... */ return value; }

example

var express = require('express');
var eSwitch = require('express-switch');
var app = express();

// ...

app.use(eSwitch(
    function(req, res){
        return value; // here you have to return the value to match against the cases
    },
    {
        case: {
            CASE1: middleware1, // this will be executed if the getter returns 'CASE1'
            CASE2: [middleware2, middleware3] // these will be execute if the getter returns 'CASE2'
        },
        default: middleware5 // this will be executed if the getter return neither 'CASE1' nor 'CASE2'
    }
));

// ...

app.listen(3000);

Asynchronous

The getter is asynchronous when the number of parameters is more than 2. It has to forward the value to the done callback.

prototype

    function (req, res, done) {
        // ...
        if (error) {
            done(undefined, error);
        } else {
            done(value);
        }
        // ...
    }

example

var express = require('express');
var eSwitch = require('express-switch');
var app = express();

// ...

app.use(eSwitch(
    function(req, res, done){
        something.doAsync(req, res, function(err, value){
            if (err){
                return done(undefined, err); // error forwarding
            }
            done(value); // you have to forward to the done callback the value to match against the cases
        });
    },
    {
        case: {
            CASE1: middleware1, // this will be executed if the getter returns 'CASE1'
            CASE2: [middleware2, middleware3] // these will be execute if the getter returns 'CASE2'
        },
        default: middleware5 // this will be executed if the getter return neither 'CASE1' nor 'CASE2'
    }
));

// ...

app.listen(3000);

Return an Array

If the getter returns/forwards an Array all the values will be analized sequencially, unless one of the middlewares forwards an error.

Pattern

The pattern is an object with the following properties.

  • case (mandatory) a lookup table of middlewares or arrays of middlewares.
  • default (optional) the default route to follow if none of the cases matches.

prototye

    var pattern = {
        case : {
            "value 1" : middleware1,
            "value 2" : [middleware2, middleware3],
            // ...
            "value N" : middleware
        },
        default : middleware // optional
    }