sails.request()
Make a virtual request to a running Sails instance.
sails.request(request);
Or:
sails.request(url, body)sails.request(url, callback)sails.request(url, body, callback)
This method can be used on a instances that have been started with sails.load(), which are not actively listening for HTTP requests on a server port. This makes it useful for testing scenarios where running sails.lift() is not necessary. However, it should be noted that the data may not be processed in exactly the same way as an HTTP request; in particular, a much simpler body parser will be employed, and Express middleware such as the static asset server will not be used.
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | request (or url) | The virtual request to make. If specified as a string, this should be an address containing an optional method and a path, e.g. /foo or PUT /user/friend. If specified as an object, it should have one or more of the properties described in the "request argument" section below. |
|
| 2 | body | (optional) A JSON-serializable value to use as the request body. This argument will override the data property of the request argument, if provided. |
|
| 3 | callback | (optional) A callback to be called with the virtual response. |
Request object
If the request argument is specified as an object, it can have the following properties:
| Property | Type | Example | Details |
|---|---|---|---|
| url | "/foo", "PUT /user/friend" |
(required) The route in the Sails app to make a request to, with an optional HTTP method prefix | |
| method | "GET", "POST" |
(optional) The HTTP method to use in the request. This will override any method supplied as part of the url property. |
|
| headers | {content-type: 'application/json'} |
(optional) Dictionary of headers to use in the virtual request. | |
| data | {foo:'bar'}, 12345 |
GET, HEAD and DELETE requests, the data will be serialized into a querystring and added to the URL. Otherwise, it will be sent as-is as the request body. |
Callback
| Argument | Type | Details | |
|---|---|---|---|
| 1 | err | If the response was unsuccessful (status code was not in the 200-399 range) this will be an object containing status and body properties. If the response was successful, this will be null. |
|
| 2 | response | If the response was successful, this will be an object containing the full server response. | |
| 3 | body | If the response was successful, this will be the value of response.body. |
Returns
Type:
The full virtual request stream object. This is a readable stream.
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.connections
- sails.config.cors
- sails.config.csrf
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- 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()
- 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.