Skip to content

Commit b42c3f3

Browse files
authored
doc: added 'secure' event to tls.TLSSocket
Fixes #61060
1 parent 05f8772 commit b42c3f3

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

doc/api/tls.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -951,6 +951,18 @@ The listener callback is passed a single argument when called:
951951
Typically, the `response` is a digitally signed object from the server's CA that
952952
contains information about server's certificate revocation status.
953953

954+
### Event: `'secure'`
955+
956+
<!-- YAML
957+
added: v0.11.4
958+
-->
959+
960+
The `'secure'` event is emitted after the TLS handshake has successfully
961+
completed and a secure connection has been established.
962+
963+
This event is emitted on both client and server {tls.TLSSocket} instances,
964+
including sockets created using the `new tls.TLSSocket()` constructor.
965+
954966
### Event: `'secureConnect'`
955967

956968
<!-- YAML
@@ -1529,7 +1541,7 @@ changes:
15291541
* `requestCert`
15301542

15311543
* `callback` {Function} If `renegotiate()` returned `true`, callback is
1532-
attached once to the `'secure'` event. If `renegotiate()` returned `false`,
1544+
attached once to the [`'secure'`][] event. If `renegotiate()` returned `false`,
15331545
`callback` will be called in the next tick with an error, unless the
15341546
`tlsSocket` has been destroyed, in which case `callback` will not be called
15351547
at all.
@@ -2456,6 +2468,7 @@ added: v0.11.3
24562468
[TLS recommendations]: https://wiki.mozilla.org/Security/Server_Side_TLS
24572469
[`'newSession'`]: #event-newsession
24582470
[`'resumeSession'`]: #event-resumesession
2471+
[`'secure'`]: #event-secure
24592472
[`'secureConnect'`]: #event-secureconnect
24602473
[`'secureConnection'`]: #event-secureconnection
24612474
[`'session'`]: #event-session

0 commit comments

Comments
 (0)