doc: clarify http.request supports headers as array #58810
+10
−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
This PR updates the documentation for `http.request()` to clarify that the `headers` option can also be an array of key-value pairs, similar to `response.writeHead`. Fixes: nodejs#57986
Added a detailed explanation for how the 'headers' option in http.request can also be passed as a flat array of alternating header names and values. This provides clarity for beginners and aligns with the format used in response.writeHead() and request.rawHeaders.
- Removed duplicate definition of [`response.writeHead()`] as it already exists earlier in the file. - Updated [`request.rawHeaders`] link to be relative (#requestrawheaders) instead of using an absolute URL. These fixes resolve markdown linting issues flagged by the CI and ensure consistency with documentation standards.
This PR updates the documentation for `http.request()` to clarify that the `headers` option can also be an array of key-value pairs, similar to `response.writeHead`. Fixes: nodejs#57986 doc: clarify headers array format in http.request options Added a detailed explanation for how the 'headers' option in http.request can also be passed as a flat array of alternating header names and values. This provides clarity for beginners and aligns with the format used in response.writeHead() and request.rawHeaders. fix: address markdown linting issues and link formatting - Removed duplicate definition of [`response.writeHead()`] as it already exists earlier in the file. - Updated [`request.rawHeaders`] link to be relative (#requestrawheaders) instead of using an absolute URL. These fixes resolve markdown linting issues flagged by the CI and ensure consistency with documentation standards. temp: prepare for rebase
|
Review requested:
|
nodejs-github-bot
added
doc
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.
Updated the documentation for http.request to clarify the array format for headers.