doc: add Array type in http request headers #58049
Open
+2
−1
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
|
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
| @@ -3818,7 +3818,7 @@ changes: | |||
| * `family` {number} IP address family to use when resolving `host` or | |||
| `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. | |||
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.
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#58049 Fixes: nodejs#57986 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
mikaws
force-pushed
the
doc-http-request-headers-array
branch
from
ff83ffa to
ad2fb4d
Compare
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#58049 Fixes: nodejs#57986 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
mikaws
force-pushed
the
doc-http-request-headers-array
branch
from
ad2fb4d to
0b8059e
Compare
I've fixed the commit message issues. |
trivikr
reviewed
Apr 29, 2025
| @@ -3818,7 +3818,7 @@ changes: | |||
| * `family` {number} IP address family to use when resolving `host` or | |||
| `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`][]. | |||
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`][]. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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