Commit 8aa19d23d1a for nodejs
commit 8aa19d23d1a23c0513f588c149bb2a0e4f92db32
Author: Robert I Nilsson <robert.i.nilsson@callclue.com>
Date: Mon Oct 12 17:01:14 2026 +0200
doc: document `this` binding in TLS callbacks
Document that `this` is bound to the `tls.TLSSocket` instance
when `SNICallback` and `ALPNCallback` are invoked.
Signed-off-by: Robert I Nilsson <robert.i.nilsson@callclue.com>
PR-URL: https://github.com/nodejs/node/pull/66682
Reviewed-By: Tim Perry <pimterry@gmail.com>
diff --git a/doc/api/tls.md b/doc/api/tls.md
index e7480b06c16..032aa476417 100644
--- a/doc/api/tls.md
+++ b/doc/api/tls.md
@@ -2252,7 +2252,8 @@ changes:
e.g. `0x05hello0x05world`, where the first byte is the length of the next
protocol name. Passing an array is usually much simpler, e.g.
`['hello', 'world']`. (Protocols should be ordered by their priority.)
- * `ALPNCallback` {Function} If set, this will be called when a
+ * `ALPNCallback` {Function} If set, this will be called
+ (with `this` set to the `tls.TLSSocket` instance) when a
client opens a connection using the ALPN extension. One argument will
be passed to the callback: an object containing `servername` and
`protocols` fields, respectively containing the server name from
@@ -2282,7 +2283,8 @@ changes:
[Session Resumption][] for more information. **Default:** `300`.
* `SNICallback(servername, callback)` {Function} A function that will be
called if the client supports SNI TLS extension. Two arguments will be
- passed when called: `servername` and `callback`. `callback` is an
+ passed when called: `servername` and `callback`, with `this` set to the
+ `tls.TLSSocket` instance associated with the connection. `callback` is an
error-first callback that takes two optional arguments: `error` and `ctx`.
`ctx`, if provided, is a `SecureContext` instance.
[`tls.createSecureContext()`][] can be used to get a proper `SecureContext`.