remove unused stuff

Author: ronag

README.md

@@ -114,10 +114,6 @@ Should you need to access the `body` in plain-text after using a mixin, the best
 
 For more information about their behavior, please reference the body mixin from the [Fetch Standard](https://fetch.spec.whatwg.org/#body-mixin).
 
-## 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.
-
 ### `undici.request([url, options]): Promise`
 
 Arguments:
@@ -134,218 +130,6 @@ Calls `options.dispatcher.request(options)`.
 
 See [Dispatcher.request](./docs/docs/api/Dispatcher.md#dispatcherrequestoptions-callback) for more details, and [request examples](./examples/README.md) for examples.
 
-### `undici.stream([url, options, ]factory): Promise`
-
-Arguments:
-
-* **url** `string | URL | UrlObject`
-* **options** [`StreamOptions`](./docs/docs/api/Dispatcher.md#parameter-streamoptions)
-  * **dispatcher** `Dispatcher` - Default: [getGlobalDispatcher](#undicigetglobaldispatcher)
-  * **method** `String` - Default: `PUT` if `options.body`, otherwise `GET`
-  * **maxRedirections** `Integer` - Default: `0`
-* **factory** `Dispatcher.stream.factory`
-
-Returns a promise with the result of the `Dispatcher.stream` method.
-
-Calls `options.dispatcher.stream(options, factory)`.
-
-See [Dispatcher.stream](./docs/docs/api/Dispatcher.md#dispatcherstreamoptions-factory-callback) for more details.
-
-### `undici.pipeline([url, options, ]handler): Duplex`
-
-Arguments:
-
-* **url** `string | URL | UrlObject`
-* **options** [`PipelineOptions`](./docs/docs/api/Dispatcher.md#parameter-pipelineoptions)
-  * **dispatcher** `Dispatcher` - Default: [getGlobalDispatcher](#undicigetglobaldispatcher)
-  * **method** `String` - Default: `PUT` if `options.body`, otherwise `GET`
-  * **maxRedirections** `Integer` - Default: `0`
-* **handler** `Dispatcher.pipeline.handler`
-
-Returns: `stream.Duplex`
-
-Calls `options.dispatch.pipeline(options, handler)`.
-
-See [Dispatcher.pipeline](./docs/docs/api/Dispatcher.md#dispatcherpipelineoptions-handler) for more details.
-
-### `undici.connect([url, options]): Promise`
-
-Starts two-way communications with the requested resource using [HTTP CONNECT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/CONNECT).
-
-Arguments:
-
-* **url** `string | URL | UrlObject`
-* **options** [`ConnectOptions`](./docs/docs/api/Dispatcher.md#parameter-connectoptions)
-  * **dispatcher** `Dispatcher` - Default: [getGlobalDispatcher](#undicigetglobaldispatcher)
-  * **maxRedirections** `Integer` - Default: `0`
-* **callback** `(err: Error | null, data: ConnectData | null) => void` (optional)
-
-Returns 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.
-
-### `undici.fetch(input[, init]): Promise`
-
-Implements [fetch](https://fetch.spec.whatwg.org/#fetch-method).
-
-* https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch
-* https://fetch.spec.whatwg.org/#fetch-method
-
-Basic usage example:
-
-```js
-import { fetch } from 'undici'
-
-
-const res = await fetch('https://example.com')
-const json = await res.json()
-console.log(json)
-```
-
-You can pass an optional dispatcher to `fetch` as:
-
-```js
-import { fetch, Agent } from 'undici'
-
-const res = await fetch('https://example.com', {
-  // Mocks are also supported
-  dispatcher: new Agent({
-    keepAliveTimeout: 10,
-    keepAliveMaxTimeout: 10
-  })
-})
-const json = await res.json()
-console.log(json)
-```
-
-#### `request.body`
-
-A body can be of the following types:
-
-- ArrayBuffer
-- ArrayBufferView
-- AsyncIterables
-- Blob
-- Iterables
-- String
-- URLSearchParams
-- FormData
-
-In this implementation of fetch, ```request.body``` now accepts ```Async Iterables```. It is not present in the [Fetch Standard.](https://fetch.spec.whatwg.org)
-
-```js
-import { fetch } from 'undici'
-
-const data = {
-  async *[Symbol.asyncIterator]() {
-    yield 'hello'
-    yield 'world'
-  },
-}
-
-await fetch('https://example.com', { body: data, method: 'POST', duplex: 'half' })
-```
-
-[FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) besides text data and buffers can also utilize streams via [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) objects:
-
-```js
-import { openAsBlob } from 'node:fs'
-
-const file = await openAsBlob('./big.csv')
-const body = new FormData()
-body.set('file', file, 'big.csv')
-
-await fetch('http://example.com', { method: 'POST', body })
-```
-
-#### `request.duplex`
-
-- half
-
-In this implementation of fetch, `request.duplex` must be set if `request.body` is `ReadableStream` or `Async Iterables`, however, fetch requests are currently always full duplex. For more detail refer to the [Fetch Standard.](https://fetch.spec.whatwg.org/#dom-requestinit-duplex).
-
-#### `response.body`
-
-Nodejs has two kinds of streams: [web streams](https://nodejs.org/dist/latest-v16.x/docs/api/webstreams.html), which follow the API of the WHATWG web standard found in browsers, and an older Node-specific [streams API](https://nodejs.org/api/stream.html). `response.body` returns a readable web stream. If you would prefer to work with a Node stream you can convert a web stream using `.fromWeb()`.
-
-```js
-import { fetch } from 'undici'
-import { Readable } from 'node:stream'
-
-const response = await fetch('https://example.com')
-const readableWebStream = response.body
-const readableNodeStream = Readable.fromWeb(readableWebStream)
-```
-
-#### Specification Compliance
-
-This section documents parts of the [Fetch Standard](https://fetch.spec.whatwg.org) that Undici does
-not support or does not fully implement.
-
-##### Garbage Collection
-
-* https://fetch.spec.whatwg.org/#garbage-collection
-
-The [Fetch Standard](https://fetch.spec.whatwg.org) allows users to skip consuming the response body by relying on
-[garbage collection](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Memory_Management#garbage_collection) to release connection resources. Undici does not do the same. Therefore, it is important to always either consume or cancel the response body.
-
-Garbage collection in Node is less aggressive and deterministic
-(due to the lack of clear idle periods that browsers have through the rendering refresh rate)
-which means that leaving the release of connection resources to the garbage collector can lead
-to excessive connection usage, reduced performance (due to less connection re-use), and even
-stalls or deadlocks when running out of connections.
-
-```js
-// Do
-const headers = await fetch(url)
-  .then(async res => {
-    for await (const chunk of res.body) {
-      // force consumption of body
-    }
-    return res.headers
-  })
-
-// Do not
-const headers = await fetch(url)
-  .then(res => res.headers)
-```
-
-However, if you want to get only headers, it might be better to use `HEAD` request method. Usage of this method will obviate the need for consumption or cancelling of the response body. See [MDN - HTTP - HTTP request methods - HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) for more details.
-
-```js
-const headers = await fetch(url, { method: 'HEAD' })
-  .then(res => res.headers)
-```
-
-##### Forbidden and Safelisted Header Names
-
-* https://fetch.spec.whatwg.org/#cors-safelisted-response-header-name
-* https://fetch.spec.whatwg.org/#forbidden-header-name
-* https://fetch.spec.whatwg.org/#forbidden-response-header-name
-* https://github.com/wintercg/fetch/issues/6
-
-The [Fetch Standard](https://fetch.spec.whatwg.org) requires implementations to exclude certain headers from requests and responses. In browser environments, some headers are forbidden so the user agent remains in full control over them. In Undici, these constraints are removed to give more control to the user.
-
-### `undici.upgrade([url, options]): Promise`
-
-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.
-
-Arguments:
-
-* **url** `string | URL | UrlObject`
-* **options** [`UpgradeOptions`](./docs/docs/api/Dispatcher.md#parameter-upgradeoptions)
-  * **dispatcher** `Dispatcher` - Default: [getGlobalDispatcher](#undicigetglobaldispatcher)
-  * **maxRedirections** `Integer` - Default: `0`
-* **callback** `(error: Error | null, data: UpgradeData) => void` (optional)
-
-Returns 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.
-
 ### `undici.setGlobalDispatcher(dispatcher)`
 
 * dispatcher `Dispatcher`
@@ -358,28 +142,6 @@ Gets the global dispatcher used by Common API Methods.
 
 Returns: `Dispatcher`
 
-### `undici.setGlobalOrigin(origin)`
-
-* origin `string | URL | undefined`
-
-Sets the global origin used in `fetch`.
-
-If `undefined` is passed, the global origin will be reset. This will cause `Response.redirect`, `new Request()`, and `fetch` to throw an error when a relative path is passed.
-
-```js
-setGlobalOrigin('http://localhost:3000')
-
-const response = await fetch('/api/ping')
-
-console.log(response.url) // http://localhost:3000/api/ping
-```
-
-### `undici.getGlobalOrigin()`
-
-Gets the global origin used in `fetch`.
-
-Returns: `URL`
-
 ### `UrlObject`
 
 * **port** `string | number` (optional)