Skip to content

Commit

Permalink
doc: revise HTTPRequestOptions text
Browse files Browse the repository at this point in the history
PR-URL: #41407
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
  • Loading branch information
Trott authored and targos committed Jan 14, 2022
1 parent f43bfe2 commit 4a369d0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -3051,7 +3051,7 @@ changes:
* `undefined` (default): use [`http.globalAgent`][] for this host and port.
* `Agent` object: explicitly use the passed in `Agent`.
* `false`: causes a new `Agent` with default values to be used.
* `auth` {string} Basic authentication i.e. `'user:password'` to compute an
* `auth` {string} Basic authentication (`'user:password'`) to compute an
Authorization header.
* `createConnection` {Function} A function that produces a socket/stream to
use for the request when the `agent` option is not used. This can be used to
Expand All @@ -3077,8 +3077,8 @@ changes:
* `localPort` {number} Local port to connect from.
* `lookup` {Function} Custom lookup function. **Default:** [`dns.lookup()`][].
* `maxHeaderSize` {number} Optionally overrides the value of
[`--max-http-header-size`][] for responses received from the server, i.e.
the maximum length of response headers in bytes.
[`--max-http-header-size`][] (the maximum length of response headers in
bytes) for responses received from the server.
**Default:** 16384 (16 KB).
* `method` {string} A string specifying the HTTP request method. **Default:**
`'GET'`.
Expand All @@ -3091,8 +3091,8 @@ changes:
* `protocol` {string} Protocol to use. **Default:** `'http:'`.
* `setHost` {boolean}: Specifies whether or not to automatically add the
`Host` header. Defaults to `true`.
* `socketPath` {string} Unix Domain Socket (cannot be used if one of `host`
or `port` is specified, those specify a TCP Socket).
* `socketPath` {string} Unix domain socket. Cannot be used if one of `host`
or `port` is specified, as those specify a TCP Socket.
* `timeout` {number}: A number specifying the socket timeout in milliseconds.
This will set the timeout before the socket is connected.
* `signal` {AbortSignal}: An AbortSignal that may be used to abort an ongoing
Expand Down

0 comments on commit 4a369d0

Please sign in to comment.