Skip to content

Commit 40c9ee0

Browse files
sam-githubcodebytere
authored andcommitted
doc: minor cleanup of tls.getProtocol()
Improve markup and return value description. PR-URL: #24533 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
1 parent c16b932 commit 40c9ee0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/api/tls.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -669,19 +669,19 @@ to implement the `tls-unique` channel binding from [RFC 5929][].
669669
added: v5.7.0
670670
-->
671671

672-
* Returns: {string}
672+
* Returns: {string|null}
673673

674674
Returns a string containing the negotiated SSL/TLS protocol version of the
675675
current connection. The value `'unknown'` will be returned for connected
676676
sockets that have not completed the handshaking process. The value `null` will
677677
be returned for server sockets or disconnected client sockets.
678678

679-
Example responses include:
679+
Protocol versions are:
680680

681-
* `TLSv1`
682-
* `TLSv1.1`
683-
* `TLSv1.2`
684-
* `unknown`
681+
* `'TLSv1'`
682+
* `'TLSv1.1'`
683+
* `'TLSv1.2'`
684+
* `'SSLv3'`
685685

686686
See <https://www.openssl.org/docs/man1.1.0/ssl/SSL_get_version.html> for more
687687
information.

0 commit comments

Comments
 (0)