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 https-proxy-agent.

Example

import * as http from 'http';
import { HttpProxyAgent } from 'http-proxy-agent';

const agent = new HttpProxyAgent('http://168.63.76.32:3128');

http.get('http://nodejs.org/api/', { agent }, (res) => {
  console.log('"response" event!', res.headers);
  res.pipe(process.stdout);
});

API

new HttpProxyAgent(proxy: string | URL, options?: HttpProxyAgentOptions)

The HttpProxyAgent class implements an http.Agent subclass that connects to the specified "HTTP(s) proxy server" in order to proxy HTTP requests.

The proxy argument is the URL for the proxy server.

The options argument accepts the usual http.Agent constructor options, and some additional properties:

• headers - Object containing additional headers to send to the proxy server in each request. This may also be a function that returns a headers object.

  NOTE: If your proxy does not strip these headers from the request, they will also be sent to the destination server.