diff options
| author | Sam Roberts <vieuxtech@gmail.com> | 2018-11-20 13:42:15 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-11-20 14:42:47 -0800 |
| commit | 67c092127e06208df7087730d3a48de2cc2fe89a (patch) | |
| tree | e513c77f53388dec68b075717eaf6bd3f2cf41f3 /doc | |
| parent | 26b5d63f4d01f87693eea0f696a2d669492188d8 (diff) | |
| download | node-new-67c092127e06208df7087730d3a48de2cc2fe89a.tar.gz | |
doc: minor cleanup of tls.getProtocol()
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/tls.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index 69cfae438b..fe3282f97e 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -756,19 +756,19 @@ to implement the `tls-unique` channel binding from [RFC 5929][]. added: v5.7.0 --> -* Returns: {string} +* Returns: {string|null} Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value `'unknown'` will be returned for connected sockets that have not completed the handshaking process. The value `null` will be returned for server sockets or disconnected client sockets. -Example responses include: +Protocol versions are: -* `TLSv1` -* `TLSv1.1` -* `TLSv1.2` -* `unknown` +* `'TLSv1'` +* `'TLSv1.1'` +* `'TLSv1.2'` +* `'SSLv3'` See <https://www.openssl.org/docs/man1.1.0/ssl/SSL_get_version.html> for more information. |