@yanglaofish/fishtools 0.5.2 → 0.6.0

package/node_modules/undici/docs/docs/api/Agent.md

@@ -1,291 +1,80 @@
 # Agent
 
-<!--introduced_in=v3.2.0-->
-<!--type=module-->
-<!-- source_link=lib/dispatcher/agent.js -->
+Extends: `undici.Dispatcher`
 
-> Stability: 2 - Stable
+Agent allow dispatching requests against multiple different origins.
 
-An `Agent` dispatches requests against multiple different origins, creating and
-reusing a per-origin [`Pool`][] (or [`Client`][]) on demand. It is the default
-dispatcher used by [`request`][], [`stream`][], and [`fetch`][] when no explicit
-dispatcher is supplied.
+Requests are not guaranteed to be dispatched in order of invocation.
 
-Requests are not guaranteed to be dispatched in their order of invocation.
+## `new undici.Agent([options])`
 
-```mjs
-import { Agent, setGlobalDispatcher } from 'undici'
+Arguments:
 
-const agent = new Agent({ connections: 10 })
-setGlobalDispatcher(agent)
-```
+* **options** `AgentOptions` (optional)
 
-## Class: `Agent`
+Returns: `Agent`
 
-<!-- YAML
-added: v3.2.0
--->
+### Parameter: `AgentOptions`
 
-* Extends: {Dispatcher}
+Extends: [`PoolOptions`](Pool.md#parameter-pooloptions)
 
-`Agent` keeps an internal map of origins to dispatchers. The first request to a
-given origin lazily creates a dispatcher through the configured `factory`, and
-subsequent requests to the same origin reuse it. Idle dispatchers are closed
-automatically once they have no open connections and are no longer busy.
+* **factory** `(origin: URL, opts: Object) => Dispatcher` - Default: `(origin, opts) => new Pool(origin, opts)`
+* **maxRedirections** `Integer` - Default: `0`. The number of HTTP redirection to follow unless otherwise specified in `DispatchOptions`.
+* **interceptors** `{ Agent: DispatchInterceptor[] }` - Default: `[RedirectInterceptor]` - A list of interceptors that are applied to the dispatch method. Additional logic can be applied (such as, but not limited to: 302 status code handling, authentication, cookies, compression and caching). Note that the behavior of interceptors is Experimental and might change at any given time.
 
-### `new Agent([options])`
+## Instance Properties
 
-<!-- YAML
-added: v3.2.0
-changes:
-  - version: v7.16.0
-    pr-url: https://github.com/nodejs/undici/pull/4365
-    description: Added the `maxOrigins` option to cap the number of origins.
--->
+### `Agent.closed`
 
-* `options` {AgentOptions} (optional) Extends {PoolOptions}.
-  * `factory` {Function} Builds the dispatcher used for a given origin. When the
-    resolved options contain `connections: 1`, the default factory creates a
-    {Client}; otherwise it creates a {Pool}. **Default:** `(origin, opts) => new Pool(origin, opts)`.
-    * `origin` {URL|string} The origin to create a dispatcher for.
-    * `opts` {Object} The resolved options for the new dispatcher.
-    * Returns: {Dispatcher}
-  * `maxOrigins` {number} Limits the total number of distinct origins that may
-    receive requests at the same time. A {MaxOriginsReachedError} is thrown when
-    a request targets a new origin once the limit is reached. When set to
-    `Infinity`, no limit is enforced. Must be a number greater than `0`.
-    **Default:** `Infinity`.
+Implements [Client.closed](Client.md#clientclosed)
 
-`Agent` inherits all {PoolOptions} (and therefore all {ClientOptions}). Each
-origin gets a separate {Pool}, with `connections` acting as the maximum number
-of clients that pool may create.
+### `Agent.destroyed`
 
-> [!NOTE]
-> For an h2-capable HTTPS origin, the per-origin pool waits for the first TLS
-> connection to finish ALPN negotiation. If the server selects h2, concurrent
-> requests share that session up to `maxConcurrentStreams`. If it selects
-> HTTP/1.1, normal connection fan-out resumes up to `connections`. See
-> {PoolOptions} and {ClientOptions} for inherited options such as `allowH2`
-> (default `true`) and `maxConcurrentStreams` (default `100`).
+Implements [Client.destroyed](Client.md#clientdestroyed)
 
-### `agent.closed`
+## Instance Methods
 
-<!-- YAML
-added: v3.2.0
--->
+### `Agent.close([callback])`
 
-* Type: {boolean}
+Implements [`Dispatcher.close([callback])`](Dispatcher.md#dispatcherclosecallback-promise).
 
-`true` after [`agent.close()`][] has been called.
+### `Agent.destroy([error, callback])`
 
-### `agent.destroyed`
+Implements [`Dispatcher.destroy([error, callback])`](Dispatcher.md#dispatcherdestroyerror-callback-promise).
 
-<!-- YAML
-added: v3.2.0
--->
+### `Agent.dispatch(options, handler: AgentDispatchOptions)`
 
-* Type: {boolean}
+Implements [`Dispatcher.dispatch(options, handler)`](Dispatcher.md#dispatcherdispatchoptions-handler).
 
-`true` after [`agent.destroy()`][] has been called, or after [`agent.close()`][]
-has been called and the shutdown has completed.
+#### Parameter: `AgentDispatchOptions`
 
-### `agent.stats`
+Extends: [`DispatchOptions`](Dispatcher.md#parameter-dispatchoptions)
 
-<!-- YAML
-added: v7.9.0
--->
+* **origin** `string | URL`
+* **maxRedirections** `Integer`.
 
-* Type: {Record<string, ClientStats|PoolStats>}
+Implements [`Dispatcher.destroy([error, callback])`](Dispatcher.md#dispatcherdestroyerror-callback-promise).
 
-Aggregate statistics for the agent, keyed by origin. Each value is the
-[`ClientStats`][] or [`PoolStats`][] object reported by the dispatcher currently
-serving that origin. Origins whose dispatcher does not expose `stats` are
-omitted.
+### `Agent.connect(options[, callback])`
 
-```mjs
-import { Agent } from 'undici'
+See [`Dispatcher.connect(options[, callback])`](Dispatcher.md#dispatcherconnectoptions-callback).
 
-const agent = new Agent()
-await agent.request({ origin: 'http://localhost:3000', path: '/', method: 'GET' })
-console.log(agent.stats)
-// { 'http://localhost:3000': PoolStats { ... } }
-```
+### `Agent.dispatch(options, handler)`
 
-### `agent.dispatch(options, handler)`
+Implements [`Dispatcher.dispatch(options, handler)`](Dispatcher.md#dispatcherdispatchoptions-handler).
 
-<!-- YAML
-added: v3.2.0
--->
+### `Agent.pipeline(options, handler)`
 
-* `options` {AgentDispatchOptions} Extends {DispatchOptions}.
-  * `origin` {string|URL} The origin to dispatch the request against. Required.
-* `handler` {DispatchHandler}
-* Returns: {boolean} `false` if the dispatcher is busy and the caller should
-  wait for the [`'drain'`][] event before dispatching again.
+See [`Dispatcher.pipeline(options, handler)`](Dispatcher.md#dispatcherpipelineoptions-handler).
 
-Routes the request to the dispatcher for `options.origin`, creating one through
-the `factory` if needed. Throws an {InvalidArgumentError} when `options.origin`
-is not a non-empty string or {URL}, and a {MaxOriginsReachedError} when a new
-origin would exceed `maxOrigins`. Implements [`Dispatcher.dispatch()`][].
+### `Agent.request(options[, callback])`
 
-### `agent.close([callback])`
+See [`Dispatcher.request(options [, callback])`](Dispatcher.md#dispatcherrequestoptions-callback).
 
-<!-- YAML
-added: v3.2.0
--->
+### `Agent.stream(options, factory[, callback])`
 
-* `callback` {Function} (optional) Invoked once every per-origin dispatcher has
-  closed. When omitted, a {Promise} is returned.
-* Returns: {Promise|void}
+See [`Dispatcher.stream(options, factory[, callback])`](Dispatcher.md#dispatcherstreamoptions-factory-callback).
 
-Gracefully closes the agent and every dispatcher it owns, waiting for in-flight
-requests to complete. Implements [`Dispatcher.close()`][].
+### `Agent.upgrade(options[, callback])`
 
-### `agent.destroy([error[, callback]])`
-
-<!-- YAML
-added: v3.2.0
--->
-
-* `error` {Error} (optional) The error to abort pending requests with.
-* `callback` {Function} (optional) Invoked once every per-origin dispatcher has
-  been destroyed. When omitted, a {Promise} is returned.
-* Returns: {Promise|void}
-
-Forcefully destroys the agent and every dispatcher it owns, aborting all pending
-requests. Implements [`Dispatcher.destroy()`][].
-
-### `agent.connect(options[, callback])`
-
-<!-- YAML
-added: v3.2.0
--->
-
-See [`Dispatcher.connect()`][]. The request is routed to the dispatcher for
-`options.origin`.
-
-### `agent.pipeline(options, handler)`
-
-<!-- YAML
-added: v3.2.0
--->
-
-See [`Dispatcher.pipeline()`][]. The request is routed to the dispatcher for
-`options.origin`.
-
-### `agent.request(options[, callback])`
-
-<!-- YAML
-added: v3.2.0
--->
-
-See [`Dispatcher.request()`][]. The request is routed to the dispatcher for
-`options.origin`.
-
-```mjs
-import { Agent } from 'undici'
-
-const agent = new Agent()
-const { statusCode, body } = await agent.request({
-  origin: 'http://localhost:3000',
-  path: '/',
-  method: 'GET',
-})
-
-console.log('response received', statusCode)
-console.log('data', await body.text())
-```
-
-### `agent.stream(options, factory[, callback])`
-
-<!-- YAML
-added: v3.2.0
--->
-
-See [`Dispatcher.stream()`][]. The request is routed to the dispatcher for
-`options.origin`.
-
-### `agent.upgrade(options[, callback])`
-
-<!-- YAML
-added: v3.2.0
--->
-
-See [`Dispatcher.upgrade()`][]. The request is routed to the dispatcher for
-`options.origin`.
-
-### Event: `'connect'`
-
-<!-- YAML
-added: v6.6.0
--->
-
-* `origin` {URL}
-* `targets` {Array<Dispatcher>} The dispatchers involved, starting with this
-  `Agent` followed by the per-origin dispatcher chain.
-
-Emitted when a socket has been created for an origin and is ready to receive
-requests. Forwarded from the underlying dispatcher's [`'connect'`][] event.
-
-### Event: `'disconnect'`
-
-<!-- YAML
-added: v6.6.0
--->
-
-* `origin` {URL}
-* `targets` {Array<Dispatcher>} The dispatchers involved, starting with this
-  `Agent`.
-* `error` {Error}
-
-Emitted when a socket for an origin has disconnected. Forwarded from the
-underlying dispatcher's [`'disconnect'`][] event.
-
-### Event: `'connectionError'`
-
-<!-- YAML
-added: v6.6.0
--->
-
-* `origin` {URL}
-* `targets` {Array<Dispatcher>} The dispatchers involved, starting with this
-  `Agent`.
-* `error` {Error}
-
-Emitted when a connection attempt for an origin fails. Forwarded from the
-underlying dispatcher's [`'connectionError'`][] event.
-
-### Event: `'drain'`
-
-<!-- YAML
-added: v6.6.0
--->
-
-* `origin` {URL}
-* `targets` {Array<Dispatcher>} The dispatchers involved, starting with this
-  `Agent`.
-
-Emitted when an origin's dispatcher is no longer busy and can accept more
-requests. Forwarded from the underlying dispatcher's [`'drain'`][] event.
-
-[`'connect'`]: Dispatcher.md#event-connect
-[`'connectionError'`]: Dispatcher.md#event-connectionerror
-[`'disconnect'`]: Dispatcher.md#event-disconnect
-[`'drain'`]: Dispatcher.md#event-drain
-[`Client`]: Client.md#class-client
-[`ClientStats`]: ClientStats.md
-[`Dispatcher.close()`]: Dispatcher.md#dispatcherclosecallback-promise
-[`Dispatcher.connect()`]: Dispatcher.md#dispatcherconnectoptions-callback
-[`Dispatcher.destroy()`]: Dispatcher.md#dispatcherdestroyerror-callback-promise
-[`Dispatcher.dispatch()`]: Dispatcher.md#dispatcherdispatchoptions-handler
-[`Dispatcher.pipeline()`]: Dispatcher.md#dispatcherpipelineoptions-handler
-[`Dispatcher.request()`]: Dispatcher.md#dispatcherrequestoptions-callback
-[`Dispatcher.stream()`]: Dispatcher.md#dispatcherstreamoptions-factory-callback
-[`Dispatcher.upgrade()`]: Dispatcher.md#dispatcherupgradeoptions-callback
-[`Pool`]: Pool.md#class-pool
-[`PoolStats`]: PoolStats.md
-[`agent.close()`]: #agentclosecallback
-[`agent.destroy()`]: #agentdestroyerror-callback
-[`fetch`]: Fetch.md
-[`request`]: Dispatcher.md#dispatcherrequestoptions-callback
-[`stream`]: Dispatcher.md#dispatcherstreamoptions-factory-callback
+See [`Dispatcher.upgrade(options[, callback])`](Dispatcher.md#dispatcherupgradeoptions-callback).

package/node_modules/undici/docs/docs/api/BalancedPool.md

@@ -1,297 +1,99 @@
-# BalancedPool
+# Class: BalancedPool
 
-<!--introduced_in=v4.8.0-->
-<!--type=module-->
-<!-- source_link=lib/dispatcher/balanced-pool.js -->
+Extends: `undici.Dispatcher`
 
-> Stability: 2 - Stable
+A pool of [Pool](Pool.md) instances connected to multiple upstreams.
 
-A `BalancedPool` distributes requests across a set of {Pool} instances, each
-connected to a different upstream. It uses a weighted round-robin algorithm:
-every upstream starts with the same weight, and the weight is adjusted up on
-successful connections and down on connection errors, so that healthy upstreams
-receive a larger share of traffic.
+Requests are not guaranteed to be dispatched in order of invocation.
 
-Requests are not guaranteed to be dispatched in the order they are issued.
+## `new BalancedPool(upstreams [, options])`
 
-```mjs
-import { BalancedPool } from 'undici'
+Arguments:
 
-const pool = new BalancedPool([
-  'http://localhost:3000',
-  'http://localhost:3001',
-  'http://localhost:3002',
-])
+* **upstreams** `URL | string | string[]` - It should only include the **protocol, hostname, and port**.
+* **options** `BalancedPoolOptions` (optional)
 
-const { statusCode, body } = await pool.request({
-  path: '/',
-  method: 'GET',
-})
-console.log('response received', statusCode)
-for await (const chunk of body) {
-  console.log('data', chunk.toString())
-}
-```
+### Parameter: `BalancedPoolOptions`
 
-## Class: `BalancedPool`
+Extends: [`PoolOptions`](Pool.md#parameter-pooloptions)
 
-<!-- YAML
-added: v4.8.0
-changes:
-  - version: v4.10.4
-    pr-url: https://github.com/nodejs/undici/pull/1114
-    description: Introduced the `BalancedPool` class.
--->
+* **factory** `(origin: URL, opts: Object) => Dispatcher` - Default: `(origin, opts) => new Pool(origin, opts)`
 
-* Extends: {Dispatcher}
+The `PoolOptions` are passed to each of the `Pool` instances being created.
+## Instance Properties
 
-A pool of {Pool} instances connected to multiple upstreams.
+### `BalancedPool.upstreams`
 
-### `new BalancedPool(upstreams[, options])`
+Returns an array of upstreams that were previously added.
 
-<!-- YAML
-added: v4.8.0
-changes:
-  - version: v4.15.0
-    pr-url: https://github.com/nodejs/undici/pull/1237
-    description: Added the `factory` option.
--->
+### `BalancedPool.closed`
 
-* `upstreams` {URL|string|URL[]|string[]} One or more upstream origins. Each
-  value should only include the **protocol, hostname, and port**. **Default:**
-  `[]`.
-* `options` {BalancedPoolOptions} (optional)
+Implements [Client.closed](Client.md#clientclosed)
 
-The options passed to the constructor are forwarded to every {Pool} instance
-that is created for an upstream.
+### `BalancedPool.destroyed`
 
-#### Parameter: `BalancedPoolOptions`
+Implements [Client.destroyed](Client.md#clientdestroyed)
 
-Extends: {PoolOptions}
+### `Pool.stats`
 
-In addition to all {PoolOptions}, the following options are supported:
+Returns [`PoolStats`](PoolStats.md) instance for this pool.
 
-* `factory` {Function} A function used to create the {Pool} instance for each
-  upstream. **Default:** `(origin, opts) => new Pool(origin, opts)`.
-  * `origin` {URL|string} The upstream origin.
-  * `opts` {Object} The options object derived from the constructor options.
-  * Returns: {Dispatcher}
-* `maxWeightPerServer` {number} The maximum weight any single upstream can
-  reach. Successful connections increase an upstream's weight up to this value.
-  **Default:** `100`.
-* `errorPenalty` {number} The amount by which an upstream's weight is decreased
-  on a connection error and increased on a successful connection. **Default:**
-  `15`.
+## Instance Methods
 
-### `balancedPool.addUpstream(upstream)`
+### `BalancedPool.addUpstream(upstream)`
 
-<!-- YAML
-added: v4.8.0
--->
+Add an upstream.
 
-* `upstream` {URL|string} The upstream origin to add. It should only include the
-  **protocol, hostname, and port**.
-* Returns: {BalancedPool} The `BalancedPool` instance, for chaining.
+Arguments:
 
-Adds an upstream. If an open, non-destroyed upstream with the same origin is
-already present, the call is a no-op.
+* **upstream** `string` - It should only include the **protocol, hostname, and port**.
 
-### `balancedPool.removeUpstream(upstream)`
+### `BalancedPool.removeUpstream(upstream)`
 
-<!-- YAML
-added: v4.8.0
--->
+Removes an upstream that was previously added.
 
-* `upstream` {URL|string} The upstream origin to remove. It should only include
-  the **protocol, hostname, and port**.
-* Returns: {BalancedPool} The `BalancedPool` instance, for chaining.
+### `BalancedPool.close([callback])`
 
-Removes an upstream that was previously added. If no matching upstream is found,
-the call is a no-op.
+Implements [`Dispatcher.close([callback])`](Dispatcher.md#dispatcherclosecallback-promise).
 
-### `balancedPool.getUpstream(upstream)`
+### `BalancedPool.destroy([error, callback])`
 
-<!-- YAML
-added: v7.17.0
--->
+Implements [`Dispatcher.destroy([error, callback])`](Dispatcher.md#dispatcherdestroyerror-callback-promise).
 
-* `upstream` {URL|string} The upstream origin to look up. It should only include
-  the **protocol, hostname, and port**.
-* Returns: {Pool|undefined} The {Pool} instance managing the given upstream, or
-  `undefined` if it is not present.
+### `BalancedPool.connect(options[, callback])`
 
-Returns the {Pool} instance for the given upstream origin, if it is open and not
-destroyed.
+See [`Dispatcher.connect(options[, callback])`](Dispatcher.md#dispatcherconnectoptions-callback).
 
-### `balancedPool.upstreams`
+### `BalancedPool.dispatch(options, handlers)`
 
-<!-- YAML
-added: v4.8.0
--->
+Implements [`Dispatcher.dispatch(options, handlers)`](Dispatcher.md#dispatcherdispatchoptions-handler).
 
-* Type: {string[]} The origins of the upstreams that are currently open and not
-  destroyed.
+### `BalancedPool.pipeline(options, handler)`
 
-### `balancedPool.closed`
+See [`Dispatcher.pipeline(options, handler)`](Dispatcher.md#dispatcherpipelineoptions-handler).
 
-<!-- YAML
-added: v4.8.0
-changes:
-  - version: v4.10.4
-    pr-url: https://github.com/nodejs/undici/pull/1114
-    description: Introduced the `BalancedPool` class.
--->
+### `BalancedPool.request(options[, callback])`
 
-* Type: {boolean} `true` after `balancedPool.close()` has been called.
+See [`Dispatcher.request(options [, callback])`](Dispatcher.md#dispatcherrequestoptions-callback).
 
-Implements [`client.closed`][].
+### `BalancedPool.stream(options, factory[, callback])`
 
-### `balancedPool.destroyed`
+See [`Dispatcher.stream(options, factory[, callback])`](Dispatcher.md#dispatcherstreamoptions-factory-callback).
 
-<!-- YAML
-added: v4.8.0
-changes:
-  - version: v4.10.4
-    pr-url: https://github.com/nodejs/undici/pull/1114
-    description: Introduced the `BalancedPool` class.
--->
+### `BalancedPool.upgrade(options[, callback])`
 
-* Type: {boolean} `true` after `balancedPool.destroy()` has been called, or after
-  `balancedPool.close()` has been called and the shutdown has completed.
+See [`Dispatcher.upgrade(options[, callback])`](Dispatcher.md#dispatcherupgradeoptions-callback).
 
-Implements [`client.destroyed`][].
-
-### `balancedPool.stats`
-
-<!-- YAML
-added: v4.8.0
--->
-
-* Type: {PoolStats}
-
-Returns a {PoolStats} instance aggregating the statistics of the underlying
-pools.
-
-### `balancedPool.close([callback])`
-
-<!-- YAML
-added: v4.8.0
--->
-
-Implements [`Dispatcher.close([callback])`][].
-
-### `balancedPool.destroy([error[, callback]])`
-
-<!-- YAML
-added: v4.8.0
--->
-
-Implements [`Dispatcher.destroy([error, callback])`][].
-
-### `balancedPool.connect(options[, callback])`
-
-<!-- YAML
-added: v4.8.0
--->
-
-See [`Dispatcher.connect(options[, callback])`][].
-
-### `balancedPool.dispatch(options, handlers)`
-
-<!-- YAML
-added: v4.8.0
-changes:
-  - version: v4.10.4
-    pr-url: https://github.com/nodejs/undici/pull/1114
-    description: Introduced the `BalancedPool` class.
--->
-
-Implements [`Dispatcher.dispatch(options, handler)`][].
-
-### `balancedPool.pipeline(options, handler)`
-
-<!-- YAML
-added: v4.8.0
--->
-
-See [`Dispatcher.pipeline(options, handler)`][].
-
-### `balancedPool.request(options[, callback])`
-
-<!-- YAML
-added: v4.8.0
--->
-
-See [`Dispatcher.request(options[, callback])`][].
-
-### `balancedPool.stream(options, factory[, callback])`
-
-<!-- YAML
-added: v4.8.0
--->
-
-See [`Dispatcher.stream(options, factory[, callback])`][].
-
-### `balancedPool.upgrade(options[, callback])`
-
-<!-- YAML
-added: v4.8.0
--->
-
-See [`Dispatcher.upgrade(options[, callback])`][].
+## Instance Events
 
 ### Event: `'connect'`
 
-<!-- YAML
-added: v4.8.0
-changes:
-  - version: v4.10.4
-    pr-url: https://github.com/nodejs/undici/pull/1114
-    description: Introduced the `BalancedPool` class.
-  - version: v5.8.0
-    pr-url: https://github.com/nodejs/undici/pull/1069
-    description: Adopted weighted round-robin selection across upstreams.
--->
-
-See [Dispatcher Event: `'connect'`][].
+See [Dispatcher Event: `'connect'`](Dispatcher.md#event-connect).
 
 ### Event: `'disconnect'`
 
-<!-- YAML
-added: v4.8.0
-changes:
-  - version: v4.10.4
-    pr-url: https://github.com/nodejs/undici/pull/1114
-    description: Introduced the `BalancedPool` class.
-  - version: v5.8.0
-    pr-url: https://github.com/nodejs/undici/pull/1069
-    description: Adopted weighted round-robin selection across upstreams.
--->
-
-See [Dispatcher Event: `'disconnect'`][].
+See [Dispatcher Event: `'disconnect'`](Dispatcher.md#event-disconnect).
 
 ### Event: `'drain'`
 
-<!-- YAML
-added: v4.8.0
-changes:
-  - version: v4.10.4
-    pr-url: https://github.com/nodejs/undici/pull/1114
-    description: Introduced the `BalancedPool` class.
--->
-
-See [Dispatcher Event: `'drain'`][].
-
-[Dispatcher Event: `'connect'`]: Dispatcher.md#event-connect
-[Dispatcher Event: `'disconnect'`]: Dispatcher.md#event-disconnect
-[Dispatcher Event: `'drain'`]: Dispatcher.md#event-drain
-[`Dispatcher.close([callback])`]: Dispatcher.md#dispatcherclosecallback-promise
-[`Dispatcher.connect(options[, callback])`]: Dispatcher.md#dispatcherconnectoptions-callback
-[`Dispatcher.destroy([error, callback])`]: Dispatcher.md#dispatcherdestroyerror-callback-promise
-[`Dispatcher.dispatch(options, handler)`]: Dispatcher.md#dispatcherdispatchoptions-handler
-[`Dispatcher.pipeline(options, handler)`]: Dispatcher.md#dispatcherpipelineoptions-handler
-[`Dispatcher.request(options[, callback])`]: Dispatcher.md#dispatcherrequestoptions-callback
-[`Dispatcher.stream(options, factory[, callback])`]: Dispatcher.md#dispatcherstreamoptions-factory-callback
-[`Dispatcher.upgrade(options[, callback])`]: Dispatcher.md#dispatcherupgradeoptions-callback
-[`client.closed`]: Client.md#clientclosed
-[`client.destroyed`]: Client.md#clientdestroyed
+See [Dispatcher Event: `'drain'`](Dispatcher.md#event-drain).