Skip to content

Commit d8d3c94

Browse files
authored
docs(Dispatcher): adjust documentation for reset flag (#1852)
1 parent cea0cc8 commit d8d3c94

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/api/Dispatcher.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ Returns: `Boolean` - `false` if dispatcher is busy and further dispatch calls wo
192192
* **origin** `string | URL`
193193
* **path** `string`
194194
* **method** `string`
195-
* **reset** `boolean` (optional) - Default: `false` - Indicates whether the request should attempt to create a long-living connection by sending the `connection: keep-alive` header, or close it immediately after response by sending `connection: close`.
195+
* **reset** `boolean` (optional) - Default: `false` - If `false`, the request will attempt to create a long-living connection by sending the `connection: keep-alive` header,otherwise will attempt to close it immediately after response by sending `connection: close` within the request and closing the socket afterwards.
196196
* **body** `string | Buffer | Uint8Array | stream.Readable | Iterable | AsyncIterable | null` (optional) - Default: `null`
197197
* **headers** `UndiciHeaders | string[]` (optional) - Default: `null`.
198198
* **query** `Record<string, any> | null` (optional) - Default: `null` - Query string params to be embedded in the request URL. Note that both keys and values of query are encoded using `encodeURIComponent`. If for some reason you need to send them unencoded, embed query params into path directly instead.

0 commit comments

Comments
 (0)