readme.md

reqx

A lite wrapper of http(s).request that's stream-friendly, inspired by hyperquest.

reqx implements a chainable api like superagent, and supports redirect following.

Install

$ npm install --save reqx

Usage

Instead of accepting a single options argument like official http(s).request method dose, reqx basically converts each option key to an api method that returns the reqx object itself so they can be chainable.

As a result, every options in official node documentation is supported, except that you can use uri method to pass in a valid uri string to avoid pass in protocol, host, hostname, path and port individually. Additionally, you can use common http method apis to spare the usage of method option api, such as get, post, put,del,patch and head.

Use send method to initiate a request, and a wrapped http.ClientRequest instance is returned, which exports several methods to work with streams conveniently.

wrapped clientRequest's api

pump

accepts duplex streams or writable stream

it returns the clientRequest instance itself for chaining invocation, and does not consume those streams until collect method is invoked.

collect

can accept a collector function as argument. This function should return a writable stream to collect stream data.

onResponse

if you want to mannually process response(http.IncomingMessage), use this api method to pass in a callback that accepts the response instance. The callback is only called after clientRequest emits the response event.

Example

var reqx = require('reqx');

reqx.get('https://www.google.com').send().collect().then(function(body){
  console.log(body);
});

reqx.get('https://www.baidu.com').pump(process.stdout).collect();

//request json

var concat = require('concat-stream');

reqx
  .post('http://api/getById')
  .headers({
    'Authorization': 'xxxx'
  })
  .send({
    id: xxx
  })
  .collect(function(res){
    if(res.statusCode < 400){
      return JSON.parse(body);
    }
    throw {
      statusCode: res.statusCode,
      headers: res.headers,
      body: body
    };
  })
  .then(function(result){
    
    console.log(result);
  })