From 643d09961baaa034056e2e4db2450dbbba48c9cb Mon Sep 17 00:00:00 2001 From: cjihrig Date: Sat, 6 Jul 2019 09:39:36 -0400 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/28574 Reviewed-By: Luigi Pinca Reviewed-By: Rich Trott Reviewed-By: Anna Henningsen Reviewed-By: Ruben Bridgewater --- doc/api/net.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/net.md b/doc/api/net.md index a12ac4ad3cc258..f1134c0492dedc 100644 --- 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()`][].