1.1.1 • Published 9 years ago
nice-router v1.1.1
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 tomethodrequests topathby doinghandler. The signature of handlers ishandler(request, response, headers, query, body). Therequestandresponseobjects are the same as those from the nodehttp/httpsmodules.headersandqueryare basic key/value objects.bodyis a Buffer, so callbody.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.optionsis the same as the options parameter in node'shttps.createServer. Accepts an optionalcallbackwhich will be called if the server is restarted.#addStatic(path, contentType): Adds a handler which responds toGETrequests atpathwith the contents of the file atpath.