diff --git a/doc/api/net.md b/doc/api/net.md index 1aedb392b4fdf4..a1c8f624a50e62 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -715,7 +715,7 @@ added: v20.12.0 * `ip` {string} The IP which the socket attempted to connect to. * `port` {number} The port which the socket attempted to connect to. * `family` {number} The family of the IP. It can be `6` for IPv6 or `4` for IPv4. - \* `error` {Error} The error associated with the failure. +* `error` {Error} The error associated with the failure. Emitted when a connection attempt failed. This may be emitted multiple times if the family autoselection algorithm is enabled in [`socket.connect(options)`][]. @@ -1710,7 +1710,7 @@ nc -U /tmp/echo.sock added: v19.4.0 --> -Gets the current default value of the `autoSelectFamily` option of [`socket.connect(options)`][]. +Gets the current default value of the `autoSelectFamily` option of [`socket.connect(options)`][]. The initial default value is `true`, unless the command line option `--no-network-family-autoselection` is provided. @@ -1722,9 +1722,9 @@ The initial default value is `true`, unless the command line option added: v19.4.0 --> -Sets the default value of the `autoSelectFamily` option of [`socket.connect(options)`][]. +Sets the default value of the `autoSelectFamily` option of [`socket.connect(options)`][]. -* `value` {boolean} The new default value. The initial default value is `false`. +* `value` {boolean} The new default value. The initial default value is `false`. ## `net.getDefaultAutoSelectFamilyAttemptTimeout()` @@ -1732,7 +1732,7 @@ Sets the default value of the `autoSelectFamily` option of [`socket.connect(opt added: v19.8.0 --> -Gets the current default value of the `autoSelectFamilyAttemptTimeout` option of [`socket.connect(options)`][]. +Gets the current default value of the `autoSelectFamilyAttemptTimeout` option of [`socket.connect(options)`][]. The initial default value is `250` or the value specified via the command line option `--network-family-autoselection-attempt-timeout`. @@ -1744,9 +1744,9 @@ option `--network-family-autoselection-attempt-timeout`. added: v19.8.0 --> -Sets the default value of the `autoSelectFamilyAttemptTimeout` option of [`socket.connect(options)`][]. +Sets the default value of the `autoSelectFamilyAttemptTimeout` option of [`socket.connect(options)`][]. -* `value` {number} The new default value, which must be a positive number. If the number is less than `10`, +* `value` {number} The new default value, which must be a positive number. If the number is less than `10`, the value `10` is used instead. The initial default value is `250` or the value specified via the command line option `--network-family-autoselection-attempt-timeout`.