summaryrefslogtreecommitdiff
path: root/doc/api/crypto.md
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-08-26 19:02:27 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-08-29 16:53:03 +0300
commit1a25f9639a9668d8ea90022b0f3d3b47d29971b6 (patch)
treeceba486d64311f7d40be3ad57db6bb217f9213fa /doc/api/crypto.md
parentb2f0cfa6b0e139a2f990d4e1e7104abf015fe8e7 (diff)
downloadandroid-node-v8-1a25f9639a9668d8ea90022b0f3d3b47d29971b6.tar.gz
android-node-v8-1a25f9639a9668d8ea90022b0f3d3b47d29971b6.tar.bz2
android-node-v8-1a25f9639a9668d8ea90022b0f3d3b47d29971b6.zip
doc: remove redundant 'Example:' and similar notes
Some nits were also fixed in passing. PR-URL: https://github.com/nodejs/node/pull/22537 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/crypto.md')
-rw-r--r--doc/api/crypto.md12
1 files changed, 1 insertions, 11 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index f77f4213be..bf643c9c6b 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -1678,8 +1678,6 @@ added: v0.9.3
* Returns: {string[]} An array with the names of the supported cipher
algorithms.
-Example:
-
```js
const ciphers = crypto.getCiphers();
console.log(ciphers); // ['aes-128-cbc', 'aes-128-ccm', ...]
@@ -1691,8 +1689,6 @@ added: v2.3.0
-->
* Returns: {string[]} An array with the names of the supported elliptic curves.
-Example:
-
```js
const curves = crypto.getCurves();
console.log(curves); // ['Oakley-EC2N-3', 'Oakley-EC2N-4', ...]
@@ -1711,7 +1707,7 @@ supported groups are: `'modp1'`, `'modp2'`, `'modp5'` (defined in
`'modp16'`, `'modp17'`, `'modp18'` (defined in [RFC 3526][]). The
returned object mimics the interface of objects created by
[`crypto.createDiffieHellman()`][], but will not allow changing
-the keys (with [`diffieHellman.setPublicKey()`][] for example). The
+the keys (with [`diffieHellman.setPublicKey()`][], for example). The
advantage of using this method is that the parties do not have to
generate nor exchange a group modulus beforehand, saving both processor
and communication time.
@@ -1747,8 +1743,6 @@ added: v0.9.3
* Returns: {string[]} An array of the names of the supported hash algorithms,
such as `'RSA-SHA256'`.
-Example:
-
```js
const hashes = crypto.getHashes();
console.log(hashes); // ['DSA', 'DSA-SHA', 'DSA-SHA1', ...]
@@ -1797,8 +1791,6 @@ but will take a longer amount of time to complete.
The `salt` should be as unique as possible. It is recommended that a salt is
random and at least 16 bytes long. See [NIST SP 800-132][] for details.
-Example:
-
```js
const crypto = require('crypto');
crypto.pbkdf2('secret', 'salt', 100000, 64, 'sha512', (err, derivedKey) => {
@@ -1862,8 +1854,6 @@ but will take a longer amount of time to complete.
The `salt` should be as unique as possible. It is recommended that a salt is
random and at least 16 bytes long. See [NIST SP 800-132][] for details.
-Example:
-
```js
const crypto = require('crypto');
const key = crypto.pbkdf2Sync('secret', 'salt', 100000, 64, 'sha512');