Application (sails)
The Sails application object contains all relevant runtime state for a Sails application.
By default, it is exposed globally as sails and accessible almost anywhere in your code.
Most users of the framework will only need to know about the
sailsapplication object in order to access a few basic methods and their custom configuration. Less commonly used methods can be found in the advanced usage section.
Properties
#The application object has a number of useful methods and properties.
The officially supported methods on the sails object are covered by the other
pages in this section. Here are a few of its most useful properties:
sails.models
#A dictionary of all loaded Sails models, indexed by their identity.
By default, a model's identity is the lowercased version of its filename, without the .js extension. For example, the default identity for a model loaded from api/models/PowerPuff.js would be powerpuff, and the model would be accessible via sails.models.powerpuff. A model's identity can be customized by setting an identity property in its module file.
sails.helpers
#A dictionary of all accessible helpers, including organics.
sails.config
#The full set of configuration options for the Sails instance, loaded from a combination of environment variables, .sailsrc files, user-configuration files, and defaults. See the configuration concepts section for a full overview of configuring Sails, and the configuration reference for details on individual options.
sails.sockets
#A set of convenience methods for low-level interaction with connected websockets. See the sails.sockets.* reference section for details.
Advanced usage
#For more options and implementation details (including instructions for programmatic usage) see Advanced usage.
For a better experience on sailsjs.com, update your browser.
Reference
- 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.