diff options
| author | Adam Mathes <adam@adammathes.com> | 2026-02-13 21:34:48 -0800 |
|---|---|---|
| committer | Adam Mathes <adam@adammathes.com> | 2026-02-13 21:34:48 -0800 |
| commit | 76cb9c2a39d477a64824a985ade40507e3bbade1 (patch) | |
| tree | 41e997aa9c6f538d3a136af61dae9424db2005a9 /vanilla/node_modules/http-proxy-agent/README.md | |
| parent | 819a39a21ac992b1393244a4c283bbb125208c69 (diff) | |
| download | neko-76cb9c2a39d477a64824a985ade40507e3bbade1.tar.gz neko-76cb9c2a39d477a64824a985ade40507e3bbade1.tar.bz2 neko-76cb9c2a39d477a64824a985ade40507e3bbade1.zip | |
feat(vanilla): add testing infrastructure and tests (NK-wjnczv)
Diffstat (limited to 'vanilla/node_modules/http-proxy-agent/README.md')
| -rw-r--r-- | vanilla/node_modules/http-proxy-agent/README.md | 44 |
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 |
