Vsevolod Strukchinsky
fa010fa5b4
|
10 years ago | |
|---|---|---|
| .editorconfig | 11 years ago | |
| .gitattributes | 11 years ago | |
| .gitignore | 10 years ago | |
| .jshintrc | 11 years ago | |
| .travis.yml | 11 years ago | |
| index.js | 10 years ago | |
| license | 11 years ago | |
| package.json | 10 years ago | |
| readme.md | 10 years ago | |
| test.js | 10 years ago | |
readme.md
got 
Simplified HTTP/HTTPS requests
A nicer interface to the built-in http module.
It also supports following redirects and automagically handling gzip/deflate.
Use request if you need more.
Install
$ npm install --save got
Usage
var got = require('got');
// Callback mode.
got('http://todomvc.com', function (err, data, res) {
console.log(data);
//=> <!doctype html> ...
});
// Stream mode.
got('http://todomvc.com').pipe(fs.createWriteStream('index.html'));
// For POST, PUT and PATCH methods got returns WritableStream
fs.createReadStream('index.html').pipe(got.post('http://todomvc.com'));
API
It's a GET request by default, but can be changed in options.
got(url, [options], [callback])
url
Required
Type: string
The url to request.
options
Type: object
Any of the http.request options.
options.encoding
Type: string, null
Default: 'utf8'
Encoding to be used on setEncoding of the response data. If null, the body is returned as a Buffer.
options.body
Type: string, Buffer
Body, that will be sent with POST request. If present in options and options.method is not set - options.method will be set to POST.
This option and stream mode are mutually exclusive.
options.timeout
Type: number
Milliseconds after which the request will be aborted and an error event with ETIMEDOUT code will be emitted.
callback(err, data, response)
err
Error object with HTTP status code as code property.
data
The data you requested.
response
The response object.
got.get(url, [options], [callback])
got.post(url, [options], [callback])
got.put(url, [options], [callback])
got.patch(url, [options], [callback])
got.head(url, [options], [callback])
got.delete(url, [options], [callback])
Sets options.method to the method name and makes a request.
License
MIT © Sindre Sorhus