emvc's router is responsible for receiving requests to your application and dispatching them to a controller's action. Dispatching is based on the request's URL and HTTP method.
The router also dynamically generates routing helper functions that build paths and URLs. These helpers are available in controllers and views, eliminating the need to hardcode strings.
Routes are configured in config/routes.js
emvc can match arbitrary URL patterns to a controller's action.
For example, declaring this match route:
this.match('songs/:title', { controller: 'songs', action: 'show' });
will cause SongsController
's show()
action to handle requests for URLs which
match the pattern.
/songs/like-a-rolling-stone /songs/all-along-the-watchtower
Shorthand notation, in the form of controller#action is also available to target a controller's action. For example, the following route is equivalent to the one declared above:
this.match('songs/:title', 'songs#show');
The values associated with named placeholders, in this case :title
, will be
available in the controller via the param()
function.
this.param('title'); // returns 'like-a-rolling-stone'
By default, match routes use GET
as the HTTP method. This can be changed by
specifying the via
option:
this.match('photos/upload', 'photos#upload', { via: 'POST' });
A route that responds to multiple methods can be specified as an array.
this.match('photos/upload', 'photos#upload', { via: ['POST', 'PUT'] });
A routing helper can be declared along with the route with the as
option:
this.match('bands/:id', 'bands#show', { as: 'bands' });
in which case a path routing helper, and corresponding URL routing helper, will be available in controllers and views.
Helper | Returns |
---|---|
bandsPath('radiohead') | /bands/radiohead |
Instead of routing to a controller, you can route directly to any Connect-compatible middleware.
For example, the following will route login requests to Passport for authentication.
this.match('login',
passport.authenticate('local', { successRedirect: '/', failureRedirect: '/login' }),
{ via: 'post' });
Routes can be sent to a middleware chain by specifying each middleware as an element within an array.
this.match('somewhere', [ middlewareOne(), middlewareTwo() ]);
The root route, /, can be declared with the root()
function:
this.root('pages#main');