Skip to content

Commit f11f180

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) PR-URL: #26908 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]>
1 parent 8c69e06 commit f11f180

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
@@ -1400,7 +1400,9 @@ to `true`, other APIs that create secure contexts leave it unset.
14001400
from `process.argv` as the default value of the `sessionIdContext` option, other
14011401
APIs that create secure contexts have no default value.
14021402

1403-
The `tls.createSecureContext()` method creates a credentials object.
1403+
The `tls.createSecureContext()` method creates a `SecureContext` object. It is
1404+
usable as an argument to several `tls` APIs, such as [`tls.createServer()`][]
1405+
and [`server.addContext()`][], but has no public methods.
14041406

14051407
A key is *required* for ciphers that make use of certificates. Either `key` or
14061408
`pfx` can be used to provide it.
@@ -1681,6 +1683,7 @@ where `secureSocket` has the same API as `pair.cleartext`.
16811683
[`net.Server.address()`]: net.html#net_server_address
16821684
[`net.Server`]: net.html#net_class_net_server
16831685
[`net.Socket`]: net.html#net_class_net_socket
1686+
[`server.addContext()`]: #tls_server_addcontext_hostname_context
16841687
[`server.getConnections()`]: net.html#net_server_getconnections_callback
16851688
[`server.getTicketKeys()`]: #tls_server_getticketkeys
16861689
[`server.listen()`]: net.html#net_server_listen

0 commit comments

Comments
 (0)