Administrator / new_rukzachok-1

Name Last Update
..
index.js Loading commit data...
package.json Loading commit data...
readme.md Loading commit data...

readme.md

got Build Status

Simplified HTTP/HTTPS requests

A nicer interface to the built-in <code>http</code> module.

It supports following redirects, streams, automagically handling gzip/deflate and some convenience options.

Created because <code>request</code> is bloated (several megabytes!) and slow.

Install

$ npm install --save got

Usage

var got = require('got');

// Callback mode
got('todomvc.com', function (err, data, res) {
    console.log(data);
    //=> <!doctype html> ...
});


// Stream mode
got('todomvc.com').pipe(fs.createWriteStream('index.html'));

// For POST, PUT and PATCH methods got returns a WritableStream
fs.createReadStream('index.html').pipe(got.post('todomvc.com'));

API

It's a GET request by default, but can be changed in options.

got(url, [options], [callback])

url

Required
Type: string, Object

The URL to request or bare http.request options object.

options

Type: object

Any of the <code>http.request</code> options.

body

Type: string, Buffer, ReadableStream

This option and stream mode are mutually exclusive.

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.

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.

json

Type: Boolean
Default: false

This option and stream mode are mutually exclusive.

If enabled, response body will be parsed with JSON.parse.

query

Type: string, Object

Query string object, that will be added to request url. This will override query string in url.

timeout

Type: number

Milliseconds after which the request will be aborted and an error event with ETIMEDOUT code will be emitted.

agent

http.Agent instance.

If undefined - <code>infinity-agent</code> will be used to backport Agent class from Node core.

To use default globalAgent just pass null to this option.

callback(err, data, response)
err

Error object with HTTP status code as code property.

data

The data you requested.

response

The response object.

.on('response', response)

When in stream mode, you can listen for the response event to get the response object.

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.

Proxy

You can use the <code>tunnel</code> module with the agent option to work with proxies:

var got = require('got');
var tunnel = require('tunnel');

got('todomvc.com', {
    agent: tunnel.httpOverHttp({
        proxy: {
            host: 'localhost'
        }
    })
}, function () {});

Tip

It's a good idea to set the 'user-agent' header so the provider can more easily see how their resource is used. By default it's the URL to this repo.

var got = require('got');

got('todomvc.com', {
    headers: {
        'user-agent': 'https://github.com/your-username/repo-name'
    }
}, function () {});

License

MIT © Sindre Sorhus