Skip to content

Commit 1548578

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

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
@@ -3059,7 +3059,7 @@ changes:
30593059
* `undefined` (default): use [`http.globalAgent`][] for this host and port.
30603060
* `Agent` object: explicitly use the passed in `Agent`.
30613061
* `false`: causes a new `Agent` with default values to be used.
3062-
* `auth` {string} Basic authentication i.e. `'user:password'` to compute an
3062+
* `auth` {string} Basic authentication (`'user:password'`) to compute an
30633063
Authorization header.
30643064
* `createConnection` {Function} A function that produces a socket/stream to
30653065
use for the request when the `agent` option is not used. This can be used to
@@ -3085,8 +3085,8 @@ changes:
30853085
* `localPort` {number} Local port to connect from.
30863086
* `lookup` {Function} Custom lookup function. **Default:** [`dns.lookup()`][].
30873087
* `maxHeaderSize` {number} Optionally overrides the value of
3088-
[`--max-http-header-size`][] for responses received from the server, i.e.
3089-
the maximum length of response headers in bytes.
3088+
[`--max-http-header-size`][] (the maximum length of response headers in
3089+
bytes) for responses received from the server.
30903090
**Default:** 16384 (16 KB).
30913091
* `method` {string} A string specifying the HTTP request method. **Default:**
30923092
`'GET'`.
@@ -3099,8 +3099,8 @@ changes:
30993099
* `protocol` {string} Protocol to use. **Default:** `'http:'`.
31003100
* `setHost` {boolean}: Specifies whether or not to automatically add the
31013101
`Host` header. Defaults to `true`.
3102-
* `socketPath` {string} Unix Domain Socket (cannot be used if one of `host`
3103-
or `port` is specified, those specify a TCP Socket).
3102+
* `socketPath` {string} Unix domain socket. Cannot be used if one of `host`
3103+
or `port` is specified, as those specify a TCP Socket.
31043104
* `timeout` {number}: A number specifying the socket timeout in milliseconds.
31053105
This will set the timeout before the socket is connected.
31063106
* `signal` {AbortSignal}: An AbortSignal that may be used to abort an ongoing

0 commit comments

Comments
 (0)