doc: remove reference to "credentials object" #26908
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
cjihrig
approved these changes
Mar 25, 2019
The reference is confusing because the object is actually of class SecureContext. There is no object with class "credentials". See: nodejs#20432 (comment)
sam-github
force-pushed
the
remove-credentials-object
branch
from
d03b7a2
to
d4ce20b
Compare
lpinca
approved these changes
Mar 25, 2019
Trott
reviewed
Mar 25, 2019
doc/api/tls.md
Outdated
| @@ -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` | |||
There was a problem hiding this comment.
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()`][].There was a problem hiding this comment.
I see your point, how about ba029f5?
BridgeAR
approved these changes
Mar 26, 2019
BridgeAR
added
the
author ready
sagirk
approved these changes
Mar 26, 2019
bnoordhuis
approved these changes
Mar 27, 2019
|
Landed in f11f180 |
sam-github
added a commit
that referenced
this pull request
Mar 28, 2019
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]>
targos
pushed a commit
that referenced
this pull request
Mar 28, 2019
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]>
targos
pushed a commit
that referenced
this pull request
Mar 29, 2019
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]>
targos
pushed a commit
that referenced
this pull request
Mar 30, 2019
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]>
|
@sam-github Why does Specifically, |
|
@cinderblock I can't speak to the history, but I can say if there is a specific feature you would like, please post a feature request. It will help to have some concrete use cases. There are lots of things we could just make public, but it takes short term effort to add tests and docs (though feature requests with an acompanying PR don't have to attract a volunteer), and long-term, it can make it harder to improve the node API if too much of our internals are exposed in the API. |
BethGriggs
pushed a commit
that referenced
this pull request
Apr 5, 2019
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]>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The reference is confusing because the object is actually of class
SecureContext. There is no object with class "credentials".
See: #20432 (comment)
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes