doc: document behavior of family:0 in dns.lookup()

Fixes: nodejs#28159
cjihrig · Jun 11, 2019 · 015d961 · 015d961
1 parent 04633ee
commit 015d961
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/doc/api/dns.md b/doc/api/dns.md
@@ -139,8 +139,9 @@ changes:
 -->
 * `hostname` {string}
 * `options` {integer | Object}
-  - `family` {integer} The record family. Must be `4` or `6`. IPv4
-    and IPv6 addresses are both returned by default.
+  - `family` {integer} The record family. Must be `4`, `6`, or `0`. The value
+    `0` indicates that IPv4 and IPv6 addresses are both returned. **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
@@ -669,8 +670,9 @@ added: v10.6.0
 -->
 * `hostname` {string}
 * `options` {integer | Object}
-  - `family` {integer} The record family. Must be `4` or `6`. IPv4
-    and IPv6 addresses are both returned by default.
+  - `family` {integer} The record family. Must be `4`, `6`, or `0`. The value
+    `0` indicates that IPv4 and IPv6 addresses are both returned. **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