req.options
req.options is a dictionary of additional information that allows your action to access its configured route options, if there are any.
Route options
Any additional properties provided in a route target are made available as properties of req.options. For example, given the following in config/routes.js:
'GET /foo': {
controller: 'UserController',
action: 'login',
owl: 'hoot'
}
In this example, req.options.owl will be available in our UserController.login action.
With the blueprint API
Several special route options are always provided to blueprint actions. This provides a way to programatically modify the criteria and/or values that a blueprint action uses when accessing models. These options can be configured in a route, or set dynamically in a policy.
For example, req.options can be modified in a policy to filter requested records based on the logged-in user:
// `config/policies/filterByUser.js`
module.exports = function filterByUser (req, res, next) {
if (req.session.me) {
req.options.where = {
userId: req.session.me
}
}
return next();
}
Making the transition between the blueprint API and writing custom actions? Check out Concepts > Controllers.
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.connections
- sails.config.cors
- sails.config.csrf
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req.accepted
- req.acceptedCharsets
- req.acceptedLanguages
- req.body
- req.cookies
- req.fresh
- req.headers
- req.host
- 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.acceptsCharset()
- req.acceptsLanguage()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- Response (`res`)
- Waterline (ORM)
- WebSockets
Built with Love
The Sails framework is maintained by a web & mobile studio 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-2018 The Sails Company.
The Sails framework is free and open-source under the MIT License.