NamiKoi url router
$ npm install nk-router
$ npm run build
or
$ npm install babel -g
$ babel src --out-dir lib
$ npm test
or
$ npm install mocha -g
$ mocha test
$ npm run bench
var nkRouter = require('nk-router'),
router = nkRouter.router(),
matched;
router.add('base', nkRouter.route('GET', '/', function() {
response.end('Hello World!');
}));
matched = router.match('GET', '/');
if (matched === null) {
console.log('404 Not Found');
} else {
matched.route.handler();
}
var http = require('http'),
nkRouter = require('nk-router'),
router = nkRouter.router();
router.add('base', nkRouter.route('GET', '/', function(request, response, data) {
response.end('Hello World!');
}));
http.createServer(function(request, response) {
var matched = router.matchRequest(request);
if (matched === null) {
response.statusCode = 404;
response.end('404 Not Found');
return;
}
matched.route.handler(request, response, matched.data);
}).listen(8888);
Returns a new instance of nkRouter.Route
.
Returns a new instance of nkRouter.Router
.
Array
A list of the supported HTTP methods.
- method
String
- path
String
- handler
Function
Parameters sets with :
before name.
/post/:id
Parameters can have modifiers: string
(default), integer
, float
.
/post/:id:integer
/post/:id:integer/:title
- method
String
- url
String
Checking if method and url matched.
Returns Map
of parameters if matched or null
.
- parameters
Object
//Map
is depricated
Generating url from route.
Returns url String
if all parameters are set or null
.
- key
String
- route
nkRouter.Route
Adding named route in router. Key must be unique.
- key
String
Finding nkRouter.Route
by unique key.
Returns instance of nkRouter.Route
if key found or null
.
- method
String
- url
String
Checking if any nkRouter.Route
matched.
Returns Map
of parameters if matched or null
.
- request
http.ClientRequest
Calling router.match
with parameters from http.ClientRequest
.
- parameters
Object
//Map
is depricated
Finding nkRouter.Route
by unique key and getting url from it.
Returns url String
if found or null
.