Skip to content

lib: update params in jsdoc for HTTPRequestOptions #49872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aduh95 merged 1 commit into from
Sep 29, 2023
+4 −0
Merged

lib: update params in jsdoc for HTTPRequestOptions #49872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/http.js
View file
Open in desktop
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
View file
Open in desktop
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