diff options
| author | Austin Cheney <info@prettydiff.com> | 2022-02-12 14:49:03 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-12 14:49:03 +0300 |
| commit | dfacb8091420ea1251f87f11f46a4a27ad861262 (patch) | |
| tree | 09e1a741f3939decff75217239e7424f05798569 /doc/api/tls.md | |
| parent | 863d13c192a8d315fa274194e64c1c9e5820e8f2 (diff) | |
doc: clarify `tls.Server` `'connection'` event documentation
PR-URL: https://github.com/nodejs/node/pull/41917
Fixes: https://github.com/nodejs/node/issues/41880
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc/api/tls.md')
| -rw-r--r-- | doc/api/tls.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index bc3b96510cd..63e67b26f3b 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -480,8 +480,9 @@ added: v0.3.2 * `socket` {stream.Duplex} This event is emitted when a new TCP stream is established, before the TLS -handshake begins. `socket` is typically an object of type [`net.Socket`][]. -Usually users will not want to access this event. +handshake begins. `socket` is typically an object of type [`net.Socket`][] but +will not receive events unlike the socket created from the [`net.Server`][] +`'connection'` event. Usually users will not want to access this event. This event can also be explicitly emitted by users to inject connections into the TLS server. In that case, any [`Duplex`][] stream can be passed. |