https-proxy-agent

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

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 https module.

Specifically, this Agent implementation connects to an intermediary "proxy" server and issues the CONNECT HTTP method, which tells the proxy to open a direct TCP connection to the destination server.

Since this agent implements the CONNECT HTTP method, it also works with other protocols that use this method when connecting over proxies (i.e. WebSockets). See the "Examples" section below for more.

Examples

https module example

1import * as https from 'https';
2import { HttpsProxyAgent } from 'https-proxy-agent';
3
4const agent = new HttpsProxyAgent('http://168.63.76.32:3128');
5
6https.get('https://example.com', { agent }, (res) => {
7  console.log('"response" event!', res.headers);
8  res.pipe(process.stdout);
9});

ws WebSocket connection example

1import WebSocket from 'ws';
2import { HttpsProxyAgent } from 'https-proxy-agent';
3
4const agent = new HttpsProxyAgent('http://168.63.76.32:3128');
5const socket = new WebSocket('ws://echo.websocket.org', { agent });
6
7socket.on('open', function () {
8  console.log('"open" event!');
9  socket.send('hello world');
10});
11
12socket.on('message', function (data, flags) {
13  console.log('"message" event! %j %j', data, flags);
14  socket.close();
15});

API

new HttpsProxyAgent(proxy: string | URL, options?: HttpsProxyAgentOptions)

The HttpsProxyAgent class implements an http.Agent subclass that connects to the specified "HTTP(s) proxy server" in order to proxy HTTPS and/or WebSocket requests. This is achieved by using the HTTP CONNECT method.

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 the CONNECT request.