A laughably simplistic router for node.js
Currently works with node.js v0.3.1 and above
- Simple
- Unobtrusive
- Fairly Foolproof
- Easy to debug
- Fast
var bee = require("beeline");
var router = bee.route({ // Create a new router
"/cheggit": function(req, res) {
// Called when req.url === "/cheggit" or req.url === "/cheggit?woo=poo"
},
"r`^/name/([\\w]+)/([\\w]+)$`": function(req, res, matches) {
// Called when req.url matches this regex: "^/name/([\\w]+)/([\\w]+)$"
// An array of captured groups is passed as the third parameter
// For example if req.url === "/name/smith/will" then matches === [ "smith", "will" ]
},
"`404`": function(req, res) {
// Called when no other route rule are matched
},
"`503`": function(req, res, err) {
// Called when an exception is thrown by another router function
// The error that caused the exception is passed as the third parameter
// This _not_ guarranteed to catch all exceptions
}
});
router.add({ // Use `.add` to append new rules to a router
"/ /home r`^/index(.php|.html|.xhtml)?$`?": function(req, res) {
// Called when req.url === "/" or req.url === "/home"
// or req.url matches this regex: ^/index(.php|.html|.xhtml)?$ (i.e. req.url === "/index.php")
// Note that any number of rules can be combined using a space.
// All rules will call the same request handler when matched.
},
"/my-method": { // Method specific dispatch. Note case matters.
"GET": function(req, res) {
// Called when req.url === "/my-method" and req.method === "GET"
},
"POST": function(req, res) {
// Called when req.url === "/my-method" and req.method === "POST"
},
"any": function(req, res) {
// Called when req.url === "/my-method" and req.method is not "GET" or "POST"
}
}
});
require("http").createServer(router).listen(8001); // Starts serve with routes defined above
See test/test.js
for a working example.
To start, simply store the beeline
library in a local variable:
var bee = require("beeline");
The beeline
library contains the following three methods:
-
bee.route(routes)
: Used to create a new router. It returns a function calledrtn_fn
that takes ServerRequest and ServerResponse objects as parameters. Theroutes
parameter is an objects that maps rules to handlers. See examples section for more details. -
bee.staticFile(path, mimeType)
: This is a utility method that is used to quickly expose static files. It returns a function calledrtn_fn
that takes ServerRequest and ServerResponse objects as parameters. Whenrtn_fn
is called, the file contents located atpath
are served (via the ServerResponse) with theContent-Type
set to themimeType
parameter. Note if the file atpath
does not exist a404
is served. Here's an example of how you might usebee.staticFile
:bee.route({ "/robots.txt": bee.staticFile("./content/robots.txt", "text/plain") });
-
bee.staticDir(path, mimeTypes)
: This is utility method is used to expose directories of files. It returns a function calledrtn_fn
that takes a ServerRequest object, a ServerResponse object, and an array of strings calledmatches
as parameters. Wheneverrtn_fn
is called, the items ofmatches
are joined together and then concatenated topath
. The resulting string is assumed to be a path to a specific file. If this file exists, its contents are served (via the ServerResponse) with theContent-Type
set to the value that corresponds to the file's extension in themimeTypes
object. If the resulting string doesn't point to an existing file or if the file's extension is not found inmimeTypes
, then a404
is served. Also, file extensions require a leading period (.
) and are assumed to be lowercase. Here's an example of how you might usebee.staticDir
:bee.route({ // /pics/mofo.png serves ./content/pics/mofo.png // /pics/la-ghetto/oh-gee.gif serves ./content/pics/la-ghetto/oh-gee.gif // /pics/woo-fee.tiff serves a 404 since there's no corresponding mimeType specified. // This helps prevent accidental exposure. "r`^/pics/(.*)$`": bee.staticDir("./content/pics/", { ".gif": "image/gif", ".png": "image/png", ".jpg": "image/jpeg", ".jpeg": "image/jpeg" }) });
In the event that a request matches two rules, the following precedence rules are considered:
- Fully defined rules take highest precedence. In other words,
"/index"
has a higher precedences then"r`^/index$`"
even though semantically both rules are exactly the same. - Regex rules take higher precedence than
404
404
has the lowest precedences- The
503
rules is outside the precedence rules. It can potentially be triggered at any time.
If the exact same rule is defined twice, then it's unspecified which request handler will be triggered.
The easiest way to get beeline is with npm:
npm install beeline
Alternatively you can clone this git repository:
git clone git://github.com/Xavi-/beeline.git
- Xavi Ramirez
This project is released under The MIT License.