diff options
| author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-29 14:16:44 +0300 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-05-02 06:17:08 +0300 |
| commit | 392d80a617fab8630e3f017076f1f59403db6470 (patch) | |
| tree | 8569c662136f6b70e58612b0130ae7dbfb12e110 /doc/api/tls.md | |
| parent | 536b1fbd3ff38df3d5e8eb0b011820fd94f68b9d (diff) | |
| download | android-node-v8-392d80a617fab8630e3f017076f1f59403db6470.tar.gz android-node-v8-392d80a617fab8630e3f017076f1f59403db6470.tar.bz2 android-node-v8-392d80a617fab8630e3f017076f1f59403db6470.zip | |
doc: add missing periods or colons
Some other formatting nits were fixed
and some superfluous descriptions were simplified in passing.
PR-URL: https://github.com/nodejs/node/pull/20401
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'doc/api/tls.md')
| -rw-r--r-- | doc/api/tls.md | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index beb2ec679e..bdda8bd734 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -404,7 +404,7 @@ added: v3.0.0 * Returns: {Buffer} Returns a `Buffer` instance holding the keys currently used for -encryption/decryption of the [TLS Session Tickets][] +encryption/decryption of the [TLS Session Tickets][]. ### server.listen() @@ -516,10 +516,9 @@ added: v0.11.4 * Returns: {Object} -Returns the bound address, the address family name, and port of the -underlying socket as reported by the operating system. Returns an -object with three properties, e.g. -`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }` +Returns the bound `address`, the address `family` name, and `port` of the +underlying socket as reported by the operating system: +`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`. ### tlsSocket.authorizationError <!-- YAML @@ -565,7 +564,7 @@ added: v0.11.4 Returns an object representing the cipher name. The `version` key is a legacy field which always contains the value `'TLSv1/SSLv3'`. -For example: `{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }` +For example: `{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }`. See `SSL_CIPHER_get_name()` in https://www.openssl.org/docs/man1.1.0/ssl/SSL_CIPHER_get_name.html for more @@ -585,7 +584,7 @@ ephemeral. As this is only supported on a client socket; `null` is returned if called on a server socket. The supported types are `'DH'` and `'ECDH'`. The `name` property is available only when type is 'ECDH'. -For Example: `{ type: 'ECDH', name: 'prime256v1', size: 256 }` +For example: `{ type: 'ECDH', name: 'prime256v1', size: 256 }`. ### tlsSocket.getFinished() <!-- YAML @@ -1216,7 +1215,6 @@ const options = { // This is necessary only if using the client certificate authentication. requestCert: true, - }; const server = tls.createServer(options, (socket) => { @@ -1341,7 +1339,7 @@ changes: * `session` {Buffer} An optional `Buffer` instance containing a TLS session. * `requestOCSP` {boolean} If `true`, specifies that the OCSP status request extension will be added to the client hello and an `'OCSPResponse'` event - will be emitted on the socket before establishing a secure communication + will be emitted on the socket before establishing a secure communication. Creates a new secure pair object with two streams, one of which reads and writes the encrypted data and the other of which reads and writes the cleartext data. |