req.accepts()
Return whether this request (req) advertises that it understands the specified media type.
If none of the media types are considered acceptable, this returns
false. Otherwise, it returns truthy (the media type).
Usage
req.accepts(mediaType);
Example
If a request is sent with an "Accept: application/json" header:
req.accepts('application/json');
// -> 'application/json'
req.accepts('json');
// -> 'json'
req.accepts('image/png');
// -> false
If a request is sent with an "Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8" header:
req.accepts('html');
// -> 'html'
req.accepts('text/html');
// -> 'text/html'
req.accepts('json');
// -> false
Notes
- The specified media type may be provided as either a MIME type string such as "application/json", or an extension name such as "json".
- This is implemented by examining the request's "Accept" header.
- See the
acceptspackage for the finer details of the header-parsing algorithm used in Sails/Express.
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-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.