aboutsummaryrefslogtreecommitdiffstats
path: root/vanilla/node_modules/http-proxy-agent/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vanilla/node_modules/http-proxy-agent/README.md')
-rw-r--r--vanilla/node_modules/http-proxy-agent/README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/vanilla/node_modules/http-proxy-agent/README.md b/vanilla/node_modules/http-proxy-agent/README.md
new file mode 100644
index 0000000..4eb0732
--- /dev/null
+++ b/vanilla/node_modules/http-proxy-agent/README.md
@@ -0,0 +1,44 @@
+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`](../https-proxy-agent).
+
+
+Example
+-------
+
+```ts
+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. \ No newline at end of file