Skip to content

Commit d60da08

Browse files
Trotttargos
authored andcommitted
doc: clarify text about using 'session' event for compatibility
PR-URL: #30746 Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent 85067c1 commit d60da08

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/api/tls.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -726,14 +726,14 @@ On the client, the `session` can be provided to the `session` option of
726726

727727
See [Session Resumption][] for more information.
728728

729-
Note: For TLSv1.2 and below, [`tls.TLSSocket.getSession()`][] can be called once
730-
the handshake is complete. For TLSv1.3, only ticket based resumption is allowed
729+
For TLSv1.2 and below, [`tls.TLSSocket.getSession()`][] can be called once
730+
the handshake is complete. For TLSv1.3, only ticket-based resumption is allowed
731731
by the protocol, multiple tickets are sent, and the tickets aren't sent until
732-
later, after the handshake completes, so it is necessary to wait for the
733-
`'session'` event to get a resumable session. Applications are
734-
recommended to use the `'session'` event instead of `getSession()` to ensure
735-
they will work for all TLS protocol versions. Applications that only expect to
736-
get or use 1 session should listen for this event only once:
732+
after the handshake completes. So it is necessary to wait for the
733+
`'session'` event to get a resumable session. Applications
734+
should use the `'session'` event instead of `getSession()` to ensure
735+
they will work for all TLS versions. Applications that only expect to
736+
get or use one session should listen for this event only once:
737737

738738
```js
739739
tlsSocket.once('session', (session) => {

0 commit comments

Comments
 (0)