Skip to content

Commit 5da3ee7

Browse files
TrottMylesBorins
authored andcommitted
doc: clarify default TLS handshake timeout
Because the `handshakeTimeout` is in milliseconds, use that unit of measurement to express the default value. PR-URL: #19290 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent a9bd8bf commit 5da3ee7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/api/tls.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1126,9 +1126,9 @@ changes:
11261126
* `clientCertEngine` {string} Optional name of an OpenSSL engine which can
11271127
provide the client certificate.
11281128
* `handshakeTimeout` {number} Abort the connection if the SSL/TLS handshake
1129-
does not finish in the specified number of milliseconds. Defaults to `120`
1130-
seconds. A `'tlsClientError'` is emitted on the `tls.Server` object whenever
1131-
a handshake times out.
1129+
does not finish in the specified number of milliseconds. Defaults to
1130+
`120000` (120 seconds). A `'tlsClientError'` is emitted on the `tls.Server`
1131+
object whenever a handshake times out.
11321132
* `requestCert` {boolean} If `true` the server will request a certificate from
11331133
clients that connect and attempt to verify that certificate. Defaults to
11341134
`false`.

0 commit comments

Comments
 (0)