Skip to content

Commit 91c3e28

Browse files
Trottdanielleadams
authored andcommitted
doc: revise HTTPRequestOptions text
PR-URL: #41407 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
1 parent b281bf5 commit 91c3e28

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
@@ -3043,7 +3043,7 @@ changes:
30433043
* `undefined` (default): use [`http.globalAgent`][] for this host and port.
30443044
* `Agent` object: explicitly use the passed in `Agent`.
30453045
* `false`: causes a new `Agent` with default values to be used.
3046-
* `auth` {string} Basic authentication i.e. `'user:password'` to compute an
3046+
* `auth` {string} Basic authentication (`'user:password'`) to compute an
30473047
Authorization header.
30483048
* `createConnection` {Function} A function that produces a socket/stream to
30493049
use for the request when the `agent` option is not used. This can be used to
@@ -3069,8 +3069,8 @@ changes:
30693069
* `localPort` {number} Local port to connect from.
30703070
* `lookup` {Function} Custom lookup function. **Default:** [`dns.lookup()`][].
30713071
* `maxHeaderSize` {number} Optionally overrides the value of
3072-
[`--max-http-header-size`][] for responses received from the server, i.e.
3073-
the maximum length of response headers in bytes.
3072+
[`--max-http-header-size`][] (the maximum length of response headers in
3073+
bytes) for responses received from the server.
30743074
**Default:** 16384 (16 KB).
30753075
* `method` {string} A string specifying the HTTP request method. **Default:**
30763076
`'GET'`.
@@ -3083,8 +3083,8 @@ changes:
30833083
* `protocol` {string} Protocol to use. **Default:** `'http:'`.
30843084
* `setHost` {boolean}: Specifies whether or not to automatically add the
30853085
`Host` header. Defaults to `true`.
3086-
* `socketPath` {string} Unix Domain Socket (cannot be used if one of `host`
3087-
or `port` is specified, those specify a TCP Socket).
3086+
* `socketPath` {string} Unix domain socket. Cannot be used if one of `host`
3087+
or `port` is specified, as those specify a TCP Socket.
30883088
* `timeout` {number}: A number specifying the socket timeout in milliseconds.
30893089
This will set the timeout before the socket is connected.
30903090
* `signal` {AbortSignal}: An AbortSignal that may be used to abort an ongoing

0 commit comments

Comments
 (0)