doc: argument types for crypto methods #11799
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
crypto
ameliavoncat
force-pushed
the
argument-types-for-crypto
branch
3 times, most recently
from
1e1f04e to
8f1bea4
Compare
jasnell
approved these changes
Mar 12, 2017
ameliavoncat
force-pushed
the
argument-types-for-crypto
branch
from
8f1bea4 to
887f799
Compare
joyeecheung
approved these changes
Mar 13, 2017
doc/api/crypto.md
Outdated
| @@ -62,6 +62,7 @@ const cert2 = crypto.Certificate(); | |||
| <!-- YAML | |||
| added: v0.11.8 | |||
| --> | |||
| - `spkac` {string | Buffer} | |||
There was a problem hiding this comment.
The sentence below:
The `spkac` argument can be either a string
or a [`Buffer`][].
can be removed now.
Also, while you are at it, you can just add the return type here
* Returns {Buffer} The challenge component of the `spkac` data structure,
which includes a public key and a challenge.
and remove the whole paragragh
The `spkac` data structure includes a public key and a challenge. The
`certificate.exportChallenge()` returns the challenge component in the
form of a Node.js [`Buffer`][]. The `spkac` argument can be either a string
or a [`Buffer`][].
Doesn't need to happen in this PR though :D
doc/api/crypto.md
Outdated
| @@ -80,6 +81,7 @@ console.log(challenge.toString('utf8')); | |||
| <!-- YAML | |||
| added: v0.11.8 | |||
| --> | |||
| - `spkac` {string | Buffer} | |||
doc/api/crypto.md
Outdated
| @@ -80,6 +81,7 @@ console.log(challenge.toString('utf8')); | |||
| <!-- YAML | |||
| added: v0.11.8 | |||
| --> | |||
| - `spkac` {string | Buffer} | |||
doc/api/crypto.md
Outdated
| @@ -98,6 +100,7 @@ console.log(publicKey); | |||
| <!-- YAML | |||
| added: v0.11.8 | |||
| --> | |||
| - `spkac` {Buffer} | |||
doc/api/crypto.md
Outdated
| @@ -214,6 +219,7 @@ been completed using the [`cipher.final()`][] method. | |||
| <!-- YAML | |||
| added: v0.7.1 | |||
| --> | |||
| - `auto_padding` {boolean} | |||
There was a problem hiding this comment.
The auto_padding=true part above can be modified to cipher.setAutoPadding([auto_padding]) if we make this item:
- `auto_padding` {boolean} Defaults to true.
doc/api/crypto.md
Outdated
| @@ -372,6 +384,7 @@ Returns `this` for method chaining. | |||
| <!-- YAML | |||
| added: v0.7.1 | |||
| --> | |||
| - `auto_padding` {boolean} | |||
doc/api/crypto.md
Outdated
| @@ -1599,6 +1682,8 @@ time is right after boot, when the whole system is still low on entropy. | |||
| <!-- YAML | |||
| added: v0.11.11 | |||
| --> | |||
| - `engine` {string} | |||
| - `flags` {constant} Defaults to `crypto.constants.ENGINE_METHOD_ALL`. | |||
There was a problem hiding this comment.
This is {number}... or {crypto.constants} would be a bit clearer.
ameliavoncat
force-pushed
the
argument-types-for-crypto
branch
2 times, most recently
from
b22c732 to
0fbbc74
Compare
joyeecheung
reviewed
Mar 14, 2017
doc/api/crypto.md
Outdated
| @@ -189,15 +186,15 @@ once will result in an error being thrown. | |||
| <!-- YAML | |||
| added: v1.0.0 | |||
| --> | |||
| - `buffer` {Buffer} | |||
| - Returns {this} for method chaining. | |||
There was a problem hiding this comment.
I think the common format in docs is:
Returns: {Cipher}
ameliavoncat
force-pushed
the
argument-types-for-crypto
branch
from
0fbbc74 to
92d6668
Compare
|
Landed in 73e2d0b. Thank you! |
4 tasks
jungx098
pushed a commit
to jungx098/node
that referenced
this pull request
Mar 21, 2017
Refs: nodejs#9399 PR-URL: nodejs#11799 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
|
This PR need backport to v7 |
3 tasks
|
Should this be backported to |
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.
Checklist
Affected core subsystem(s)
documentation.
Description of changes
Adds argument data types to the docs for
cryptomethods.