request @ 2.1.0 - README.md
1
# Request -- Simplified HTTP request method
2
3
## Install
4
5
<pre>
6
npm install request
7
</pre>
8
9
Or from source:
10
11
<pre>
12
git clone git://github.com/mikeal/request.git
13
cd request
14
npm link
15
</pre>
16
17
## Super simple to use
18
19
Request is designed to be the simplest way possible to make http calls. It support HTTPS and follows redirects by default.
20
21
```javascript
22
var request = require('request');
23
request('http://www.google.com', function (error, response, body) {
24
if (!error && response.statusCode == 200) {
25
sys.puts(body) // Print the google web page.
26
}
27
})
28
```
29
30
## Streaming
31
32
You can stream any response to a file stream.
33
34
```javascript
35
request('http://google.com/doodle.png').pipe(fs.createWriteStream('doodle.png'))
36
```
37
38
You can also stream a file to a PUT or POST request. This method will also check the file extension against a mapping of file extensions to content-types, in this case `application/json`, and use the proper content-type in the PUT request if one is not already provided in the headers.
39
40
```javascript
41
fs.readStream('file.json').pipe(request.put('http://mysite.com/obj.json'))
42
```
43
44
Request can also pipe to itself. When doing so the content-type and content-length will be preserved in the PUT headers.
45
46
```javascript
47
request.get('http://google.com/img.png').pipe(request.put('http://mysite.com/img.png'))
48
```
49
50
Now let's get fancy.
51
52
```javascript
53
http.createServer(function (req, resp) {
54
if (req.url === '/doodle.png') {
55
if (req.method === 'PUT') {
56
req.pipe(request.put('http://mysite.com/doodle.png'))
57
} else if (req.method === 'GET' || req.method === 'HEAD') {
58
request.get('http://mysite.com/doodle.png').pipe(resp)
59
}
60
}
61
})
62
```
63
64
You can also pipe() from a http.ServerRequest instance and to a http.ServerResponse instance. The HTTP method and headers will be sent as well as the entity-body data. Which means that, if you don't really care about security, you can do:
65
66
```javascript
67
http.createServer(function (req, resp) {
68
if (req.url === '/doodle.png') {
69
var x = request('http://mysite.com/doodle.png')
70
req.pipe(x)
71
x.pipe(resp)
72
}
73
})
74
```
75
76
And since pipe() returns the destination stream in node 0.5.x you can do one line proxying :)
77
78
```javascript
79
req.pipe(request('http://mysite.com/doodle.png')).pipe(resp)
80
```
81
82
Also, none of this new functionality conflicts with requests previous features, it just expands them.
83
84
```javascript
85
var r = request.defaults({'proxy':'http://localproxy.com'})
86
87
http.createServer(function (req, resp) {
88
if (req.url === '/doodle.png') {
89
r.get('http://google.com/doodle.png').pipe(resp)
90
}
91
})
92
```
93
94
You can still use intermediate proxies, the requests will still follow HTTP forwards, etc.
95
96
### request(options, callback)
97
98
The first argument can be either a url or an options object. The only required option is uri, all others are optional.
99
100
* `uri` || `url` - fully qualified uri or a parsed url object from url.parse()
101
* `method` - http method, defaults to GET
102
* `headers` - http headers, defaults to {}
103
* `body` - entity body for POST and PUT requests. Must be buffer or string.
104
* `json` - sets `body` but to JSON representation of value and adds `Content-type: application/json` header.
105
* `multipart` - (experimental) array of objects which contains their own headers and `body` attribute. Sends `multipart/related` request. See example below.
106
* `followRedirect` - follow HTTP 3xx responses as redirects. defaults to true.
107
* `maxRedirects` - the maximum number of redirects to follow, defaults to 10.
108
* `onResponse` - If true the callback will be fired on the "response" event instead of "end". If a function it will be called on "response" and not effect the regular semantics of the main callback on "end".
109
* `encoding` - Encoding to be used on response.setEncoding when buffering the response data.
110
* `pool` - A hash object containing the agents for these requests. If omitted this request will use the global pool which is set to node's default maxSockets.
111
* `pool.maxSockets` - Integer containing the maximum amount of sockets in the pool.
112
* `timeout` - Integer containing the number of milliseconds to wait for a request to respond before aborting the request
113
* `proxy` - An HTTP proxy to be used. Support proxy Auth with Basic Auth the same way it's supported with the `url` parameter by embedding the auth info in the uri.
114
115
The callback argument gets 3 arguments. The first is an error when applicable (usually from the http.Client option not the http.ClientRequest object). The second in an http.ClientResponse object. The third is the response body buffer.
116
117
## Convenience methods
118
119
There are also shorthand methods for different HTTP METHODs and some other conveniences.
120
121
### request.defaults(options)
122
123
This method returns a wrapper around the normal request API that defaults to whatever options you pass in to it.
124
125
### request.put
126
127
Same as request() but defaults to `method: "PUT"`.
128
129
```javascript
130
request.put(url)
131
```
132
133
### request.post
134
135
Same as request() but defaults to `method: "POST"`.
136
137
```javascript
138
request.post(url)
139
```
140
141
### request.head
142
143
Same as request() but defaults to `method: "HEAD"`.
144
145
```javascript
146
request.head(url)
147
```
148
149
### request.del
150
151
Same as request() but defaults to `method: "DELETE"`.
152
153
```javascript
154
request.del(url)
155
```
156
157
### request.get
158
159
Alias to normal request method for uniformity.
160
161
```javascript
162
request.get(url)
163
```
164
165
166
## Examples:
167
168
```javascript
169
var request = require('request')
170
, rand = Math.floor(Math.random()*100000000).toString()
171
;
172
request(
173
{ method: 'PUT'
174
, uri: 'http://mikeal.couchone.com/testjs/' + rand
175
, multipart:
176
[ { 'content-type': 'application/json'
177
, body: JSON.stringify({foo: 'bar', _attachments: {'message.txt': {follows: true, length: 18, 'content_type': 'text/plain' }}})
178
}
179
, { body: 'I am an attachment' }
180
]
181
}
182
, function (error, response, body) {
183
if(response.statusCode == 201){
184
console.log('document saved as: http://mikeal.couchone.com/testjs/'+ rand)
185
} else {
186
console.log('error: '+ response.statusCode)
187
console.log(body)
188
}
189
}
190
)
191
```
192