tdb-alcorn/nice-router

Route requests to handlers nicely.

nice-router

A nice, simpler router for handling those pesky HTTP(S) requests.

Example

var Router = require("nice-router");
var router = new Router();
router.addRoute("/ping", "GET", function(req, res) {
    res.writeHead(200);
    res.end("pong");
});
router.addStatic("/smiley.jpg", "image/jpeg");
router.listen(8080);

Basic HTTPS example

To use this example you will need to generate self-signed certificates server.key and server.crt. If you are unsure about how to do that, see this Stack Overflow.

var fs = require("fs");
var Router = require("nice-router");
var router = new Router();
router.useHTTPS({
    key: fs.readFileSync("key.pem"),
    cert: fs.readFileSync("cert.pem"),
};
router.addRoute("/amIEncrypted", "GET", function(req, res) {
    res.writeHead(200);
    res.end("yes!");
});
router.listen(8080);

Methods

• #addRoute(path, method, handler): Adds a route to the router which will respond to method requests to path by doing handler. The signature of handlers is handler(request, response, headers, query, body). The request and response objects are the same as those from the node http/https modules. headers and query are basic key/value objects. body is a Buffer, so call body.toString("utf-8") if you just want a string.
• #listen(port) -> Promise: Start the server on the specified port, which must be open.
• #close -> Promise: Stop the server.
• #useHTTPS(options[, callback]): Switches the server to using HTTPS, restarting if the server was already running. options is the same as the options parameter in node's https.createServer. Accepts an optional callback which will be called if the server is restarted.
• #addStatic(path, contentType): Adds a handler which responds to GET requests at path with the contents of the file at path.

nice-router's Issues

Add staticDir handler that recursively makes all files in a directory available as static files.

Optionally it could accept a depth to which to add static handlers. It could also accept a generateIndex flag, which if true would cause to generate index.html files for each directory listing the contents (for dev/debugging).

Support https.

Log connection information like client IP, user-agent, etc.

Make staticFile handler correctly set content type and content encoding headers.

It should guess content-type from the file extension (but be overridable). Choose a good subset of these content types.

If the file ends in an extension indicating it has been compressed (e.g. gz), set the Content-Encoding header appropriately (Content-Encoding: gzip in this case) and then look for an inner extension to set the content-type header.

Add a redirect handler.

Add listRoutes.

List the routes!

Add websocket capability.

Handler signature is a tad awkward.

Instead of handler(request, response, body, headers, query) it should be handler(request, response, headers, query, body). This is so that handlers GET requests (and other requests with no body), can just use the shorthand handler(request, response, [headers, query]) and leave off the body entirely.

#addStaticDir should optionally accept a path under which to serve directory

If I have a directory of views called pages I should be able to specify something likeaddStaticDir("/pages", { serveFrom: "/" }) which would mean that the server acts as if everything in /pages was actually located at /. E.g. /pages/index.html would actually be served at /index.html (or even at just / in the case of index.html files).