Skip to content

Commit 4a369d0

Browse files
Trotttargos
authored andcommitted
doc: revise HTTPRequestOptions text
PR-URL: #41407 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
1 parent f43bfe2 commit 4a369d0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/api/http.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3051,7 +3051,7 @@ changes:
30513051
* `undefined` (default): use [`http.globalAgent`][] for this host and port.
30523052
* `Agent` object: explicitly use the passed in `Agent`.
30533053
* `false`: causes a new `Agent` with default values to be used.
3054-
* `auth` {string} Basic authentication i.e. `'user:password'` to compute an
3054+
* `auth` {string} Basic authentication (`'user:password'`) to compute an
30553055
Authorization header.
30563056
* `createConnection` {Function} A function that produces a socket/stream to
30573057
use for the request when the `agent` option is not used. This can be used to
@@ -3077,8 +3077,8 @@ changes:
30773077
* `localPort` {number} Local port to connect from.
30783078
* `lookup` {Function} Custom lookup function. **Default:** [`dns.lookup()`][].
30793079
* `maxHeaderSize` {number} Optionally overrides the value of
3080-
[`--max-http-header-size`][] for responses received from the server, i.e.
3081-
the maximum length of response headers in bytes.
3080+
[`--max-http-header-size`][] (the maximum length of response headers in
3081+
bytes) for responses received from the server.
30823082
**Default:** 16384 (16 KB).
30833083
* `method` {string} A string specifying the HTTP request method. **Default:**
30843084
`'GET'`.
@@ -3091,8 +3091,8 @@ changes:
30913091
* `protocol` {string} Protocol to use. **Default:** `'http:'`.
30923092
* `setHost` {boolean}: Specifies whether or not to automatically add the
30933093
`Host` header. Defaults to `true`.
3094-
* `socketPath` {string} Unix Domain Socket (cannot be used if one of `host`
3095-
or `port` is specified, those specify a TCP Socket).
3094+
* `socketPath` {string} Unix domain socket. Cannot be used if one of `host`
3095+
or `port` is specified, as those specify a TCP Socket.
30963096
* `timeout` {number}: A number specifying the socket timeout in milliseconds.
30973097
This will set the timeout before the socket is connected.
30983098
* `signal` {AbortSignal}: An AbortSignal that may be used to abort an ongoing

0 commit comments

Comments
 (0)