Vsevolod Strukchinsky aa63cbb1b3 Up timed-out to get nice error.messages		10 years ago
.editorconfig	init	11 years ago
.gitattributes	init	11 years ago
.gitignore	Read response stream even if status is not 200	10 years ago
.jshintrc	init	11 years ago
.travis.yml	init	11 years ago
index.js	Close #15 PR: Implement body option.	10 years ago
license	add gzip/deflate support	11 years ago
package.json	Up timed-out to get nice error.messages	10 years ago
readme.md	Close #15 PR: Implement body option.	10 years ago
test.js	Close #15 PR: Implement body option.	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'));

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.

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.

See sent if you need to upload something.