diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 68a905ae1d8fab..d4af17c9988ff8 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1637,7 +1637,7 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`. -- `private_key` {Object | string} +- `public_key` {Object | string} - `key` {string} A PEM encoded private key. - `passphrase` {string} An optional passphrase for the private key. - `padding` {crypto.constants} An optional padding value defined in @@ -1657,7 +1657,7 @@ be passed instead of a public key. -- `private_key` {Object | string} +- `public_key` {Object | string} - `key` {string} A PEM encoded private key. - `passphrase` {string} An optional passphrase for the private key. - `padding` {crypto.constants} An optional padding value defined in @@ -1665,7 +1665,8 @@ added: v0.11.14 `RSA_PKCS1_PADDING`, or `crypto.constants.RSA_PKCS1_OAEP_PADDING`. - `buffer` {Buffer | TypedArray | DataView} -Encrypts `buffer` with `public_key`. +Encrypts the content of `buffer` with `public_key` and returns a new +[`Buffer`][] with encrypted content. `public_key` can be an object or a string. If `public_key` is a string, it is treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.