Skip to content

Commit

Permalink
lib: update params in jsdoc for HTTPRequestOptions
Browse files Browse the repository at this point in the history
PR-URL: #49872
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
  • Loading branch information
Jungku Lee authored and targos committed Nov 11, 2023
1 parent 10b35cf commit 3e0d47c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions lib/http.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ function createServer(opts, requestListener) {
* @property {string} [host] A domain name or IP address of the server to issue the request to.
* @property {string} [hostname] Alias for host.
* @property {boolean} [insecureHTTPParser] Use an insecure HTTP parser that accepts invalid HTTP headers when true.
* @property {boolean} [joinDuplicateHeaders] Multiple header that joined with `,` field line values.
* @property {string} [localAddress] Local interface to bind for network connections.
* @property {number} [localPort] Local port to connect from.
* @property {Function} [lookup] Custom lookup function. Default: dns.lookup().
Expand All @@ -88,6 +89,7 @@ function createServer(opts, requestListener) {
* @property {AbortSignal} [signal] An AbortSignal that may be used to abort an ongoing request.
* @property {string} [socketPath] Unix domain socket.
* @property {number} [timeout] A number specifying the socket timeout in milliseconds.
* @property {Array} [uniqueHeaders] A list of request headers that should be sent only once.
*/

/**
Expand Down
2 changes: 2 additions & 0 deletions lib/https.js
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,7 @@ function request(...args) {
* host?: string;
* hostname?: string;
* insecureHTTPParser?: boolean;
* joinDuplicateHeaders?: boolean;
* localAddress?: string;
* localPort?: number;
* lookup?: Function;
Expand All @@ -404,6 +405,7 @@ function request(...args) {
* socketPath?: string;
* timeout?: number;
* signal?: AbortSignal;
* uniqueHeaders?: Array;
* } | string | URL} [options]
* @param {Function} [cb]
* @returns {ClientRequest}
Expand Down

0 comments on commit 3e0d47c

Please sign in to comment.