Skip to content
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

doc: fix dns.lookup family 0 and all description #51653

Merged
merged 3 commits into from
May 11, 2024
Merged

doc: fix dns.lookup family 0 and all description #51653

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
952ae65
doc: fix dns.lookup family 0 and all description
domdomegg Feb 3, 2024
b1464a3
Fix other mentions
domdomegg Feb 3, 2024
8d84574
Fix wrapping line length
domdomegg Feb 5, 2024
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
18 changes: 10 additions & 8 deletions doc/api/dns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,9 @@ changes:
* `family` {integer|string} The record family. Must be `4`, `6`, or `0`. For
backward compatibility reasons,`'IPv4'` and `'IPv6'` are interpreted as `4`
and `6` respectively. The value `0` indicates that either an IPv4 or IPv6
address is returned. If the value `0` is used with `{ all: true } (see below)`,
both IPv4 and IPv6 addresses are returned. **Default:** `0`.
address is returned. If the value `0` is used with `{ all: true }` (see
below), either one of or both IPv4 and IPv6 addresses are returned,
depending on the system's DNS resolver. **Default:** `0`.
* `hints` {number} One or more [supported `getaddrinfo` flags][]. Multiple
flags may be passed by bitwise `OR`ing their values.
* `all` {boolean} When `true`, the callback returns all resolved addresses in
Expand Down Expand Up @@ -240,8 +241,8 @@ changes:

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
integer, then it must be `4` or `6` – if `options` is `0` or not provided, then
IPv4 and IPv6 addresses are both returned if found.
integer, then it must be `4` or `6` – if `options` is not provided, then
either IPv4 or IPv6 addresses, or both, are returned if found.

With the `all` option set to `true`, the arguments for `callback` change to
`(err, addresses)`, with `addresses` being an array of objects with the
Expand Down Expand Up @@ -988,8 +989,9 @@ changes:
* `options` {integer | Object}
* `family` {integer} The record family. Must be `4`, `6`, or `0`. The value
`0` indicates that either an IPv4 or IPv6 address is returned. If the
value `0` is used with `{ all: true }` (see below), both IPv4 and IPv6
addresses are returned. **Default:** `0`.
value `0` is used with `{ all: true }` (see below), either one of or both
IPv4 and IPv6 addresses are returned, depending on the system's DNS
resolver. **Default:** `0`.
* `hints` {number} One or more [supported `getaddrinfo` flags][]. Multiple
flags may be passed by bitwise `OR`ing their values.
* `all` {boolean} When `true`, the `Promise` is resolved with all addresses in
Expand All @@ -1013,8 +1015,8 @@ changes:

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
integer, then it must be `4` or `6` – if `options` is not provided, then IPv4
and IPv6 addresses are both returned if found.
integer, then it must be `4` or `6` – if `options` is not provided, then
either IPv4 or IPv6 addresses, or both, are returned if found.

With the `all` option set to `true`, the `Promise` is resolved with `addresses`
being an array of objects with the properties `address` and `family`.
Expand Down