diff options
| author | Sam Roberts <vieuxtech@gmail.com> | 2019-03-25 12:12:17 -0700 |
|---|---|---|
| committer | Sam Roberts <vieuxtech@gmail.com> | 2019-03-28 14:06:59 -0700 |
| commit | f11f1808785fee9741436dfb43a87e2050d8b3af (patch) | |
| tree | 2cd9fdb8d2ecfab0d2e60079fce19a0bf81c7c02 /doc/api/tls.md | |
| parent | 8c69e06972b5b0aa7e45163f860fb63d90203289 (diff) | |
| download | android-node-v8-f11f1808785fee9741436dfb43a87e2050d8b3af.tar.gz android-node-v8-f11f1808785fee9741436dfb43a87e2050d8b3af.tar.bz2 android-node-v8-f11f1808785fee9741436dfb43a87e2050d8b3af.zip | |
doc: remove reference to "credentials object"
The reference is confusing because the object is actually of class
SecureContext. There is no object with class "credentials".
See: https://github.com/nodejs/node/issues/20432#issuecomment-441819285
PR-URL: https://github.com/nodejs/node/pull/26908
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Diffstat (limited to 'doc/api/tls.md')
| -rw-r--r-- | doc/api/tls.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index ee390e1bdb..2a9bcd6f29 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1400,7 +1400,9 @@ to `true`, other APIs that create secure contexts leave it unset. from `process.argv` as the default value of the `sessionIdContext` option, other APIs that create secure contexts have no default value. -The `tls.createSecureContext()` method creates a credentials object. +The `tls.createSecureContext()` method creates a `SecureContext` object. It is +usable as an argument to several `tls` APIs, such as [`tls.createServer()`][] +and [`server.addContext()`][], but has no public methods. A key is *required* for ciphers that make use of certificates. Either `key` or `pfx` can be used to provide it. @@ -1681,6 +1683,7 @@ where `secureSocket` has the same API as `pair.cleartext`. [`net.Server.address()`]: net.html#net_server_address [`net.Server`]: net.html#net_class_net_server [`net.Socket`]: net.html#net_class_net_socket +[`server.addContext()`]: #tls_server_addcontext_hostname_context [`server.getConnections()`]: net.html#net_server_getconnections_callback [`server.getTicketKeys()`]: #tls_server_getticketkeys [`server.listen()`]: net.html#net_server_listen |