A wrapper for Express JS routes definition which defines named routes
npm install express-named-router
Just initialize the wrapper like this
var namedRouter = require;...namedRouter.initForApplication;
You can still register your routes as usual, but if you want you can
In your app.locals, therefore in your views and templates, you will find:
//returns /contacts//returns http://<hostname>:<port>/contacts
For your node scripts, use namedRouter.get('contacts')
for the same purpose.
When calling, let's say with the previous example, contactsPath(), and the associated route have parameters (i.e. contacts/:type would have the :type parameter in it), you can specify them like this
This would return '/contacts/cellPhone'. If 'type' is not found in the parameters, it will be appended as query string parameter.
Parameters with non-matching arguments will be ignored.
var namedRouter = require;
- namedRouter.namedRoute(name, options) adds a named route to application router
- namedRouter.routes contains all route functions (i.e. namedRouter.routes.contactsPath())
- namedRouter.get(name) gets the original route registered for a named route
- namedRouter.route(name) is equivalent to namedRouter.routes.Path()
This is usefull for "static" routes, but not so usefull when dealing with complex regexp routes. You can still use the named routes to register routes with regexp in the express router, but the returned string (the regexp) would be pointless for view rendering purposes.
Released under BSD license.