doc: improve agent.createConnection docs for http and https agents #58205
+31
−11
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:
|
Ethan-Arrowood
approved these changes
May 8, 2025
mag123c
force-pushed
the
docs/agent-createconnection-callback-clarification
branch
from
e99a2ca to
add0b05
Compare
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.
This PR improves the documentation for http.Agent#createConnection() and https.Agent by clarifying the behavior of the createConnection(options[, callback]) method.
In the current docs, the callback is mentioned but not explained clearly in the context of default vs. custom agent implementations. This has led to confusion, especially when overriding the method for asynchronous socket creation.
The updated docs now state:
The default implementation does not use the callback and returns the socket synchronously.
Custom agents may override createConnection to support asynchronous connection creation using a (err, socket) style callback.
For https.Agent, a note was added that its createConnection method uses tls.connect() internally and follows the same override pattern as http.Agent.
This change resolves issue #58131.