Skip to content

Commit 7740c75

Browse files
authored
Update Dispatch.md to Dispatcher.md (#3839)
Update links so they don't 404 to the old URL.
1 parent 70f7314 commit 7740c75

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/docs/api/Dispatcher.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ Returns: `stream.Duplex`
377377

378378
#### Parameter: PipelineOptions
379379

380-
Extends: [`RequestOptions`](/docs/docs/api/Dispatch.md#parameter-requestoptions)
380+
Extends: [`RequestOptions`](/docs/docs/api/Dispatcher.md#parameter-requestoptions)
381381

382382
* **objectMode** `boolean` (optional) - Default: `false` - Set to `true` if the `handler` will return an object stream.
383383

@@ -467,7 +467,7 @@ Returns: `void | Promise<ResponseData>` - Only returns a `Promise` if no `callba
467467

468468
#### Parameter: `RequestOptions`
469469

470-
Extends: [`DispatchOptions`](/docs/docs/api/Dispatch.md#parameter-dispatchoptions)
470+
Extends: [`DispatchOptions`](/docs/docs/api/Dispatcher.md#parameter-dispatchoptions)
471471

472472
* **opaque** `unknown` (optional) - Default: `null` - Used for passing through context to `ResponseData`.
473473
* **signal** `AbortSignal | events.EventEmitter | null` (optional) - Default: `null`.
@@ -654,7 +654,7 @@ return null
654654

655655
A faster version of `Dispatcher.request`. This method expects the second argument `factory` to return a [`stream.Writable`](https://nodejs.org/api/stream.html#stream_class_stream_writable) stream which the response will be written to. This improves performance by avoiding creating an intermediate [`stream.Readable`](https://nodejs.org/api/stream.html#stream_readable_streams) stream when the user expects to directly pipe the response body to a [`stream.Writable`](https://nodejs.org/api/stream.html#stream_class_stream_writable) stream.
656656

657-
As demonstrated in [Example 1 - Basic GET stream request](/docs/docs/api/Dispatch.md#example-1---basic-get-stream-request), it is recommended to use the `option.opaque` property to avoid creating a closure for the `factory` method. This pattern works well with Node.js Web Frameworks such as [Fastify](https://fastify.io). See [Example 2 - Stream to Fastify Response](/docs/docs/api/Dispatch.md#example-2---stream-to-fastify-response) for more details.
657+
As demonstrated in [Example 1 - Basic GET stream request](/docs/docs/api/Dispatcher.md#example-1---basic-get-stream-request), it is recommended to use the `option.opaque` property to avoid creating a closure for the `factory` method. This pattern works well with Node.js Web Frameworks such as [Fastify](https://fastify.io). See [Example 2 - Stream to Fastify Response](/docs/docs/api/Dispatch.md#example-2---stream-to-fastify-response) for more details.
658658

659659
Arguments:
660660

0 commit comments

Comments
 (0)