About
pathparser.js is a tiny, simple-to-use JavaScript URL parser/router with no dependencies. It supports optional named parameters, query string parameter parsing, and automatic parameter assignment:
var params = format: 'html' ;var router = params;router;router; router;// params.controller == 'users'// params.userID == 12345// params.format == 'json'
Usage
Fixed paths
var router = ;router;router;router; router;// document.title is now 'Users'
Optional named parameters
Named parameters in the matching route are accessible from within the this
object in the handler function:
var router = ;router; router;// showUser(2714)
Routes still match even if there are unmatched named parameters at the end:
var router = ;router; router;// showItemsInCollection(3424, undefined);
Routes are matched in the order they're added, so to use a more general route when a named parameter is omitted, simply add it first:
var router = ;router;router; router;// showUsers();
(This behavior differs from some other routers that use more complex rules to determine which route to choose when there are multiple options.)
Query string parameter parsing
Query string parameters are parsed automatically:
var router = ;router; router;// showUsers(10)
If a named parameter already exists with the same name as a query parameter, the query parameter will be ignored:
var router = ;router; router;// showUser(1)
This holds true even if a trailing named parameter is omitted, in which case the named parameter will be undefined
.
Automatic parameter assignment
You can pass an object to the constructor to have parameters from the matching route automatically assigned to that object, which can be used, among other things, to override a set of default parameters:
var params = format: 'html' limit: 25;var router = params;router;router; router;// params:// {// format: 'json',// limit: 25,// controller: 'users',// userID: 12345// }
Handler functions are run after automatic parameter assignment, so properties set in a handler will always override parameters from the request:
var params = {};var router = params;router;router; router;// params:// {// controller: 'users',// userID: 12345// }
In some cases, handler functions may not even be required when automatic parameter assignment is used:
var params = {};var router = params;router;router; router;// params:// {// collectionID: 1// itemID: 2,// limit: 10// }
Installation
Node
npm install pathparser
var PathParser = ;var router = ;
Browser
Mozilla JSM
Componentsutils;var router = ;