Skip to content

Commit 48852cc

Browse files
sam-githubrvagg
authored andcommitted
doc: minor cleanup of tls.getProtocol()
Improve markup and return value description. PR-URL: #24533 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
1 parent d345271 commit 48852cc

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
@@ -756,19 +756,19 @@ to implement the `tls-unique` channel binding from [RFC 5929][].
756756
added: v5.7.0
757757
-->
758758

759-
* Returns: {string}
759+
* Returns: {string|null}
760760

761761
Returns a string containing the negotiated SSL/TLS protocol version of the
762762
current connection. The value `'unknown'` will be returned for connected
763763
sockets that have not completed the handshaking process. The value `null` will
764764
be returned for server sockets or disconnected client sockets.
765765

766-
Example responses include:
766+
Protocol versions are:
767767

768-
* `TLSv1`
769-
* `TLSv1.1`
770-
* `TLSv1.2`
771-
* `unknown`
768+
* `'TLSv1'`
769+
* `'TLSv1.1'`
770+
* `'TLSv1.2'`
771+
* `'SSLv3'`
772772

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

0 commit comments

Comments
 (0)