Edit Page
io.socket.put()
Send a socket request (virtual PUT) to a Sails server using Socket.IO.
io.socket.put(url, data, function (resData, jwres){
// ...
});
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | url | The destination URL path, e.g. "/checkout". | |
| 2 | data | Optional request data. If provided, it will be JSON-encoded and included as the virtual HTTP body. | |
| 3 | callback | Optional callback. If provided, it will be called when the server responds. |
Callback
| Argument | Type | Details | |
|---|---|---|---|
| 1 | resData | Data received in the response from the Sails server (=== jwres.body, equivalent to the HTTP response body). |
|
| 2 | jwres | A JSON WebSocket Response object. Has headers, a body, and a statusCode. |
Example
<script>
io.socket.put('/users/9', { occupation: 'psychic' }, function (resData, jwr) {
resData.statusCode; // => 200
});
</script>
Notes
- Remember that you can communicate with any of your routes using socket requests.
- Need to customize request headers? Check out the slightly lower-level
io.socket.request()method. To set custom headers for all outgoing requests, check outio.sails.headers.
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
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-2023 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.