http(s) module with power.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 25963d1 Sep 11, 2018
Permalink
Failed to load latest commit information.
lib support pass rejectUnauthorized option Sep 10, 2018
test refine the error message Jun 26, 2018
.eslintignore Refine document Jan 14, 2016
.eslintrc.json improve debug info May 25, 2017
.gitignore refine the httpx Jun 26, 2018
.travis.yml update travis list Jun 26, 2018
README.md enable compression Jan 16, 2017
package.json Bump 2.1.4 Sep 11, 2018

README.md

httpx

http(s) module with power.

NPM version build status Coverage Status David deps npm download

Installation

$ npm install httpx --save

Usage

'use strict';

const httpx = require('httpx');

httpx.request('http://www.baidu.com/').then((response) => {
  response.pipe(process.stdout);

  response.on('end', () => {
    process.stdout.write('\n');
  });
}, (err) => {
  // on error
});

Or with co.

co(function* () {
  var response = yield httpx.request('http://www.baidu.com/');

  response.pipe(process.stdout);

  response.on('end', () => {
    process.stdout.write('\n');
  });
});

Or with async/await.

(async function () {
  var response = await httpx.request('http://www.baidu.com/');

  response.pipe(process.stdout);

  response.on('end', () => {
    process.stdout.write('\n');
  });
})();

API

httpx.request(url[, options])

  • url String | Object - The URL to request, either a String or a Object that return by url.parse.
  • options Object - Optional
    • method String - Request method, defaults to GET. Could be GET, POST, DELETE or PUT.
    • data String | Buffer | Readable - Manually set the content of payload.
    • headers Object - Request headers.
    • timeout Number - Request timeout in milliseconds. Defaults to 3000. When timeout happen, will return RequestTimeout.
    • agent http.Agent - HTTP/HTTPS Agent object. Set false if you does not use agent.
    • beforeRequest Function - Before request hook, you can change every thing here.
    • compression Boolean - Enable compression support. Tell server side responses compressed data

httpx.read(response[, encoding])

  • response Response - the Client response. Don't setEncoding() for the response.
  • encoding String - Optional.

License

The MIT license