Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
expressive-routes
Advanced tools
Readme
A really simple helper to transform hierarchically structured route maps into server routes. Supports trigger characters to add middleware downstream.
Designed to work with express.js by default, or any route system when using a custom processor (see below).
Get it like this: npm install expressive-routes
See example.js for full suggested usage.
Example of a contrived route map.
var routes = {
'/': {get: Main.index},
'/login': {
post: Session.performLogin,
get: Session.login
},
'/logout': {get: Session.logout},
'/$admin': {
get: Admin.index,
'/users' : {
get: Admin.users,
'/:user_id': {
get: Admin.userDetails,
'/destroy' : {post: [Admin.contrivedMethod, Admin.destroyUser]},
'/update' : {post: Admin.updateUser}
}
}
},
'/!account': {
get: Account.index,
post: Account.updateProfile
}
};
The $
and !
in these keys are used to trigger middleware downstream to its children:
Contrived trigger map:
var triggers = {
'!': helper.ensureAuthenticated,
'$': helper.ensureAdministrator
};
With a route map, and an optional trigger map in place, the routing can be processed as follows:
var expressive = require('expressive-routes');
var opts = {
triggerMap: triggers,
verbose: true
};
expressive(routes, app, opts);
// OUTPUT:
// get / (1)
// post /login (1)
// get /logout (1)
// get $ /admin (2)
// get $ /admin/users (2)
// get $ /admin/users/:user_id (2)
// post $ /admin/users/:user_id/destroy (3)
// post $ /admin/users/:user_id/update (2)
// get ! /account (2)
// post ! /account (2)
A sample using a custom processor, in case you aren't using express, or just want it to do something fancier.
var opts = {
triggerMap: triggers,
processor: function(method, route, endpoints) {
console.log("Something fancier", method, route);
app[method].apply(app, [route].concat(endpoints));
}
};
expressive(routes, opts);
With verbose mapping, the output is printed, with the preceeding triggers depicting which middleware was injected. The trailing number indicating the number of middlewares on the route.
Because the $ was set on the /admin
route, itself and all children will have the ensureAdministrator()
middleware.
If a trigger is added to the child of a route that also has a trigger, the subsequent trigger will be added to the stack.
The /$admin/users/:user_id/destroy
also shows arrays of functions are also supported as endpoints.
FAQs
Transform hierarchically structured routes into express routes.
The npm package expressive-routes receives a total of 2 weekly downloads. As such, expressive-routes popularity was classified as not popular.
We found that expressive-routes demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.