mirror of https://github.com/lukechilds/got.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.7 KiB
1.7 KiB
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'));
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.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.
Related
See sent if you need to upload something.
License
MIT © Sindre Sorhus