Edit Page
sails.getRouteFor()
Look up the first route pointing at the specified target (e.g. MeController.login) and return a dictionary containing its method and URL.
sails.getRouteFor(target);
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | target | The route target string; e.g. MeController.login |
Returns
Type:
{
method: 'post',
url: '/auth/login'
}
Example
In a controller action...
return res.view('pages/some-page-with-a-form-on-it', {
formEndpoint: sails.getRouteFor('SomeotherController.someAction'),
// ...
});
So that in the rendered view...
<form action="<%=formEndpoint.url%>" method="<%=formEndpoint.method%>">
<!-- ... -->
</form>
Notes
- This function searches the Sails app's explicitly configured routes;
sails.config.routes. Shadow routes bound by hooks (including blueprint routes) will not be matched.- If a matching target cannot be found, this function throws an
E_NOT_FOUNDerror (i.e. if you catch the error and check itscodeproperty, it will be the stringE_NOT_FOUND).- If more than one route matches the specified target, the first match is returned.
- If you only need the URL for a route (e.g. to use as an
hreffrom within one of your views), you may want to usesails.getUrlFor()instead of this function.
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
Built with Love
The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.