Skip to main content
GoodFirstPicks
DashboardIssuesReposLeaderboard

GoodFirstPicks by Leaveitblank © 2026

CreatorRequest a RepoPrivacy PolicyTerms of Service
dns.lookup signature out of date | GoodFirstPicks

dns.lookup signature out of date

nodejs/node 2 comments 20d ago
View on GitHub
easyopenScope: clearSkill match: yesNode.jsJavaScript

Why this is a good first issue

The issue is a documentation clarification based on maintainer feedback.

AI Summary

The issue points out a perceived discrepancy in the `dns.lookup` callback signature documentation, but maintainers have confirmed the documentation is correct for the default case. The task involves verifying and potentially clarifying the documentation to avoid confusion.

Issue Description

Affected URL(s)

https://nodejs.org/docs/latest-v20.x/api/dns.html#dnslookuphostname-options-callback

Description of the problem

As seen in issues like: https://github.com/nodejs/node/issues/55762

the signature described in the documentation is incorrect. The docs describe the signature like this:

  • callback
    • err
    • address A string representation of an IPv4 or IPv6 address.
    • family 4 or 6, denoting the family of address, or 0 if the address is not an IPv4 or IPv6 address. 0 is a likely indicator of a bug in the name resolution service used by the operating system.

While in reality the signature looks like this: callback(err, [{address, family}]);

GitHub Labels

doc

Want to work on this?

Claim this issue to let others know you're working on it. You'll earn 5 points when you complete it!

Loading labels...

Details

Points5 pts
Difficultyeasy
Scopeclear
Skill Matchyes
Test Focusedno