Socket
Socket
Sign inDemoInstall

https-proxy-agent

Package Overview
Dependencies
3
Maintainers
1
Versions
34
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

https-proxy-agent

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


Version published
Maintainers
1
Weekly downloads
58,481,260
increased by5.1%
Bundle size
4.9 kB
Minified + gzipped

Weekly downloads

Package description

What is https-proxy-agent?

The https-proxy-agent package is a Node.js module that provides an http.Agent implementation that connects to a specified HTTP or HTTPS proxy server, and can be used with the http or https modules to make requests. It is particularly useful for making requests from behind a corporate firewall or when you need to use a proxy for requests for any other reason.

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

Creating an HTTPS proxy agent

This code sample demonstrates how to create an HTTPS proxy agent using the https-proxy-agent package and use it to make an HTTPS request.

const HttpsProxyAgent = require('https-proxy-agent');
const https = require('https');

const proxy = 'http://proxy-server:port';
const agent = new HttpsProxyAgent(proxy);

https.get({
  hostname: 'encrypted.google.com',
  path: '/',
  agent: agent
}, (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 https-proxy-agent

Readme

Source

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
import * as https from 'https';
import { HttpsProxyAgent } from 'https-proxy-agent';

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

https.get('https://example.com', { agent }, (res) => {
  console.log('"response" event!', res.headers);
  res.pipe(process.stdout);
});
ws WebSocket connection example
import WebSocket from 'ws';
import { HttpsProxyAgent } from 'https-proxy-agent';

const agent = new HttpsProxyAgent('http://168.63.76.32:3128');
const socket = new WebSocket('ws://echo.websocket.org', { agent });

socket.on('open', function () {
  console.log('"open" event!');
  socket.send('hello world');
});

socket.on('message', function (data, flags) {
  console.log('"message" event! %j %j', data, flags);
  socket.close();
});

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.

Keywords

FAQs

Last updated on 15 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc