Skip to content

doc: remove reference to "credentials object" #26908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sam-github wants to merge 2 commits into from
+4 −1
Closed

doc: remove reference to "credentials object" #26908

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4ce20b
doc: remove reference to "credentials object"
sam-github Mar 25, 2019
ba029f5
fixup! doc: remove reference to "credentials object"
sam-github Mar 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
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)
  • Loading branch information
@sam-github
sam-github committed Mar 25, 2019
commit d4ce20b548ec66be7942971e155c72f46bc86bfb
5 changes: 4 additions & 1 deletion doc/api/tls.md
View file
Open in desktop
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`
Copy link
Copy Markdown
Member

@Trott Trott Mar 25, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Total micro-nit that you can ignore if you disagree, but I think the two sentences are clearer if you divide them up this way instead:

The `tls.createSecureContext()` method creates a `SecureContext` object with
no public methods. It is usable as an argument to several `tls` APIs such as
[`tls.createServer()`][] and [`server.addContext()`][].

Copy link
Copy Markdown
Contributor Author

@sam-github sam-github Mar 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point, how about ba029f5?

APIs, such as [`tls.createServer()`][] and [`server.addContext()`][].
Comment thread
sam-github marked this conversation as resolved.
Outdated

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