doc: clarify http2 compatibility API example#64235
Open
ChloeVPin wants to merge 1 commit into
Open
Conversation
Collaborator
|
Review requested:
|
Replace the introductory compatibility API example that set the same header twice with a straightforward writeHead() example. Add a short note that setHeader() and writeHead() headers are merged, with writeHead() taking precedence. Refs: nodejs#25952 Signed-off-by: ChloeVPin <227690662+ChloeVPin@users.noreply.github.com>
ChloeVPin
force-pushed
the
doc/http2-compatibility-api-example
branch
from
47c7a69 to
51f9064
Compare
nodejs-github-bot
added
doc
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Fixes part of #25952
The introductory Compatibility API example set Content-Type via
setHeader() and then overwrote it in writeHead(), which is confusing
for readers who do not already know that writeHead() merges headers.
This PR:
merged, with writeHead() taking precedence
The HTTP2_HEADER_* constants documentation is intentionally left for
a separate discussion, per maintainer feedback on the issue.