Improved description accuracy of pfx option #597
Merged
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 pfx option is eventually passed to
tls.createSecureContext(options)
.According to the recent node.js reference, not only
String
but alsoBuffer
is accepted.For this reason, I modified the document to fit.
In real situation, I tried to use a pfx file for client authentication
but I was a bit confused by the description that type of
pfx
isString
.Because, pfx (PKCS#12) file is a binary file.
The kind of change this PR does introduce
Current behaviour
New behaviour
Other information (e.g. related issues)
node.js v.4.x reference: https://nodejs.org/docs/latest-v4.x/api/tls.html#tls_tls_createsecurecontext_details
node.js v.6.x reference: https://nodejs.org/docs/latest-v6.x/api/tls.html#tls_tls_createsecurecontext_options
node.js v.8.x reference: https://nodejs.org/docs/latest-v6.x/api/tls.html#tls_tls_createsecurecontext_options