Skip to content

Commit 17bff5c

Browse files
sam-githubtargos
authored andcommitted
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 <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
1 parent c756b84 commit 17bff5c

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

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

13461348
A key is *required* for ciphers that make use of certificates. Either `key` or
13471349
`pfx` can be used to provide it.
@@ -1588,6 +1590,7 @@ where `secureSocket` has the same API as `pair.cleartext`.
15881590
[`net.Server.address()`]: net.html#net_server_address
15891591
[`net.Server`]: net.html#net_class_net_server
15901592
[`net.Socket`]: net.html#net_class_net_socket
1593+
[`server.addContext()`]: #tls_server_addcontext_hostname_context
15911594
[`server.getConnections()`]: net.html#net_server_getconnections_callback
15921595
[`server.getTicketKeys()`]: #tls_server_getticketkeys
15931596
[`server.listen()`]: net.html#net_server_listen

0 commit comments

Comments
 (0)