io.socket
Overview
When used in the browser, sails.io.js will create a global instance of the SailsSocket class as soon as it loads, and attempt to connect it to the server after waiting one event loop cycle (to allow for configuration options to be changed). As with any SailsSocket, you can start using its properties and methods even before it connects to the server--any requests or event bindings will be queued up and replayed once the connection is established.
Configuration Options
Like any SailsSocket instance, io.socket is affected by the global io.sails settings. The sails.io.js library waits for one event loop cycle before attempting to connect io.socket to the server, giving you a chance to change any settings first.
Example
Changing the server that io.socket connects to
<script type="text/javascript" src="/js/dependencies/sails.io.js"></script>
<script type="text/javascript">
io.sails.url = "http://somesailsapp.com";
</script>
Properties
See the SailsSocket properties reference for a full list of properties available on io.socket.
Methods
For basic server communication and event listening methods, see the other io.socket.* pages in this section. For advanced methods involving server connection, see the SailsSocket advanced methods reference.
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.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()
- req.setLocale()
- req.setTimeout()
- 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.