proxy-agent - npm explorer

proxy-agent
===========

$3

This module provides an http.Agent implementation which automatically uses
proxy servers based off of the various proxy-related environment variables
(HTTP_PROXY, HTTPS_PROXY and NO_PROXY among others).

Which proxy is used for each HTTP request is determined by the
proxy-from-env module, so
check its documentation for instructions on configuring your environment variables.

An LRU cache is used so that http.Agent instances are transparently re-used for
subsequent HTTP requests to the same proxy server.

The currently implemented protocol mappings are listed in the table below:

Example
-------

``ts import * as https from 'https'; import { ProxyAgent } from 'proxy-agent';

// The correct proxy Agentimplementation to use will be determined // via thehttp_proxy / https_proxy / no_proxy/ etc. env vars const agent = new ProxyAgent();

// The rest works just like any other normal HTTP request https.get('https://jsonip.com', { agent }, (res) => { console.log(res.statusCode, res.headers); res.pipe(process.stdout); });`

API ---

`$3`

Creates an http.Agentinstance which relies on the various proxy-related environment variables. An LRU cache is used, so the samehttp.Agent` instance
will be returned if identical args are passed in.

[http-proxy-agent]: ../http-proxy-agent
[https-proxy-agent]: ../https-proxy-agent
[socks-proxy-agent]: ../socks-proxy-agent
[pac-proxy-agent]: ../pac-proxy-agent