tegwick
c5a5b26797
Some checks failed
Test Suite / code-quality (push) Has been cancelled
Test Suite / unit-tests (3.11) (push) Has been cancelled
Test Suite / unit-tests (3.12) (push) Has been cancelled
Test Suite / security-scan (push) Has been cancelled
Test Suite / integration-tests (push) Has been cancelled
Test Suite / e2e-tests (push) Has been cancelled
Test Suite / performance-tests (push) Has been cancelled
Test Suite / test-summary (push) Has been cancelled
44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
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. |