UNPKG

sails

Version:

API-driven framework for building realtime apps, using MVC conventions (based on Express and Socket.io)

sailsjs.com

balderdashy/sails

53 lines (37 loc) • 2.88 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Response (`res`) ### Overview Sails is built on [Express](https://github.com/expressjs/) and uses [Node's HTTP server](http://nodejs.org/api/http.html#http_http_createserver_requestlistener) conventions. As a result, you can access all of the Node and Express methods and properties on the `res` object wherever it is accessible (i.e. in your actions, helpers, and policies). One of the benefits of this compatibility is that, in many cases, you can paste existing Node.js code into a Sails app and it will work. And since Sails implements a transport-agnostic request interpreter, the code in your Sails app is WebSocket-compatible as well. Sails adds a few methods of its own to the `res` object, like [`res.badRequest()`](https://sailsjs.com/documentation/reference/response-res/res-bad-request), [`res.serverError()`](https://sailsjs.com/documentation/reference/response-res/res-server-error), [`res.view()`](https://sailsjs.com/documentation/reference/response-res/res-view). These features are syntactic sugar on top of the underlying implementation, and support both HTTP _and_ (in many cases) WebSockets. <!-- ### Protocol Support The chart below describes support for the methods and properties on the Sails Response object (`res`) across multiple transports: | | HTTP | WebSockets | |----------------|---------|------------| | res.status() | :white_check_mark: | :white_check_mark: | | res.set() | :white_check_mark: | :white_large_square: | | res.get() | :white_check_mark: | :white_large_square: | | res.cookie() | :white_check_mark: | :white_large_square: | | res.clearCookie() | :white_check_mark: | :white_large_square: | | res.redirect() | :white_check_mark: | :white_check_mark: | | res.location() | :white_check_mark: | :white_large_square: | | res.charset | :white_check_mark: | :white_check_mark: | | res.send() | :white_check_mark: | :white_check_mark: | | res.json() | :white_check_mark: | :white_check_mark: | | res.jsonp() | :white_check_mark: | :white_check_mark: | | res.type() | :white_check_mark: | :white_large_square: | | res.format() | :white_check_mark: | :white_large_square: | | res.attachment() | :white_check_mark: | :white_large_square: | | res.sendfile() | :white_check_mark: | :white_large_square: | | res.download() | :white_check_mark: | :white_large_square: | | res.links() | :white_check_mark: | :white_large_square: | | res.locals | :white_check_mark: | :white_check_mark: | | res.render() | :white_check_mark: | :white_large_square: | | res.view() | :white_check_mark: | :white_large_square: | ### Legend - :white_check_mark: - fully supported - :white_large_square: - feature not yet implemented - :heavy_multiplication_x: - unsupported due to protocol restrictions --> <docmeta name="displayName" value="Response (`res`)"> <docmeta name="stabilityIndex" value="3">