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

warpath-router

v1.0.3

Published

a router that uses theWorks to configure it's routes

Downloads

1

Readme

WARPATH-ROUTER

#(FINAL ROUND of the warpath suite of helpfully named tools)

get on the ROUTE TO VICTORY, when you TURN A SCHEMA INTO A THING YOU CAN USE.

#what does this thing do?

the router is a tool for taking a route configuration and doing something useful with it. It uses the warpath-matcher and the same kind of rules to take a configuration that looks like this


var config = [
	{
		"schema":{
			"pathDescription":{
				"path":"/dogs/:breed",
				"params":{
					"breed":{
						"values":["corgi","borzoi","pitbull","dracula hound"]
					}
				}
			}
		},
		"data":function(req,res){
			res.end("PARTY ON")
		}
	},
	//and many more!
	...
]

and returns an object like this


	var router = createRouter(config);

	router.match("/some/non/existant/route"); //returns empty array

	var coolThing = router.match("/dogs/borzoi");

	//coolThing will be an object that looks like this
	{
		"params":{
			"breed":"borzoi"
		},
		"data":function(req,res){
			res.end("PARTY ON")
		}
	}

#what about HTTP methods?

This router was designed to be used with HTTP but it wasn"t designed for that exclusively. It could be used with other protocols which use "/" delimited paths. That means it doesn"t make decisions about how to handle verbs or other HTTP related content. That means it"s up to you to decide how to handle it, and depending on what you are trying to do different approaches might be better. Here are 2 possible ways to handle HTTP methods. There are probably some other good ones that I haven"t thought of.

  1. create different routers for each verb and select the router you need before matchign the path.
  2. put a handler for all the different supported verbs in the data object and select after you ahve matched.

#what about queries?

this router was not meant to decide on queries, that kind of policy will have to be decided after the route is matched.