diff options
| author | Jeremy Huang <jieyanhuang@gmail.com> | 2017-10-16 11:16:58 +0300 |
|---|---|---|
| committer | Michaël Zasso <targos@protonmail.com> | 2017-10-18 09:35:31 +0300 |
| commit | 8a8e5c775b8955849ea18a512ad2edc519fd755f (patch) | |
| tree | 35c35ea9fef892a016823534573fc682e99b6029 /doc | |
| parent | 06bae4b34a429eaf2485bed7ac15b9dfc4eaa4df (diff) | |
doc: add return values in crypto documentation
Clarify return values for crypto.publicEncrypt and similar functions
PR-URL: https://github.com/nodejs/node/pull/16229
Fixes: https://github.com/nodejs/node/issues/12946
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/crypto.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 001b1658462..fb4a667fff0 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1633,6 +1633,7 @@ added: v0.11.14 `crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING`, `RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`. - `buffer` {Buffer | TypedArray | DataView} +- Returns: {Buffer} A new `Buffer` with the decrypted content. Decrypts `buffer` with `privateKey`. @@ -1650,6 +1651,7 @@ added: v1.1.0 `crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING` or `RSA_PKCS1_PADDING`. - `buffer` {Buffer | TypedArray | DataView} +- Returns: {Buffer} A new `Buffer` with the encrypted content. Encrypts `buffer` with `privateKey`. @@ -1667,6 +1669,7 @@ added: v1.1.0 `crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING` or `RSA_PKCS1_PADDING`. - `buffer` {Buffer | TypedArray | DataView} +- Returns: {Buffer} A new `Buffer` with the decrypted content. Decrypts `buffer` with `publicKey`. @@ -1687,6 +1690,7 @@ added: v0.11.14 `crypto.constants`, which may be: `crypto.constants.RSA_NO_PADDING`, `RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`. - `buffer` {Buffer | TypedArray | DataView} +- Returns: {Buffer} A new `Buffer` with the encrypted content. Encrypts the content of `buffer` with `publicKey` and returns a new [`Buffer`][] with encrypted content. |