doc: clarify dns.lookup() callback signature when all is true#62800
Open
galaxy4276 wants to merge 1 commit intonodejs:mainfrom
Open
doc: clarify dns.lookup() callback signature when all is true#62800galaxy4276 wants to merge 1 commit intonodejs:mainfrom
galaxy4276 wants to merge 1 commit intonodejs:mainfrom
Conversation
Document the `addresses` argument returned by the callback when `options.all` is true, and note that `address` and `family` are not provided in that case. Fixes nodejs#57355 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
dns
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.
Summary
The
callbackparameter block fordns.lookup()only documented the default signature(err, address, family). Whenoptions.allis set totrue, the callback signature changes to(err, addresses), but theaddressesargument was absent from the structured parameter documentation.it was only mentioned in prose below.
Changes
addresses{Object[]} to thecallbackparameter block, describingthe array of
{ address, family }objects returned whenoptions.allis
trueoptions.allistrue" notes toaddressandfamilyparameters to make the two code paths explicitFixes: #57355
Test plan
make lint-mdpasses