Vsevolod Strukchinsky 015785bccf Remove res.destroy and move read code to static method		10 years ago
.editorconfig	init	11 years ago
.gitattributes	init	11 years ago
.gitignore	init	11 years ago
.jshintrc	init	11 years ago
.travis.yml	init	11 years ago
index.js	Remove res.destroy and move read code to static method	10 years ago
license	add gzip/deflate support	11 years ago
package.json	1.2.2	10 years ago
readme.md	Remove res.destroy and move read code to static method	10 years ago
test.js	Remove res.destroy and move read code to static method	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.

callback(err, data, response)

err

Error object with code property. If error happens, callback will receive undefined as data and bare response object, which can be destroyed or queried for data.

data

The data you requested.

response

The response object.

See sent if you need to upload something.