aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/node_modules/undici/docs/api/ProxyAgent.md
diff options
context:
space:
mode:
authorEgor Tensin <egor@tensin.name>2026-02-28 21:59:12 +0100
committerEgor Tensin <egor@tensin.name>2026-02-28 22:19:57 +0100
commit9611c248995ad3bacda1d0a93d0b5e1e6605d162 (patch)
treeeb3ae35b426e9d72e7cb34e8e9cc0453745a8e17 /node_modules/undici/docs/api/ProxyAgent.md
parentDEVELOPMENT.md: expand on sources (diff)
downloadcleanup-path-9611c248995ad3bacda1d0a93d0b5e1e6605d162.tar.gz
cleanup-path-9611c248995ad3bacda1d0a93d0b5e1e6605d162.zip
upgrade actions/core to version 2
Diffstat (limited to 'node_modules/undici/docs/api/ProxyAgent.md')
-rw-r--r--node_modules/undici/docs/api/ProxyAgent.md126
1 files changed, 0 insertions, 126 deletions
diff --git a/node_modules/undici/docs/api/ProxyAgent.md b/node_modules/undici/docs/api/ProxyAgent.md
deleted file mode 100644
index cebfe68..0000000
--- a/node_modules/undici/docs/api/ProxyAgent.md
+++ /dev/null
@@ -1,126 +0,0 @@
-# Class: ProxyAgent
-
-Extends: `undici.Dispatcher`
-
-A Proxy Agent class that implements the Agent API. It allows the connection through proxy in a simple way.
-
-## `new ProxyAgent([options])`
-
-Arguments:
-
-* **options** `ProxyAgentOptions` (required) - It extends the `Agent` options.
-
-Returns: `ProxyAgent`
-
-### Parameter: `ProxyAgentOptions`
-
-Extends: [`AgentOptions`](Agent.md#parameter-agentoptions)
-
-* **uri** `string` (required) - It can be passed either by a string or a object containing `uri` as string.
-* **token** `string` (optional) - It can be passed by a string of token for authentication.
-* **auth** `string` (**deprecated**) - Use token.
-* **clientFactory** `(origin: URL, opts: Object) => Dispatcher` (optional) - Default: `(origin, opts) => new Pool(origin, opts)`
-* **requestTls** `BuildOptions` (optional) - Options object passed when creating the underlying socket via the connector builder for the request. See [TLS](https://nodejs.org/api/tls.html#tlsconnectoptions-callback).
-* **proxyTls** `BuildOptions` (optional) - Options object passed when creating the underlying socket via the connector builder for the proxy server. See [TLS](https://nodejs.org/api/tls.html#tlsconnectoptions-callback).
-
-Examples:
-
-```js
-import { ProxyAgent } from 'undici'
-
-const proxyAgent = new ProxyAgent('my.proxy.server')
-// or
-const proxyAgent = new ProxyAgent({ uri: 'my.proxy.server' })
-```
-
-#### Example - Basic ProxyAgent instantiation
-
-This will instantiate the ProxyAgent. It will not do anything until registered as the agent to use with requests.
-
-```js
-import { ProxyAgent } from 'undici'
-
-const proxyAgent = new ProxyAgent('my.proxy.server')
-```
-
-#### Example - Basic Proxy Request with global agent dispatcher
-
-```js
-import { setGlobalDispatcher, request, ProxyAgent } from 'undici'
-
-const proxyAgent = new ProxyAgent('my.proxy.server')
-setGlobalDispatcher(proxyAgent)
-
-const { statusCode, body } = await request('http://localhost:3000/foo')
-
-console.log('response received', statusCode) // response received 200
-
-for await (const data of body) {
- console.log('data', data.toString('utf8')) // data foo
-}
-```
-
-#### Example - Basic Proxy Request with local agent dispatcher
-
-```js
-import { ProxyAgent, request } from 'undici'
-
-const proxyAgent = new ProxyAgent('my.proxy.server')
-
-const {
- statusCode,
- body
-} = await request('http://localhost:3000/foo', { dispatcher: proxyAgent })
-
-console.log('response received', statusCode) // response received 200
-
-for await (const data of body) {
- console.log('data', data.toString('utf8')) // data foo
-}
-```
-
-#### Example - Basic Proxy Request with authentication
-
-```js
-import { setGlobalDispatcher, request, ProxyAgent } from 'undici';
-
-const proxyAgent = new ProxyAgent({
- uri: 'my.proxy.server',
- // token: 'Bearer xxxx'
- token: `Basic ${Buffer.from('username:password').toString('base64')}`
-});
-setGlobalDispatcher(proxyAgent);
-
-const { statusCode, body } = await request('http://localhost:3000/foo');
-
-console.log('response received', statusCode); // response received 200
-
-for await (const data of body) {
- console.log('data', data.toString('utf8')); // data foo
-}
-```
-
-### `ProxyAgent.close()`
-
-Closes the proxy agent and waits for registered pools and clients to also close before resolving.
-
-Returns: `Promise<void>`
-
-#### Example - clean up after tests are complete
-
-```js
-import { ProxyAgent, setGlobalDispatcher } from 'undici'
-
-const proxyAgent = new ProxyAgent('my.proxy.server')
-setGlobalDispatcher(proxyAgent)
-
-await proxyAgent.close()
-```
-
-### `ProxyAgent.dispatch(options, handlers)`
-
-Implements [`Agent.dispatch(options, handlers)`](Agent.md#parameter-agentdispatchoptions).
-
-### `ProxyAgent.request(options[, callback])`
-
-See [`Dispatcher.request(options [, callback])`](Dispatcher.md#dispatcherrequestoptions-callback).