Skip to content

Commit 3937118

Browse files
Trottdanielleadams
authored andcommitted
http: add JSDoc property descriptions
PR-URL: #45370 Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Jacob Smith <jacob@frende.me>
1 parent 17a89d1 commit 3937118

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

lib/http.js

+22-22
Original file line numberDiff line numberDiff line change
@@ -62,28 +62,28 @@ function createServer(opts, requestListener) {
6262

6363
/**
6464
* @typedef {object} HTTPRequestOptions
65-
* @property {httpAgent.Agent | boolean} [agent]
66-
* @property {string} [auth]
67-
* @property {Function} [createConnection]
68-
* @property {number} [defaultPort]
69-
* @property {number} [family]
70-
* @property {object} [headers]
71-
* @property {number} [hints]
72-
* @property {string} [host]
73-
* @property {string} [hostname]
74-
* @property {boolean} [insecureHTTPParser]
75-
* @property {string} [localAddress]
76-
* @property {number} [localPort]
77-
* @property {Function} [lookup]
78-
* @property {number} [maxHeaderSize]
79-
* @property {string} [method]
80-
* @property {string} [path]
81-
* @property {number} [port]
82-
* @property {string} [protocol]
83-
* @property {boolean} [setHost]
84-
* @property {string} [socketPath]
85-
* @property {number} [timeout]
86-
* @property {AbortSignal} [signal]
65+
* @property {httpAgent.Agent | boolean} [agent] Controls Agent behavior.
66+
* @property {string} [auth] Basic authentication ('user:password') to compute an Authorization header.
67+
* @property {Function} [createConnection] Produces a socket/stream to use when the agent option is not used.
68+
* @property {number} [defaultPort] Default port for the protocol.
69+
* @property {number} [family] IP address family to use when resolving host or hostname.
70+
* @property {object} [headers] An object containing request headers.
71+
* @property {number} [hints] Optional dns.lookup() hints.
72+
* @property {string} [host] A domain name or IP address of the server to issue the request to.
73+
* @property {string} [hostname] Alias for host.
74+
* @property {boolean} [insecureHTTPParser] Use an insecure HTTP parser that accepts invalid HTTP headers when true.
75+
* @property {string} [localAddress] Local interface to bind for network connections.
76+
* @property {number} [localPort] Local port to connect from.
77+
* @property {Function} [lookup] Custom lookup function. Default: dns.lookup().
78+
* @property {number} [maxHeaderSize] Overrides the --max-http-header-size value for responses received from the server.
79+
* @property {string} [method] A string specifying the HTTP request method.
80+
* @property {string} [path] Request path.
81+
* @property {number} [port] Port of remote server.
82+
* @property {string} [protocol] Protocol to use.
83+
* @property {boolean} [setHost] Specifies whether or not to automatically add the Host header.
84+
* @property {AbortSignal} [signal] An AbortSignal that may be used to abort an ongoing request.
85+
* @property {string} [socketPath] Unix domain socket.
86+
* @property {number} [timeout] A number specifying the socket timeout in milliseconds.
8787
*/
8888

8989
/**

0 commit comments

Comments
 (0)