summaryrefslogtreecommitdiff
path: root/doc/api/dns.md
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2019-06-10 17:35:25 -0700
committerZYSzys <zyszys98@gmail.com>2019-06-14 22:00:38 +0800
commit282e2f669c0e4738a13c6b49d59dbd83002f3953 (patch)
tree73b899fe5aac863a832d8416bfe8d4eba50c7b3b /doc/api/dns.md
parent3ca0df22e67704f061e0f3b3dcdff89bb66ae4f2 (diff)
downloadandroid-node-v8-282e2f669c0e4738a13c6b49d59dbd83002f3953.tar.gz
android-node-v8-282e2f669c0e4738a13c6b49d59dbd83002f3953.tar.bz2
android-node-v8-282e2f669c0e4738a13c6b49d59dbd83002f3953.zip
doc: document behavior of family:0 in dns.lookup()
Fixes: https://github.com/nodejs/node/issues/28159 PR-URL: https://github.com/nodejs/node/pull/28163 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/dns.md')
-rw-r--r--doc/api/dns.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/api/dns.md b/doc/api/dns.md
index 22bca079c3..f019222a27 100644
--- 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