doc: add Array type in http request headers#58049
Merged
Uh oh!
There was an error while loading. Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Collaborator
nodejs-github-bot commented Apr 27, 2025
Review requested:
|
nodejs-github-bot added doc 
8 tasks
anonrig approved these changes Apr 27, 2025
anonrig added the author ready 
jasnell approved these changes Apr 27, 2025
lpinca reviewed Apr 27, 2025
doc/api/http.md Outdated
| `hostname`. Valid values are `4` or `6`. When unspecified, both IP v4 and | ||
| v6 will be used. | ||
| * `headers`{Object} An object containing request headers. | ||
| * `headers`{Object|Array} An object or an array of strings containing request headers. The array is in the same format as request.rawHeaders. |
Member
There was a problem hiding this comment.
Suggested change
| *`headers`{Object|Array} An object or an array of strings containing request headers. The array is in the same format as request.rawHeaders. | |
| *`headers`{Object|Array} An object or an array of strings containing request headers. The array is in the same format as [`message.rawHeaders`][]. |
and
[`message.rawHeaders`]: #messagerawheaders at the end of the file.
ContributorAuthor
There was a problem hiding this comment.
Thank you :)
I've updated the commit with the suggested change to reference [message.rawHeaders][].
Please let me know if there's anything else needed. See ad2fb4d.
ShogunPanda approved these changes Apr 28, 2025
marco-ippolito approved these changes Apr 28, 2025
mikaws added a commit to mikaws/node that referenced this pull request Apr 28, 2025
Document that the headers option in http.request() can be either an object or an array of strings, similar to message.rawHeaders. PR-URL: nodejs#58049Fixes: nodejs#57986 Reviewed-By: Luigi Pinca <[email protected]>
mikawsforce-pushed the doc-http-request-headers-array branch from ff83ffa to ad2fb4dComparemikaws added a commit to mikaws/node that referenced this pull request Apr 28, 2025
Document that the headers option in http.request() can be either an object or an array of strings, similar to message.rawHeaders. PR-URL: nodejs#58049Fixes: nodejs#57986 Reviewed-By: Luigi Pinca <[email protected]>
mikawsforce-pushed the doc-http-request-headers-array branch from ad2fb4d to 0b8059eCompare
ContributorAuthor
mikaws commented Apr 28, 2025
I've fixed the commit message issues. |
trivikr reviewed Apr 29, 2025
doc/api/http.md Outdated
| `hostname`. Valid values are `4` or `6`. When unspecified, both IP v4 and | ||
| v6 will be used. | ||
| * `headers`{Object} An object containing request headers. | ||
| * `headers`{Object|Array} An object or an array of strings containing request headers. The array is in the same format as [`message.rawHeaders`][]. |
Member
There was a problem hiding this comment.
nit: limit line length to 80 characters, and remove extra space
Suggested change
| *`headers`{Object|Array} An object or an array of strings containing request headers. The array is in the same format as [`message.rawHeaders`][]. | |
| *`headers`{Object|Array} An object or an array of strings containing request | |
| headers. The array is in the same format as [`message.rawHeaders`][]. |
ContributorAuthor
There was a problem hiding this comment.
Fixed as suggested, thanks for the careful review. See 238caa5.
Document that the headers option in http.request() can be either an object or an array of strings, similar to message.rawHeaders. PR-URL: nodejs#58049Fixes: nodejs#57986 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
mikawsforce-pushed the doc-http-request-headers-array branch from 0b8059e to 238caa5Compare
bjohansebas approved these changes May 1, 2025
Ethan-Arrowood approved these changes May 8, 2025
Ethan-Arrowood added backported-to-v20.x jeremymeng added a commit to jeremymeng/azure-sdk-for-js that referenced this pull request May 12, 2025
The latest @types/node changes add `string[]` to the `RequestOptions.headers` type: DefinitelyTyped/DefinitelyTyped#72617nodejs/node#58049 This PR adds a check and narrow the the type to `http.OutgoingHttpHeaders` before accessing user-agent property. We don't ever set the user agent header using the `string[]` form so this should be fine.
jeremymeng added a commit to jeremymeng/azure-sdk-for-js that referenced this pull request May 12, 2025
The latest @types/node changes add `string[]` to the `RequestOptions.headers` type: DefinitelyTyped/DefinitelyTyped#72617nodejs/node#58049 This PR adds a check and narrow the the type to `http.OutgoingHttpHeaders` before accessing user-agent property. We don't ever set the user agent header using the `string[]` form so this should be fine.
jeremymeng added a commit to Azure/azure-sdk-for-js that referenced this pull request May 12, 2025
The latest @types/node changes add `string[]` to the `RequestOptions.headers` type: DefinitelyTyped/DefinitelyTyped#72617nodejs/node#58049 This PR adds a check and narrow the type to `http.OutgoingHttpHeaders` before accessing user-agent property. We don't ever set the user agent header using the `string[]` form so this should be fine.
4 tasks
aduh95 added commit-queue nodejs-github-bot removed the commit-queue nodejs-github-bot merged commit db8ca62 into nodejs:main 34 checks passed
Uh oh!
There was an error while loading. Please reload this page.
Collaborator
nodejs-github-bot commented Jun 27, 2025
Landed in db8ca62 |
targos pushed a commit that referenced this pull request Jul 3, 2025
Document that the headers option in http.request() can be either an object or an array of strings, similar to message.rawHeaders. PR-URL: #58049Fixes: #57986 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Ethan Arrowood <[email protected]>
aduh95 pushed a commit that referenced this pull request Jul 21, 2025
Document that the headers option in http.request() can be either an object or an array of strings, similar to message.rawHeaders. PR-URL: #58049Fixes: #57986 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Ethan Arrowood <[email protected]>
aduh95 pushed a commit that referenced this pull request Jul 24, 2025
Document that the headers option in http.request() can be either an object or an array of strings, similar to message.rawHeaders. PR-URL: #58049Fixes: #57986 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Ethan Arrowood <[email protected]>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
11 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The http.request allows sending headers as an array of strings.
Fixes: #57986