httpreq

Donate

Install

npm install httpreq

Simple example

var httpreq = require('httpreq');

httpreq.get('http://www.google.com', function (err, res) {
  if (err) return console.log(err);

  console.log(res.statusCode);
  console.log(res.headers);
  console.log(res.body);
  console.log(res.cookies);
});

var httpreq = require('httpreq');

var res = await httpreq.get('http://www.google.com');

console.log(res.statusCode);
console.log(res.headers);
console.log(res.body);
console.log(res.cookies);

Use with async/await

var httpreq = require('httpreq');

var res = await httpreq.post('http://posttestserver.com/post.php', {
  parameters: {
    name: 'John',
    lastname: 'Doe'
  }
});

console.log(res.body);

How to use

• httpreq.get(url, options, callback)
• httpreq.post(url, options, callback)
• httpreq.put(url, options, callback)
• httpreq.delete(url, options, callback)
• httpreq.options(url, options, callback)
• Uploading files
• Downloading a binary file
• Downloading a file directly to disk
• Sending a custom body
• Using a http(s) proxy
• httpreq.doRequest(options, callback)

httpreq.get(url, options, callback)

- parameters: an object of query parameters
- headers: an object of headers
- cookies: an array of cookies
- auth: a string for basic authentication. For example `username:password`
- binary: true/false (default: false), if true, res.body will a buffer containing the binary data
- allowRedirects: (default: __true__ , only with httpreq.get() ), if true, redirects will be followed
- maxRedirects: (default: __10__ ). For example 1 redirect will allow for one normal request and 1 extra redirected request.
- timeout: (default: __none__ ). Adds a timeout to the http(s) request. Should be in milliseconds.
- ciphers: Change the TLS ciphers if needed.
- shuffleCiphers: Set to `true` if you want to shuffle the TLS ciphers to fight [TLS fingerprinting](https://httptoolkit.com/blog/tls-fingerprinting-node-js/).
- proxy, if you want to pass your request through a http(s) proxy server:
    - host: eg: "192.168.0.1"
    - port: eg: 8888
    - protocol: (default: __'http'__ ) can be 'http' or 'https'
 - rejectUnauthorized: validate certificate for request with HTTPS. [More here](http://nodejs.org/api/https.html#https_https_request_options_callback)

var httpreq = require('httpreq');

httpreq.get('http://www.google.com', function (err, res){
  if (err) return console.log(err);

  console.log(res.statusCode);
  console.log(res.headers);
  console.log(res.body);
});

var httpreq = require('httpreq');

httpreq.get('http://posttestserver.com/post.php', {
  parameters: {
    name: 'John',
    lastname: 'Doe'
  },
  headers:{
    'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:18.0) Gecko/20100101 Firefox/18.0'
  },
  cookies: [
    'token=DGcGUmplWQSjfqEvmu%2BZA%2Fc',
    'id=2'
  ]
}, function (err, res){
  if (err){
    console.log(err);
  }else{
    console.log(res.body);
  }
});

httpreq.post(url, options, callback)

- parameters: an object of post parameters (content-type is set to *application/x-www-form-urlencoded; charset=UTF-8*)
- json: if you want to send json directly (content-type is set to *application/json*)
- files: an object of files to upload (content-type is set to *multipart/form-data; boundary=xxx*)
- body: custom body content you want to send. If used, previous options will be ignored and your custom body will be sent. (content-type will not be set)
- headers: an object of headers
- cookies: an array of cookies
- auth: a string for basic authentication. For example `username:password`
- binary: true/false (default: __false__ ), if true, res.body will be a buffer containing the binary data
- allowRedirects: (default: __false__ ), if true, redirects will be followed
- maxRedirects: (default: __10__ ). For example 1 redirect will allow for one normal request and 1 extra redirected request.
- encodePostParameters: (default: __true__ ), if true, POST/PUT parameters names will be URL encoded.
- timeout: (default: none). Adds a timeout to the http(s) request. Should be in milliseconds.
- proxy, if you want to pass your request through a http(s) proxy server:
    - host: eg: "192.168.0.1"
    - port: eg: 8888
    - protocol: (default: __'http'__ ) can be 'http' or 'https'
- rejectUnauthorized: validate certificate for request with HTTPS. [More here](http://nodejs.org/api/https.html#https_https_request_options_callback)

var httpreq = require('httpreq');

httpreq.post('http://posttestserver.com/post.php', {
  parameters: {
    name: 'John',
    lastname: 'Doe'
  }
}, function (err, res){
  if (err){
    console.log(err);
  }else{
    console.log(res.body);
  }
});

var httpreq = require('httpreq');

httpreq.post('http://posttestserver.com/post.php', {
  parameters: {
    name: 'John',
    lastname: 'Doe'
  },
  headers:{
    'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:18.0) Gecko/20100101 Firefox/18.0'
  },
  cookies: [
    'token=DGcGUmplWQSjfqEvmu%2BZA%2Fc',
    'id=2'
  ]
}, function (err, res){
  if (err){
    console.log(err);
  }else{
    console.log(res.body);
  }
});

httpreq.put(url, options, callback)

httpreq.delete(url, options, callback)

httpreq.options(url, options, callback)

var httpreq = require('httpreq');

httpreq.post('http://posttestserver.com/upload.php', {
  parameters: {
    name: 'John',
    lastname: 'Doe'
  },
  files: {
    myfile: __dirname + '/file1.jpg',
    myotherfile: __dirname + '/file2.jpg'
  }
}, function (err, res){
  if (err) throw err;
});

var httpreq = require('httpreq');

httpreq.post('http://posttestserver.com/upload.php', {
  parameters: {
    name: 'John',
    lastname: 'Doe'
  },
  files: {
    myfiles: [__dirname + '/file1.jpg', __dirname + '/file.jpg']
  }
}, function (err, res){
  if (err) throw err;
});

Downloading a binary file

var httpreq = require('httpreq');

httpreq.get('https://ssl.gstatic.com/gb/images/k1_a31af7ac.png', {binary: true}, function (err, res){
  if (err){
    console.log(err);
  }else{
    fs.writeFile(__dirname + '/test.png', res.body, function (err) {
      if(err)
        console.log("error writing file");
    });
  }
});

Downloading a file directly to disk

var httpreq = require('httpreq');

httpreq.download(
  'https://ssl.gstatic.com/gb/images/k1_a31af7ac.png',
  __dirname + '/test.png'
, function (err, progress){
  if (err) return console.log(err);
  console.log(progress);
}, function (err, res){
  if (err) return console.log(err);
  console.log(res);
});

Sending a custom body

var httpreq = require('httpreq');

httpreq.post('http://posttestserver.com/post.php',{
  body: '<?xml version="1.0" encoding="UTF-8"?>',
  headers:{
    'Content-Type': 'text/xml',
  }},
  function (err, res) {
    if (err){
      console.log(err);
    }else{
      console.log(res.body);
    }
  }
);

Using a http(s) proxy

var httpreq = require('httpreq');

httpreq.post('http://posttestserver.com/post.php', {
  proxy: {
    host: '10.100.0.126',
    port: 8888
  }
}, function (err, res){
  if (err){
    console.log(err);
  }else{
    console.log(res.body);
  }
});

httpreq.doRequest(options, callback)

• url: the url to post the files to
• method: 'GET', 'POST', 'PUT' or 'DELETE'

Run tests

npm install

npm install mocha -g

mocha test/tests.js

mocha test/tests-async.js