undici 8.11.2 → 8.12.0

package/README.md

@@ -86,6 +86,24 @@ Using [benchmark-http2.js](https://github.com/nodejs/undici/blob/main/benchmarks
 
 Node.js includes a built-in `fetch()` implementation powered by undici starting from Node.js v18. However, there are important differences between using the built-in fetch and installing undici as a separate module.
 
+### WebAssembly requirement
+
+Undici's HTTP/1 parser requires WebAssembly. There is no alternative parser when
+WebAssembly is unavailable, for example in Node.js configurations where
+`--jitless` disables it. The existence of `fetch` does not imply that it can make
+HTTP/1 requests in that environment.
+
+When the HTTP/1 parser is needed without WebAssembly, Client and dispatcher
+requests fail with an `Error` whose code is `ERR_WEBASSEMBLY_NOT_SUPPORTED`.
+`fetch` rejects with a `TypeError` carrying that error in `error.cause`. Importing
+Undici, accessing `fetch`, and using `Headers`, `FormData`, `Request`, or `Response`
+do not themselves require the HTTP/1 parser.
+
+The error is defined locally in Undici and does not depend on Node.js providing
+that error code. For built-in fetch, this behavior depends on the bundled Undici
+version. Node.js receives upstream fixes through its normal vendored Undici
+update, rather than changes to the generated bundle alone.
+
 ### Built-in Fetch (Node.js v18+)
 
 Node.js's built-in fetch is powered by a bundled version of undici:
@@ -773,14 +791,18 @@ and `undici.Agent`) which will enable the family autoselection algorithm when es
 
 ## Collaborators
 
-* [__Daniele Belardi__](https://github.com/dnlup), <https://www.npmjs.com/~dnlup>
-* [__Ethan Arrowood__](https://github.com/ethan-arrowood), <https://www.npmjs.com/~ethan_arrowood>
+* [__Aras Abbasi__](https://github.com/Uzlopak)
+* [__Carlos Fuentes__](https://github.com/metcoder95), <https://www.npmjs.com/~metcoder95>
+* [__Ethan Arrowood__](https://github.com/Ethan-Arrowood), <https://www.npmjs.com/~ethan_arrowood>
 * [__Matteo Collina__](https://github.com/mcollina), <https://www.npmjs.com/~matteo.collina>
 * [__Matthew Aitken__](https://github.com/KhafraDev), <https://www.npmjs.com/~khaf>
+* [__Mert Can Altin__](https://github.com/mertcanaltin), <https://www.npmjs.com/~mertcanaltin>
 * [__Robert Nagy__](https://github.com/ronag), <https://www.npmjs.com/~ronag>
-* [__Szymon Marczak__](https://github.com/szmarczak), <https://www.npmjs.com/~szmarczak>
+* [__Trivikram Kamat__](https://github.com/trivikr), <https://www.npmjs.com/~trivikr>
+* [__tsctx__](https://github.com/tsctx)
 
 ## Past Collaborators
+* [__Szymon Marczak__](https://github.com/szmarczak), <https://www.npmjs.com/~szmarczak>
 * [__Tomas Della Vedova__](https://github.com/delvedor), <https://www.npmjs.com/~delvedor>
 
 ### Releasers

package/docs/docs/api/CacheStore.md

@@ -42,7 +42,8 @@ added: v7.0.0
 Stores cached responses in memory. The store enforces upper bounds on the total
 number of responses, the total size of all responses, and the size of any single
 response. When a limit is exceeded, the store evicts approximately half of its
-entries and emits a [`'maxSizeExceeded'`](#event-maxsizeexceeded) event.
+entries, least recently used first, and emits a
+[`'maxSizeExceeded'`](#event-maxsizeexceeded) event.
 
 ```mjs
 import { interceptors, cacheStores, Agent, setGlobalDispatcher } from 'undici'
@@ -163,7 +164,9 @@ added: v7.0.0
 -->
 
 Stores cached responses in a SQLite database using the [`node:sqlite`][] API.
-The constructor throws when [`node:sqlite`][] is not available.
+The constructor throws when [`node:sqlite`][] is not available. Response bodies
+larger than `compressThreshold` are stored compressed with zstd and
+decompressed when read back, saving database space.
 
 ```mjs
 import { interceptors, cacheStores, Agent, setGlobalDispatcher } from 'undici'
@@ -189,9 +192,16 @@ added: v7.0.0
   * `maxEntrySize` {number} The maximum size, in bytes, of a single response
     body. Responses whose body exceeds this value are not cached. Must not
     exceed `2000000000` (2 GB). **Default:** `2000000000` (2 GB).
+  * `compressThreshold` {number} The size, in bytes, above which a response
+    body is stored compressed with zstd. Responses with an easily compressible
+    Content-Type (e.g. json, xml, plain text) are compressed regardless of
+    size. Requires a Node version with zstd
+    support (22.19+); when unavailable, bodies are stored uncompressed.
+    **Default:** `1048576` (1 MiB).
 
-`maxCount` and `maxEntrySize` must be non-negative integers; a `TypeError` is
-thrown otherwise, or if `maxEntrySize` is greater than 2 GB.
+`maxCount`, `maxEntrySize`, and `compressThreshold` must be non-negative
+integers; a `TypeError` is thrown otherwise, or if `maxEntrySize` is greater
+than 2 GB.
 
 ### `sqliteCacheStore.close()`
 
@@ -225,7 +235,8 @@ added: v7.0.0
   See [`GetResult`](#getresult).
 
 Looks up a cached response for `key`, comparing the request method and every
-header named in the stored `vary` map.
+header named in the stored `vary` map. A body that was stored compressed is
+decompressed before being returned.
 
 ### `sqliteCacheStore.set(key, value)`
 
@@ -240,9 +251,11 @@ added: v7.0.0
 * Returns: {undefined}
 
 Writes a response into the database directly, without going through a stream. If
-the body exceeds `maxEntrySize`, nothing is stored. When an entry already exists
-for `key` it is overwritten; otherwise a new row is inserted and old entries are
-pruned to honour `maxCount`. This method is used internally by
+the body exceeds `maxEntrySize`, nothing is stored. A body larger than
+`compressThreshold`, or with an easily compressible Content-Type (e.g. json,
+xml, plain text), is compressed with zstd before being written. When an entry
+already exists for `key` it is overwritten; otherwise a new row is inserted and
+old entries are pruned to honour `maxCount`. This method is used internally by
 [`sqliteCacheStore.createWriteStream()`](#sqlitecachestorecreatewritestreamkey-value).
 
 ### `sqliteCacheStore.createWriteStream(key, value)`
@@ -260,7 +273,9 @@ added: v7.0.0
 
 Returns a {Writable} stream used to write the response body into the store. When
 the stream finishes, the buffered body is committed via
-[`sqliteCacheStore.set()`](#sqlitecachestoresetkey-value). If the body exceeds
+[`sqliteCacheStore.set()`](#sqlitecachestoresetkey-value), where bodies larger
+than `compressThreshold` or with an easily compressible Content-Type are
+compressed with zstd. If the body exceeds
 `maxEntrySize`, the stream is destroyed and nothing is stored.
 
 ### `sqliteCacheStore.delete(key)`

package/docs/docs/api/Client.md

@@ -116,8 +116,8 @@ added: v1.0.0
   * `maxConcurrentStreams` {number} _Deprecated: use h2Options.useH2c instead_ The maximum number of concurrent HTTP/2
     streams for a single session. Once h2 is negotiated this — not `pipelining`,
     which is HTTP/1.1 only — is the ceiling used to dispatch in-flight requests.
-    It may be overridden by the server's `SETTINGS_MAX_CONCURRENT_STREAMS`
-    frame. **Default:** `100`.
+    The server's `SETTINGS_MAX_CONCURRENT_STREAMS` can lower this limit, but
+    not raise it. **Default:** `100`.
   * `connectionWindowSize` {number} _Deprecated: use h2Options.connectionWindowSize instead_ The HTTP/2 connection-level flow-control
     window size set via `ClientHttp2Session.setLocalWindowSize()`. Must be a
     positive integer. **Default:** `524288`.
@@ -130,8 +130,8 @@ added: v1.0.0
     * `maxConcurrentStreams` {number} The maximum number of concurrent HTTP/2
       streams for a single session. Once h2 is negotiated this — not `pipelining`,
       which is HTTP/1.1 only — is the ceiling used to dispatch in-flight requests.
-      It may be overridden by the server's `SETTINGS_MAX_CONCURRENT_STREAMS`
-      frame. **Default:** `100`.
+      The server's `SETTINGS_MAX_CONCURRENT_STREAMS` can lower this limit, but
+      not raise it. **Default:** `100`.
     * `connectionWindowSize` {number} The HTTP/2 connection-level flow-control
       window size set via `ClientHttp2Session.setLocalWindowSize()`. Must be a
       positive integer. **Default:** `524288`.

package/docs/docs/api/Dispatcher.md

@@ -209,6 +209,9 @@ added: v4.0.0
   * `path` {string} The request path.
   * `method` {string} The HTTP method, e.g. `'GET'` or `'POST'`.
   * `body` {string|Buffer|Uint8Array|Readable|FormData|null} The request body.
+    Undici's network clients require a `FormData` body created by the same
+    undici package instance. A body from another source, including Node.js's
+    built-in `FormData`, is rejected with an `InvalidArgumentError`.
     **Default:** `null`.
   * `headers` {UndiciHeaders} Request headers. **Default:** `null`.
   * `query` {Object} Query string parameters embedded into the request URL. Both

package/docs/docs/api/Errors.md

@@ -18,7 +18,7 @@ if (err instanceof errors.ConnectTimeoutError) {
 }
 ```
 
-All errors, except [`HTTPParserError`][], extend [`UndiciError`][]. Each error
+All errors, except [`HTTPParserError`][] and `WebAssemblyNotSupportedError`, extend [`UndiciError`][]. Each error
 carries a stable `code` string (for example `UND_ERR_CONNECT_TIMEOUT`) and a
 `name`.
 
@@ -32,6 +32,37 @@ if (err.code === 'UND_ERR_CONNECT_TIMEOUT') {
 }
 ```
 
+## Timeout-related errors
+
+The timeout errors below are controlled by dispatcher/client options:
+
+| Error code | When it is thrown | Related option |
+| ---------- | ----------------- | -------------- |
+| `UND_ERR_CONNECT_TIMEOUT` | A connection could not be established before the connection timeout elapsed. | [`connect.timeout`](Client.md) |
+| `UND_ERR_HEADERS_TIMEOUT` | The full response headers were not received before the headers timeout elapsed. | [`headersTimeout`](Client.md) |
+| `UND_ERR_BODY_TIMEOUT` | While reading the response body, no new data arrived before the body timeout elapsed. | [`bodyTimeout`](Client.md) |
+| `UND_ERR_SOCKET` | A generic socket-level failure happened. | Inspect `error.socket` for connection details. |
+
+### Configuring timeouts for `fetch`
+
+If you are using `fetch` (including Node.js built-in `fetch`), configure timeouts
+through the global dispatcher:
+
+```js
+import { Agent, setGlobalDispatcher, fetch } from 'undici'
+
+setGlobalDispatcher(new Agent({
+  connect: { timeout: 10_000 }, // connection phase
+  headersTimeout: 15_000, // wait for response headers
+  bodyTimeout: 30_000 // wait between response body chunks
+}))
+
+await fetch('https://example.com/data')
+```
+
+You can inspect timeout error codes from `error.code` or (for wrapped fetch
+errors) from `error.cause?.code`.
+
 ## Class: `UndiciError`
 
 <!-- YAML
@@ -52,6 +83,35 @@ on a well-known symbol rather than the prototype chain.
 * `name` {string} Always `'UndiciError'`.
 * `code` {string} Always `'UND_ERR'`.
 
+## Class: `WebAssemblyNotSupportedError`
+
+* Extends: {Error}
+
+WebAssembly is unavailable when Undici initializes its HTTP/1 parser. Undici does
+not provide an alternative parser for environments without WebAssembly, including
+Node.js configurations where `--jitless` disables it. The check is performed when
+the parser is needed, not when importing Undici or accessing `fetch`.
+
+* `name` {string} Always `'Error'`.
+* `code` {string} Always `'ERR_WEBASSEMBLY_NOT_SUPPORTED'`.
+* `message` {string} By default `'WebAssembly is not supported in this environment, but is required for HTTP/1 parsing'`.
+
+Client and dispatcher requests report this error directly. `fetch` rejects with
+a `TypeError` whose `cause` is this error:
+
+```js
+try {
+  await fetch('http://localhost:3000')
+} catch (error) {
+  if (error.cause?.code === 'ERR_WEBASSEMBLY_NOT_SUPPORTED') {
+    // HTTP/1 parsing requires WebAssembly in this environment.
+  }
+}
+```
+
+`Headers`, `FormData`, `Request`, `Response`, and other operations that do not need
+the HTTP/1 parser remain usable without WebAssembly.
+
 ## Class: `ConnectTimeoutError`
 
 <!-- YAML
@@ -436,6 +496,7 @@ The response returned an error status code. This is raised, for example, when th
 * `code` {string} Always `'UND_ERR_RESPONSE'`.
 * `statusCode` {number} The HTTP status code of the response.
 * `body` {Object|string|null} The response body.
+* `bodyTruncated` {boolean} Whether `body` was truncated by a configured limit.
 * `headers` {Object|string[]|null} The response headers.
 
 ### `new ResponseError(message, code, options)`
@@ -445,6 +506,7 @@ The response returned an error status code. This is raised, for example, when th
 * `options` {Object}
   * `headers` {Object|string[]|null} The response headers. (optional)
   * `body` {Object|string|null} The response body. (optional)
+  * `bodyTruncated` {boolean} Whether `body` was truncated. **Default:** `false`.
 
 ## Class: `ProxyConnectionError`
 
@@ -512,6 +574,19 @@ The maximum number of allowed origins has been reached.
 * `name` {string} Always `'MaxOriginsReachedError'`.
 * `code` {string} Always `'UND_ERR_MAX_ORIGINS_REACHED'`.
 
+## Class: `MaxRedirectsError`
+
+<!-- YAML
+added: v8.12.0
+-->
+
+* Extends: {UndiciError}
+
+The maximum number of redirects has been reached.
+
+* `name` {string} Always `'MaxRedirectsError'`.
+* `code` {string} Always `'UND_ERR_REDIRECT_MAX'`.
+
 ## Class: `Socks5ProxyError`
 
 <!-- YAML

package/docs/docs/api/H2CClient.md

@@ -55,8 +55,9 @@ added: v7.7.0
   hostname, and port. Only the `http:` protocol is supported.
 * `options` {H2CClientOptions} (optional)
   * `maxConcurrentStreams` {number} The maximum number of concurrent HTTP/2
-    streams for the session. It is advertised to the server and may be overridden
-    by a remote `SETTINGS` frame. Must be a positive integer. **Default:** `100`.
+    streams for the session. The server's `SETTINGS_MAX_CONCURRENT_STREAMS` can
+    lower this limit, but not raise it. Must be a positive integer.
+    **Default:** `100`.
   * `pipelining` {number} The number of concurrent requests multiplexed over the
     single connection. For an `H2CClient` this is aliased to
     `maxConcurrentStreams` and may not exceed it. Must be a positive integer.

package/docs/docs/api/Interceptors.md

@@ -163,9 +163,10 @@ Follows HTTP redirects (3xx responses) automatically.
   * `maxRedirections` {number} Maximum number of redirects to follow. Passing
     `0` disables redirect following entirely. **Default:** `undefined`
     (inherits from the per-request `maxRedirections` option).
-  * `throwOnMaxRedirect` {boolean} When `true`, throws an error once the
-    redirect limit is reached instead of returning the final redirect response.
-    **Default:** `false`.
+  * `throwOnMaxRedirect` {boolean} When `true`, throws an error when a
+    redirect would be followed but the redirect limit has been reached, instead
+    of returning that redirect response. A non-redirect response after exactly
+    `maxRedirections` redirects is returned normally. **Default:** `false`.
   * `stripHeadersOnRedirect` {string[]} List of header names to remove from
     the request when following any redirect. **Default:** `[]`.
   * `stripHeadersOnCrossOriginRedirect` {string[]} List of header names to
@@ -198,7 +199,10 @@ const agent = new Agent().compose(
 ## `interceptors.decompress([opts])`
 
 Automatically decompresses response bodies encoded with `gzip`, `x-gzip`,
-`br` (Brotli), `deflate`, `compress`, `x-compress`, or `zstd`.
+`br` (Brotli), `deflate`, or `zstd`. Any other coding, including `compress`
+and `x-compress`, is left untouched, matching `fetch()`. As required by
+[RFC 9659](https://www.rfc-editor.org/rfc/rfc9659.html), a `zstd` frame that
+requires a window size larger than 8 MB fails to decode.
 
 > **Experimental:** This interceptor is experimental and subject to change.
 > A one-time `ExperimentalWarning` is emitted on first use.
@@ -244,8 +248,11 @@ The error body is automatically decoded for `application/json` and
 
 **Parameters**
 
-* `opts` {Object} (optional) — currently reserved for future use; may be
-  omitted.
+* `opts` {Object} (optional)
+  * `maxSize` {number} Maximum number of response body bytes to include in the
+    error. If the body exceeds this limit, the resulting `ResponseError`
+    contains the retained prefix with `bodyTruncated` set to `true`. Set to `0`
+    to disable the limit. **Default:** `1048576` (1 MiB).
 
 **Returns:** {Dispatcher.DispatcherComposeInterceptor}
 

package/docs/docs/api/RedirectHandler.md

@@ -57,9 +57,10 @@ added: v4.0.0
 * `opts` {DispatchOptions} The dispatch options for the request. In addition to
   the standard dispatch options, the following redirect-specific fields are
   recognized:
-  * `throwOnMaxRedirect` {boolean} When `true`, an error is thrown once
-    `maxRedirections` is reached instead of returning the last redirect response.
-    **Default:** `false`.
+  * `throwOnMaxRedirect` {boolean} When `true`, an error is thrown when a
+    redirect would be followed but `maxRedirections` has been reached, instead of
+    returning that redirect response. A non-redirect response after exactly
+    `maxRedirections` redirects is returned normally. **Default:** `false`.
   * `stripHeadersOnRedirect` {string[]} Header names to remove from the request on
     every redirect hop. **Default:** `null`.
   * `stripHeadersOnCrossOriginRedirect` {string[]} Additional header names to
@@ -165,13 +166,15 @@ added: v7.0.0
 * `statusMessage` {string} The HTTP status message.
 
 Inspects the response headers to decide whether to follow a redirect. When the
-status code is redirectable, the `maxRedirections` limit has not been reached, and
-the request body has not been consumed, the `location` property is set, the method
-and headers are adjusted for the next hop, and the response is not forwarded.
-Otherwise the event is forwarded to the wrapped `handler`.
-
-Throws when `throwOnMaxRedirect` is `true` and the number of recorded redirects
-has reached `maxRedirections`, and throws an [`InvalidArgumentError`][] if a
+status code is redirectable, the response has a `Location` header, the
+`maxRedirections` limit has not been reached, and the request body has not been
+consumed, the `location` property is set, the method and headers are adjusted
+for the next hop, and the response is not forwarded. Otherwise the event is
+forwarded to the wrapped `handler`.
+
+Throws when `throwOnMaxRedirect` is `true` and a redirect that would otherwise be
+followed arrives after `maxRedirections` redirects have already been followed,
+and throws an [`InvalidArgumentError`][] if a
 redirect loop is detected (for example when a [`Client`][] or [`Pool`][] is used
 for a cross-origin redirect; use an [`Agent`][] instead).
 

package/docs/docs/index.md

@@ -13,7 +13,7 @@ It is also a Stranger Things reference.
 
 Have a question about using Undici? Open a [Q&A Discussion](https://github.com/nodejs/undici/discussions/new) or join our official OpenJS [Slack](https://openjs-foundation.slack.com/archives/C01QF9Q31QD) channel.
 
-Looking to contribute? Start by reading the [contributing guide](./CONTRIBUTING.md)
+Looking to contribute? Start by reading the [contributing guide](https://github.com/nodejs/undici/blob/main/CONTRIBUTING.md)
 
 ## Install
 
@@ -417,7 +417,7 @@ For more information about their behavior, please reference the body mixin from
 
 ## Common API Methods
 
-This section documents our most commonly used API methods. Additional APIs are documented in their own files within the [docs](./docs/) folder and are accessible via the navigation list on the left side of the docs site.
+This section documents our most commonly used API methods. Additional APIs are documented in their own files within the [`api`](./api/) folder and are accessible via the navigation list on the left side of the docs site.
 
 For the top-level APIs below, the `url` argument supplies the request origin and
 path. Do not pass `origin` or `path` in the second `options` argument. The linked
@@ -427,19 +427,19 @@ lower-level APIs that do not receive a separate `url` argument.
 ### `undici.request([url, options])`
 
 * `url` {string|URL|UrlObject}
-* `options` {RequestOptions} See [`RequestOptions`](./docs/docs/api/Dispatcher.md#parameter-requestoptions).
+* `options` {RequestOptions} See [`RequestOptions`](./api/Dispatcher.md#parameter-requestoptions).
   * `dispatcher` {Dispatcher} **Default:** [getGlobalDispatcher](#undicigetglobaldispatcher).
   * `method` {string} **Default:** `PUT` if `options.body`, otherwise `GET`.
 * Returns: {Promise} A promise with the result of the `Dispatcher.request` method.
 
 Calls `options.dispatcher.request(options)`.
 
-See [Dispatcher.request](./docs/docs/api/Dispatcher.md#dispatcherrequestoptions-callback) for more details, and [request examples](./docs/examples/README.md) for examples.
+See [Dispatcher.request](./api/Dispatcher.md#dispatcherrequestoptions-callback) for more details, and [request examples](https://github.com/nodejs/undici/blob/main/docs/examples/README.md) for examples.
 
 ### `undici.stream([url, options, ]factory)`
 
 * `url` {string|URL|UrlObject}
-* `options` {StreamOptions} See [`StreamOptions`](./docs/docs/api/Dispatcher.md#parameter-streamoptions).
+* `options` {StreamOptions} See [`StreamOptions`](./api/Dispatcher.md#parameter-streamoptions).
   * `dispatcher` {Dispatcher} **Default:** [getGlobalDispatcher](#undicigetglobaldispatcher).
   * `method` {string} **Default:** `PUT` if `options.body`, otherwise `GET`.
 * `factory` {Function} `Dispatcher.stream.factory`.
@@ -447,12 +447,12 @@ See [Dispatcher.request](./docs/docs/api/Dispatcher.md#dispatcherrequestoptions-
 
 Calls `options.dispatcher.stream(options, factory)`.
 
-See [Dispatcher.stream](./docs/docs/api/Dispatcher.md#dispatcherstreamoptions-factory-callback) for more details.
+See [Dispatcher.stream](./api/Dispatcher.md#dispatcherstreamoptions-factory-callback) for more details.
 
 ### `undici.pipeline([url, options, ]handler)`
 
 * `url` {string|URL|UrlObject}
-* `options` {PipelineOptions} See [`PipelineOptions`](./docs/docs/api/Dispatcher.md#parameter-pipelineoptions).
+* `options` {PipelineOptions} See [`PipelineOptions`](./api/Dispatcher.md#parameter-pipelineoptions).
   * `dispatcher` {Dispatcher} **Default:** [getGlobalDispatcher](#undicigetglobaldispatcher).
   * `method` {string} **Default:** `PUT` if `options.body`, otherwise `GET`.
 * `handler` {Function} `Dispatcher.pipeline.handler`.
@@ -460,21 +460,21 @@ See [Dispatcher.stream](./docs/docs/api/Dispatcher.md#dispatcherstreamoptions-fa
 
 Calls `options.dispatch.pipeline(options, handler)`.
 
-See [Dispatcher.pipeline](./docs/docs/api/Dispatcher.md#dispatcherpipelineoptions-handler) for more details.
+See [Dispatcher.pipeline](./api/Dispatcher.md#dispatcherpipelineoptions-handler) for more details.
 
 ### `undici.connect([url, options])`
 
 Starts two-way communications with the requested resource using [HTTP CONNECT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/CONNECT).
 
 * `url` {string|URL|UrlObject}
-* `options` {ConnectOptions} See [`ConnectOptions`](./docs/docs/api/Dispatcher.md#parameter-connectoptions).
+* `options` {ConnectOptions} See [`ConnectOptions`](./api/Dispatcher.md#parameter-connectoptions).
   * `dispatcher` {Dispatcher} **Default:** [getGlobalDispatcher](#undicigetglobaldispatcher).
 * `callback` {Function} (optional) — `(err, data) => void`.
 * Returns: {Promise} A promise with the result of the `Dispatcher.connect` method.
 
 Calls `options.dispatch.connect(options)`.
 
-See [Dispatcher.connect](./docs/docs/api/Dispatcher.md#dispatcherconnectoptions-callback) for more details.
+See [Dispatcher.connect](./api/Dispatcher.md#dispatcherconnectoptions-callback) for more details.
 
 ### `undici.fetch(input[, init])`
 
@@ -647,14 +647,14 @@ Undici limits the number of `Content-Encoding` layers in a response to **5** to
 Upgrade to a different protocol. See [MDN - HTTP - Protocol upgrade mechanism](https://developer.mozilla.org/en-US/docs/Web/HTTP/Protocol_upgrade_mechanism) for more details.
 
 * `url` {string|URL|UrlObject}
-* `options` {UpgradeOptions} See [`UpgradeOptions`](./docs/docs/api/Dispatcher.md#parameter-upgradeoptions).
+* `options` {UpgradeOptions} See [`UpgradeOptions`](./api/Dispatcher.md#parameter-upgradeoptions).
   * `dispatcher` {Dispatcher} **Default:** [getGlobalDispatcher](#undicigetglobaldispatcher).
 * `callback` {Function} (optional) — `(error, data) => void`.
 * Returns: {Promise} A promise with the result of the `Dispatcher.upgrade` method.
 
 Calls `options.dispatcher.upgrade(options)`.
 
-See [Dispatcher.upgrade](./docs/docs/api/Dispatcher.md#dispatcherupgradeoptions-callback) for more details.
+See [Dispatcher.upgrade](./api/Dispatcher.md#dispatcherupgradeoptions-callback) for more details.
 
 ### `undici.setGlobalDispatcher(dispatcher)`
 

package/docs/docs/type-map.json

@@ -1,79 +1,79 @@
 {
-  "AbortError": "/api/Errors.md#class-aborterror",
-  "Agent": "/api/Agent.md#class-agent",
-  "AgentDispatchOptions": "/api/Agent.md#agentdispatchoptions-handler",
-  "AgentOptions": "/api/Agent.md#new-agentoptions",
-  "BalancedPool": "/api/BalancedPool.md#class-balancedpool",
-  "BalancedPoolOptions": "/api/BalancedPool.md#parameter-balancedpooloptions",
-  "BodyMixin": "/api/Fetch.md#new-formdata",
+  "AbortError": "/api/Errors.html#class-aborterror",
+  "Agent": "/api/Agent.html#class-agent",
+  "AgentDispatchOptions": "/api/Agent.html#agentdispatchoptions-handler",
+  "AgentOptions": "/api/Agent.html#new-agentoptions",
+  "BalancedPool": "/api/BalancedPool.html#class-balancedpool",
+  "BalancedPoolOptions": "/api/BalancedPool.html#parameter-balancedpooloptions",
+  "BodyMixin": "/api/Fetch.html#new-formdata",
   "Buffer": "https://nodejs.org/api/buffer.html#class-buffer",
-  "BuildOptions": "/api/Connector.md#buildconnectoroptions",
-  "CacheKey": "/api/CacheStore.md#cachekey",
-  "CacheStore": "/api/CacheStore.md#new-memorycachestoreoptions",
-  "CacheValue": "/api/CacheStore.md#cachevalue",
-  "ClientDestroyedError": "/api/Errors.md#class-clientdestroyederror",
-  "ClientOptions": "/api/Client.md#new-clienturl-options",
-  "ClientStats": "/api/ClientStats.md#class-clientstats",
-  "ConnectOptions": "/api/Dispatcher.md#class-dispatcher",
-  "Cookie": "/api/Cookies.md#cookie",
-  "DispatchController": "/api/Dispatcher.md#class-dispatcher",
-  "DispatchHandler": "/api/Dispatcher.md#class-dispatcher",
-  "DispatchOptions": "/api/Dispatcher.md#class-dispatcher",
-  "Dispatcher": "/api/Dispatcher.md#class-dispatcher",
+  "BuildOptions": "/api/Connector.html#buildconnectoroptions",
+  "CacheKey": "/api/CacheStore.html#cachekey",
+  "CacheStore": "/api/CacheStore.html#new-memorycachestoreoptions",
+  "CacheValue": "/api/CacheStore.html#cachevalue",
+  "ClientDestroyedError": "/api/Errors.html#class-clientdestroyederror",
+  "ClientOptions": "/api/Client.html#new-clienturl-options",
+  "ClientStats": "/api/ClientStats.html#class-clientstats",
+  "ConnectOptions": "/api/Dispatcher.html#class-dispatcher",
+  "Cookie": "/api/Cookies.html#cookie",
+  "DispatchController": "/api/Dispatcher.html#class-dispatcher",
+  "DispatchHandler": "/api/Dispatcher.html#class-dispatcher",
+  "DispatchOptions": "/api/Dispatcher.html#class-dispatcher",
+  "Dispatcher": "/api/Dispatcher.html#class-dispatcher",
   "Duplex": "https://nodejs.org/api/stream.html#class-streamduplex",
-  "EnvHttpProxyAgent": "/api/EnvHttpProxyAgent.md#class-envhttpproxyagent",
-  "EnvHttpProxyAgentOptions": "/api/EnvHttpProxyAgent.md#new-envhttpproxyagentoptions",
+  "EnvHttpProxyAgent": "/api/EnvHttpProxyAgent.html#class-envhttpproxyagent",
+  "EnvHttpProxyAgentOptions": "/api/EnvHttpProxyAgent.html#new-envhttpproxyagentoptions",
   "EventEmitter": "https://nodejs.org/api/events.html#class-eventemitter",
-  "GetResult": "/api/CacheStore.md#getresult",
-  "H2CClientOptions": "/api/H2CClient.md#new-h2cclienturl-options",
+  "GetResult": "/api/CacheStore.html#getresult",
+  "H2CClientOptions": "/api/H2CClient.html#new-h2cclienturl-options",
   "HeadersInit": "https://developer.mozilla.org/docs/Web/API/Headers/Headers",
-  "InvalidArgumentError": "/api/Errors.md#class-invalidargumenterror",
+  "InvalidArgumentError": "/api/Errors.html#class-invalidargumenterror",
   "Iterable": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Iteration_protocols",
-  "MaxOriginsReachedError": "/api/Errors.md#class-maxoriginsreachederror",
-  "MockAgent": "/api/MockAgent.md#class-mockagent",
-  "MockAgentOptions": "/api/MockAgent.md#parameter-mockagentoptions",
-  "MockCallHistory": "/api/MockCallHistory.md#class-mockcallhistory",
-  "MockCallHistoryLog": "/api/MockCallHistoryLog.md#class-mockcallhistorylog",
-  "MockClient": "/api/MockClient.md#class-mockclient",
-  "MockClientOptions": "/api/MockClient.md#parameter-mockclientoptions",
-  "MockInterceptor": "/api/MockPool.md#return-mockinterceptor",
-  "MockInterceptor.Options": "/api/MockPool.md#parameter-mockpoolinterceptoptions",
-  "MockPool": "/api/MockPool.md#class-mockpool",
-  "MockPoolInterceptOptions": "/api/MockPool.md#parameter-mockpoolinterceptoptions",
-  "MockPoolOptions": "/api/MockPool.md#parameter-mockpooloptions",
-  "MockResponseOptions": "/api/MockPool.md#parameter-mockresponseoptions",
-  "MockScope": "/api/MockPool.md#return-mockscope",
-  "PendingInterceptor": "/api/MockAgent.md#new-mockagentoptions",
-  "PipelineOptions": "/api/Dispatcher.md#class-dispatcher",
-  "Pool": "/api/Pool.md#class-pool",
-  "PoolOptions": "/api/Pool.md#new-poolurl-options",
-  "PoolStats": "/api/PoolStats.md#class-poolstats",
-  "ProxyAgent": "/api/ProxyAgent.md#class-proxyagent",
-  "ProxyAgentOptions": "/api/ProxyAgent.md#new-proxyagentoptions",
+  "MaxOriginsReachedError": "/api/Errors.html#class-maxoriginsreachederror",
+  "MockAgent": "/api/MockAgent.html#class-mockagent",
+  "MockAgentOptions": "/api/MockAgent.html#parameter-mockagentoptions",
+  "MockCallHistory": "/api/MockCallHistory.html#class-mockcallhistory",
+  "MockCallHistoryLog": "/api/MockCallHistoryLog.html#class-mockcallhistorylog",
+  "MockClient": "/api/MockClient.html#class-mockclient",
+  "MockClientOptions": "/api/MockClient.html#parameter-mockclientoptions",
+  "MockInterceptor": "/api/MockPool.html#return-mockinterceptor",
+  "MockInterceptor.Options": "/api/MockPool.html#parameter-mockpoolinterceptoptions",
+  "MockPool": "/api/MockPool.html#class-mockpool",
+  "MockPoolInterceptOptions": "/api/MockPool.html#parameter-mockpoolinterceptoptions",
+  "MockPoolOptions": "/api/MockPool.html#parameter-mockpooloptions",
+  "MockResponseOptions": "/api/MockPool.html#parameter-mockresponseoptions",
+  "MockScope": "/api/MockPool.html#return-mockscope",
+  "PendingInterceptor": "/api/MockAgent.html#new-mockagentoptions",
+  "PipelineOptions": "/api/Dispatcher.html#class-dispatcher",
+  "Pool": "/api/Pool.html#class-pool",
+  "PoolOptions": "/api/Pool.html#new-poolurl-options",
+  "PoolStats": "/api/PoolStats.html#class-poolstats",
+  "ProxyAgent": "/api/ProxyAgent.html#class-proxyagent",
+  "ProxyAgentOptions": "/api/ProxyAgent.html#new-proxyagentoptions",
   "Readable": "https://nodejs.org/api/stream.html#class-streamreadable",
   "Record": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
-  "RequestInit": "/api/Fetch.md#new-formdata",
-  "RequestOptions": "/api/Dispatcher.md#class-dispatcher",
-  "ResponseInit": "/api/Fetch.md#new-formdata",
-  "RetryContext": "/api/RetryHandler.md#retrycontext",
-  "RetryHandler": "/api/RetryHandler.md#class-retryhandler",
-  "RetryHandlers": "/api/RetryHandler.md#parameter-retryhandlers",
-  "RetryOptions": "/api/RetryHandler.md#retryoptions",
-  "RetryState": "/api/RetryHandler.md#retrystate",
-  "RoundRobinPoolOptions": "/api/RoundRobinPool.md#parameter-roundrobinpooloptions",
-  "SnapshotRecorder": "/api/SnapshotAgent.md#new-snapshotagentoptions",
+  "RequestInit": "/api/Fetch.html#new-formdata",
+  "RequestOptions": "/api/Dispatcher.html#class-dispatcher",
+  "ResponseInit": "/api/Fetch.html#new-formdata",
+  "RetryContext": "/api/RetryHandler.html#retrycontext",
+  "RetryHandler": "/api/RetryHandler.html#class-retryhandler",
+  "RetryHandlers": "/api/RetryHandler.html#parameter-retryhandlers",
+  "RetryOptions": "/api/RetryHandler.html#retryoptions",
+  "RetryState": "/api/RetryHandler.html#retrystate",
+  "RoundRobinPoolOptions": "/api/RoundRobinPool.html#parameter-roundrobinpooloptions",
+  "SnapshotRecorder": "/api/SnapshotAgent.html#new-snapshotagentoptions",
   "Socket": "https://nodejs.org/api/net.html#class-netsocket",
-  "SocketInfo": "/api/Errors.md#new-requestretryerrormessage-code-options",
-  "StreamOptions": "/api/Dispatcher.md#class-dispatcher",
+  "SocketInfo": "/api/Errors.html#new-requestretryerrormessage-code-options",
+  "StreamOptions": "/api/Dispatcher.html#class-dispatcher",
   "TLSSocket": "https://nodejs.org/api/tls.html#class-tlstlssocket",
-  "UndiciError": "/api/Errors.md#class-undicierror",
-  "UndiciHeaders": "/api/Dispatcher.md#class-dispatcher",
-  "UpgradeOptions": "/api/Dispatcher.md#class-dispatcher",
-  "UrlObject": "/index.md#urlobject",
-  "WebSocketInit": "/api/WebSocket.md#new-websocketurl-protocols",
-  "WebSocketStreamOptions": "/api/WebSocket.md#new-websocketurl-protocols",
+  "UndiciError": "/api/Errors.html#class-undicierror",
+  "UndiciHeaders": "/api/Dispatcher.html#class-dispatcher",
+  "UpgradeOptions": "/api/Dispatcher.html#class-dispatcher",
+  "UrlObject": "/index.html#urlobject",
+  "WebSocketInit": "/api/WebSocket.html#new-websocketurl-protocols",
+  "WebSocketStreamOptions": "/api/WebSocket.html#new-websocketurl-protocols",
   "Writable": "https://nodejs.org/api/stream.html#class-streamwritable",
-  "buildConnector.BuildOptions": "/api/Connector.md#buildconnectoroptions",
+  "buildConnector.BuildOptions": "/api/Connector.html#buildconnectoroptions",
   "net.Socket": "https://nodejs.org/api/net.html#class-netsocket",
   "stream.Readable": "https://nodejs.org/api/stream.html#class-streamreadable"
-}
+}