io.socket.request()
Send a virtual request to a Sails server using Socket.IO.
This function is very similar to io.socket.get(), io.socket.post(), etc. except that it provides lower-level access to the request headers, parameters, method, and URL of the request.
Using the automatically-created io.socket instance:
io.socket.request(options, function (resData, jwres)){
// ...
// jwres.headers
// jwres.statusCode
// jwres.body === resData
// ...
});
Usage
| Option | Type | Details |
|---|---|---|
| method | The HTTP request method; e.g. 'GET'. |
|
| url | The destination URL path; e.g. "/checkout". | |
| data | Optional. If provided, this request data will be JSON-encoded and included as the virtual HTTP body. | |
| headers | Optional. If provided, this dictionary of string headers will be sent as virtual request headers. |
Callback
| Argument | Type | Details | |
|---|---|---|---|
| 1 | resData |
Data received in the response from the Sails server (=== jwres.body, and also equivalent to the HTTP response body). |
|
| 2 | jwres |
A JSON WebSocket Response object. Has headers, a body, and a statusCode. |
Example
io.socket.request({
method: 'get',
url: '/user/3/friends',
data: {
limit: 15
},
headers: {
'x-csrf-token': 'ji4brixbiub3'
}
}, function (resData, jwres) {
if (jwres.error) {
console.log(jwres.statusCode); // => e.g. 403
return;
}
console.log(jwres.statusCode); // => e.g. 200
});
Notes
- A helpful analogy might be to think of the difference between
io.socket.getand this method as the difference between JQuery's$.getand$.ajax.- Remember that you can communicate with any of your routes using socket requests.
- Need to set custom headers for all outgoing requests? Check out
io.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
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.