dns.lookup signature out of date

[vytasgavelis]

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: #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}]);

[lpinca]

The example in the documentation still works as expected so I think the signature is correct. The second argument of the callback is an array when the all option is set to true, but that is not the default value.

[kovan]

This appears to be working as documented — the callback signature with (err, address, family) is correct for the default all: false case. When all: true is set, the callback receives an array, which is documented separately. See @lpinca's comment above.