Skip to content

doc: clarify dns.lookup() callback signature when all is true #62800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
galaxy4276 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

doc: clarify dns.lookup() callback signature when all is true #62800

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/api/dns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,15 @@ changes:
* `callback` {Function}
* `err` {Error}
* `address` {string} A string representation of an IPv4 or IPv6 address.
Not provided when `options.all` is `true`.
* `family` {integer} `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.
Not provided when `options.all` is `true`.
* `addresses` {Object\[]} An array of address objects when `options.all` is
`true`. Each object has the following properties:
* `address` {string} A string representation of an IPv4 or IPv6 address.
* `family` {integer} `4` or `6`, denoting the family of `address`.

Resolves a host name (e.g. `'nodejs.org'`) into the first found A (IPv4) or
AAAA (IPv6) record. All `option` properties are optional. If `options` is an
Expand Down
Loading