Skip to content

Commit d4ce20b

Browse files
committed
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: #20432 (comment)
1 parent 97737fd commit d4ce20b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/api/tls.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1406,7 +1406,9 @@ to `true`, other APIs that create secure contexts leave it unset.
14061406
from `process.argv` as the default value of the `sessionIdContext` option, other
14071407
APIs that create secure contexts have no default value.
14081408

1409-
The `tls.createSecureContext()` method creates a credentials object.
1409+
The `tls.createSecureContext()` method creates a `SecureContext` object. The
1410+
object has no public methods, but is accepted as an argument to several `tls`
1411+
APIs, such as [`tls.createServer()`][] and [`server.addContext()`][].
14101412

14111413
A key is *required* for ciphers that make use of certificates. Either `key` or
14121414
`pfx` can be used to provide it.
@@ -1658,6 +1660,7 @@ where `secureSocket` has the same API as `pair.cleartext`.
16581660
[`net.Server.address()`]: net.html#net_server_address
16591661
[`net.Server`]: net.html#net_class_net_server
16601662
[`net.Socket`]: net.html#net_class_net_socket
1663+
[`server.addContext()`]: #tls_server_addcontext_hostname_context
16611664
[`server.getConnections()`]: net.html#net_server_getconnections_callback
16621665
[`server.getTicketKeys()`]: #tls_server_getticketkeys
16631666
[`server.listen()`]: net.html#net_server_listen

0 commit comments

Comments
 (0)