http-proxy-agent

What is http-proxy-agent?

The http-proxy-agent package is used to provide an HTTP(s) proxy Agent which can be used with the http or https modules in Node.js. It allows you to proxy HTTP/HTTPS requests to another server, which is useful for various scenarios such as connecting through corporate firewalls, caching, or filtering.

What are http-proxy-agent's main functionalities?

Creating an HTTP proxy agent

This code sample demonstrates how to create an HTTP proxy agent with the http-proxy-agent package and use it to make a GET request to a target server through a proxy.

const HttpProxyAgent = require('http-proxy-agent');
const agent = new HttpProxyAgent('http://proxy-server.com:8080');
const http = require('http');

const requestOptions = {
  host: 'target-server.com',
  port: 80,
  path: '/',
  agent: agent
};

http.get(requestOptions, (res) => {
  console.log(`Got response: ${res.statusCode}`);
  // consume response body
  res.resume();
}).on('error', (e) => {
  console.error(`Got error: ${e.message}`);
});

Creating an HTTPS proxy agent

This code sample shows how to create an HTTPS proxy agent with the http-proxy-agent package to make a GET request to a secure target server through a proxy.

const HttpsProxyAgent = require('http-proxy-agent');
const agent = new HttpsProxyAgent('https://proxy-server.com:8080');
const https = require('https');

const requestOptions = {
  host: 'secure-target-server.com',
  port: 443,
  path: '/',
  agent: agent
};

https.get(requestOptions, (res) => {
  console.log(`Got response: ${res.statusCode}`);
  // consume response body
  res.resume();
}).on('error', (e) => {
  console.error(`Got error: ${e.message}`);
});

Other packages similar to http-proxy-agent

https-proxy-agent

The https-proxy-agent package provides similar functionality to http-proxy-agent but is specifically designed for HTTPS connections. It allows you to tunnel HTTPS requests through an HTTP proxy.

socks-proxy-agent

The socks-proxy-agent package is similar to http-proxy-agent but supports SOCKS proxy servers. It can be used to connect through SOCKS4, SOCKS4A, or SOCKS5 proxies.

proxy-agent

The proxy-agent package is a more general solution that supports multiple proxy protocols including HTTP, HTTPS, and SOCKS. It can automatically determine the correct agent to use based on the given proxy URL.

README

http-proxy-agent

An HTTP(s) proxy http.Agent implementation for HTTP

This module provides an http.Agent implementation that connects to a specified HTTP or HTTPS proxy server, and can be used with the built-in http module.

Note: For HTTP proxy usage with the https module, check out node-https-proxy-agent.

Installation

Install with npm:

$ npm install http-proxy-agent

Example

var url = require('url');
var http = require('http');
var HttpProxyAgent = require('http-proxy-agent');

// HTTP/HTTPS proxy to connect to
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128';
console.log('using proxy server %j', proxy);

// HTTP endpoint for the proxy to connect to
var endpoint = process.argv[2] || 'http://nodejs.org/api/';
console.log('attempting to GET %j', endpoint);
var opts = url.parse(endpoint);

// create an instance of the `HttpProxyAgent` class with the proxy server information
var agent = new HttpProxyAgent(proxy);
opts.agent = agent;

http.get(opts, function (res) {
  console.log('"response" event!', res.headers);
  res.pipe(process.stdout);
});

License

(The MIT License)

Copyright (c) 2013 Nathan Rajlich <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.