Skip to content

Commit 4cadddc

Browse files
cjihrigtargos
authored andcommitted
doc: document behavior of family:0 in dns.lookup()
Fixes: #28159 PR-URL: #28163 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent a40cfb3 commit 4cadddc

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/api/dns.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,9 @@ changes:
139139
-->
140140
* `hostname` {string}
141141
* `options` {integer | Object}
142-
- `family` {integer} The record family. Must be `4` or `6`. IPv4
143-
and IPv6 addresses are both returned by default.
142+
- `family` {integer} The record family. Must be `4`, `6`, or `0`. The value
143+
`0` indicates that IPv4 and IPv6 addresses are both returned. **Default:**
144+
`0`.
144145
- `hints` {number} One or more [supported `getaddrinfo` flags][]. Multiple
145146
flags may be passed by bitwise `OR`ing their values.
146147
- `all` {boolean} When `true`, the callback returns all resolved addresses in
@@ -669,8 +670,9 @@ added: v10.6.0
669670
-->
670671
* `hostname` {string}
671672
* `options` {integer | Object}
672-
- `family` {integer} The record family. Must be `4` or `6`. IPv4
673-
and IPv6 addresses are both returned by default.
673+
- `family` {integer} The record family. Must be `4`, `6`, or `0`. The value
674+
`0` indicates that IPv4 and IPv6 addresses are both returned. **Default:**
675+
`0`.
674676
- `hints` {number} One or more [supported `getaddrinfo` flags][]. Multiple
675677
flags may be passed by bitwise `OR`ing their values.
676678
- `all` {boolean} When `true`, the `Promise` is resolved with all addresses in

0 commit comments

Comments
 (0)