From 4843244adbd9ac237623e696c4eee8a73098a414 Mon Sep 17 00:00:00 2001 From: Robert I Nilsson Date: Mon, 12 Oct 2026 17:01:14 +0200 Subject: [PATCH] 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 --- doc/api/tls.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/tls.md b/doc/api/tls.md index 7df2ab938606..9664471d522a 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -2235,7 +2235,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 @@ -2267,7 +2268,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`.