diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-03-11 17:30:56 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-03-14 07:50:16 -0700 |
| commit | 14809aaa98b92a8dc29bc387753768499df06211 (patch) | |
| tree | 69e9e94337270e892c98b4a556a3c5b6616a5c23 | |
| parent | 4ae320f2b3c745402955019d6a57a22ee2b8d3bd (diff) | |
| download | node-new-14809aaa98b92a8dc29bc387753768499df06211.tar.gz | |
doc: clarify default TLS handshake timeout
Because the `handshakeTimeout` is in milliseconds, use that unit of
measurement to express the default value.
PR-URL: https://github.com/nodejs/node/pull/19290
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
| -rw-r--r-- | doc/api/tls.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index d3f3fdadff..cff01013c1 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1127,9 +1127,9 @@ changes: * `clientCertEngine` {string} Optional name of an OpenSSL engine which can provide the client certificate. * `handshakeTimeout` {number} Abort the connection if the SSL/TLS handshake - does not finish in the specified number of milliseconds. Defaults to `120` - seconds. A `'tlsClientError'` is emitted on the `tls.Server` object whenever - a handshake times out. + does not finish in the specified number of milliseconds. Defaults to + `120000` (120 seconds). A `'tlsClientError'` is emitted on the `tls.Server` + object whenever a handshake times out. * `requestCert` {boolean} If `true` the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to `false`. |