doc: document family:0 behavior in socket.connect

Now that family:0 is documented in socket.connect(), add an explanation of what it means since 0 is not an IP family. PR-URL: #28574 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
nodejs · Jul 20, 2019 · 643d099 · 643d099
1 parent a24ab56
commit 643d099
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/doc/api/net.md b/doc/api/net.md
@@ -618,8 +618,8 @@ For TCP connections, available `options` are:
 * `host` {string} Host the socket should connect to. **Default:** `'localhost'`.
 * `localAddress` {string} Local address the socket should connect from.
 * `localPort` {number} Local port the socket should connect from.
-* `family` {number}: Version of IP stack. Must be `4`, `6`, or `0`.
-  **Default:** `0`.
+* `family` {number}: Version of IP stack. Must be `4`, `6`, or `0`. The value
+  `0` indicates that both IPv4 and IPv6 addresses are allowed. **Default:** `0`.
 * `hints` {number} Optional [`dns.lookup()` hints][].
 * `lookup` {Function} Custom lookup function. **Default:** [`dns.lookup()`][].