diff options
| author | cjihrig <cjihrig@gmail.com> | 2019-07-06 09:39:36 -0400 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2019-07-08 13:31:18 -0400 |
| commit | f67a0a17a00725215f3bcd8de810ff1c1bad4f85 (patch) | |
| tree | 8b74bc05c49ce7033d41a2a0b6f6006c424d7508 /doc/api/net.md | |
| parent | 36fdf1aa6c87ccfaebabb8f9c8004baab0549b0b (diff) | |
| download | android-node-v8-f67a0a17a00725215f3bcd8de810ff1c1bad4f85.tar.gz android-node-v8-f67a0a17a00725215f3bcd8de810ff1c1bad4f85.tar.bz2 android-node-v8-f67a0a17a00725215f3bcd8de810ff1c1bad4f85.zip | |
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 <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/net.md')
| -rw-r--r-- | doc/api/net.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/net.md b/doc/api/net.md index a12ac4ad3c..f1134c0492 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()`][]. |