1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: minor cleanup of tls.getProtocol()

Browse Source 
Improve markup and return value description.

PR-URL: https://github.com/nodejs/node/pull/24533
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
This commit is contained in:
Sam Roberts 2018-11-20 13:42:15 -08:00 committed by Rich Trott
parent 26b5d63f4d
commit 67c092127e
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api/tls.md
View File

@ -756,19 +756,19 @@ to implement the `tls-unique` channel binding from [RFC 5929][].
added: v5.7.0 added: v5.7.0
--> -->
* Returns: {string} * Returns: {string|null}
Returns a string containing the negotiated SSL/TLS protocol version of the Returns a string containing the negotiated SSL/TLS protocol version of the
current connection. The value `'unknown'` will be returned for connected current connection. The value `'unknown'` will be returned for connected
sockets that have not completed the handshaking process. The value `null` will sockets that have not completed the handshaking process. The value `null` will
be returned for server sockets or disconnected client sockets. be returned for server sockets or disconnected client sockets.
Example responses include: Protocol versions are:
* `TLSv1` * `'TLSv1'`
* `TLSv1.1` * `'TLSv1.1'`
* `TLSv1.2` * `'TLSv1.2'`
* `unknown` * `'SSLv3'`
See <https://www.openssl.org/docs/man1.1.0/ssl/SSL_get_version.html> for more See <https://www.openssl.org/docs/man1.1.0/ssl/SSL_get_version.html> for more
information. information.