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

route-fs

v3.1.1

Published

A easy way to organize your routers.Say goodbye to writing route list by hand, just proxy to file system.

Downloads

33

Readme

Route-fs

A easy way to organize your routers.Say goodbye to writing route list by hand, just proxy to file system.

Travis Coveralls branch

How to use

Step 1
npm install route-fs --save
Step 2

Create a floder named routers in your project, for example


|-app.js

|-public/

|-routers/

  |-person.js

  |-person/

    |-works.js
Step 3

Add middleware on your server in app.js. Support koa, express 4, restify now.

var koa = require('koa')();
var express = require('express')();
var restify = require('restify').createServer();

var RS = require('route-fs');

var rs = new RS({
	root: __dirname + '/routers', 	// path of `routers` directory
	prefix: 'public' 				// optional, default a empty string
});

koa.use(rs.koa());
express.use(rs.express());
restify.pre(rs.restify());

It will generate routes matcher like

/public/person/:person?

/public/person/:person/work/:work?
Step 4

Exports the method handler in the file, if you are use koa, export generate function instead.

work.js

exports.get = function(req, res, next) {
	res.send("We are works belongs to person No." + req.params.person);
};

exports.put = function(req, res, next) {
	var id = addWork(req.params.person);
	res.send("The work added to " + req.params.person + ", id is " + id)
};

person.js

exports.get = function(req, res, next) {
	res.send("I am No." + req.params.person);
};

exports['delete'] = function() {
	res.send("No." + req.params.person + " was deleted.")
}

It will call the function named by http method when the request coming.

Step 5

It just finished! Let's experience with curl

curl -X GET 'http://localhost/public/person/1/work/'	->	"We are works belongs to person No.1"
curl -X PUT 'http://localhost/public/person/2/work/'	->	"The work added to 2, id is 1"
curl -X GET 'http://localhost/public/person/100'		->	"I am No.100"
curl -X DELETE 'http://localhost/public/person/1'		->	"No.1 was deleted."

###For more detail, see /test directory now