Skip to content

Commit

Permalink
doc: remove reference to "credentials object"
Browse files Browse the repository at this point in the history
The reference is confusing because the object is actually of class
SecureContext. There is no object with class "credentials".

See: nodejs#20432 (comment)
  • Loading branch information
sam-github committed Mar 25, 2019
1 parent 97737fd commit d4ce20b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -1406,7 +1406,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. The
object has no public methods, but is accepted as an argument to several `tls`
APIs, such as [`tls.createServer()`][] and [`server.addContext()`][].

A key is *required* for ciphers that make use of certificates. Either `key` or
`pfx` can be used to provide it.
Expand Down Expand Up @@ -1658,6 +1660,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
Expand Down

0 comments on commit d4ce20b

Please sign in to comment.