doc: replace alpn with protocol in quic.md #61352
Open
+15
−13
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
The code was refactored in commit 062ae6f to use 'protocol' instead of 'alpn' for the ALPN protocol identifier option. However, the documentation was not updated to reflect this change. This commit updates the documentation to match the actual implementation: - Removes the non-functional 'alpn' option from SessionOptions - Adds the 'protocol' option with proper description - Updates example code to use 'protocol' instead of 'alpn' - Updates OnHandshakeCallback parameter from 'alpn' to 'protocol' Refs: nodejs@062ae6f3cb5
nodejs-github-bot
added
doc
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.
The code was refactored in commit 062ae6f to use 'protocol' instead of 'alpn'
for the ALPN protocol identifier option. However, the documentation was not updated
to reflect this change.
This commit updates the documentation to match the actual implementation:
Why this change is necessary:
The destructuring assignment in
processTlsOptions()expects aprotocolproperty:pt
const { protocol } = tls;
Therefore, using
alpnwill not work:// This won't work
const alpn = 'h3';
connect(address, { alpn }); // protocol will be undefined
// This is correct
const protocol = 'h3';
connect(address, { protocol });
Refs: 062ae6f3cb5