From 4a369d03b4751b649fa0734f935ff080025bf97f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 7 Jan 2022 21:31:40 -0800 Subject: [PATCH] doc: revise HTTPRequestOptions text PR-URL: https://github.com/nodejs/node/pull/41407 Reviewed-By: Luigi Pinca Reviewed-By: Matteo Collina --- doc/api/http.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/api/http.md b/doc/api/http.md index bd7aa898e4c357..eb43c3f5e1f189 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -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 @@ -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'`. @@ -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