From dfacb8091420ea1251f87f11f46a4a27ad861262 Mon Sep 17 00:00:00 2001 From: Austin Cheney Date: Sat, 12 Feb 2022 05:49:03 -0600 Subject: [PATCH] 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 Reviewed-By: Luigi Pinca --- doc/api/tls.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/tls.md b/doc/api/tls.md index bc3b96510cdcf7..63e67b26f3b5fa 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.