From 2c00b9a73da0f7d3caac388669c67ebf1df2ff27 Mon Sep 17 00:00:00 2001 From: Victor Belozyorov Date: Sun, 24 Jun 2018 09:30:52 +0200 Subject: [PATCH 1/3] Update for crypto.md crypto.randomFillSync - update for JS example crypto.scrypt, crypto.scryptSync - update for options description --- doc/api/crypto.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 66b50f70699ccd..20abc67782b774 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -2065,10 +2065,10 @@ const a = new Uint32Array(10); console.log(crypto.randomFillSync(a).toString('hex')); const b = new Float64Array(10); -console.log(crypto.randomFillSync(a).toString('hex')); +console.log(crypto.randomFillSync(b).toString('hex')); const c = new DataView(new ArrayBuffer(10)); -console.log(crypto.randomFillSync(a).toString('hex')); +console.log(crypto.randomFillSync(c).toString('hex')); ``` ### crypto.randomFill(buffer[, offset][, size], callback) @@ -2149,12 +2149,10 @@ added: v10.5.0 - `salt` {string|Buffer|TypedArray} - `keylen` {number} - `options` {Object} - - `N` {number} CPU/memory cost parameter. Must be a power of two greater - than one. **Default:** `16384`. + - `N` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`. - `r` {number} Block size parameter. **Default:** `8`. - `p` {number} Parallelization parameter. **Default:** `1`. - - `maxmem` {number} Memory upper bound. It is an error when (approximately) - `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`. + - `maxmem` {number} Memory upper bound. It is an error when (approximately) `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`. - `callback` {Function} - `err` {Error} - `derivedKey` {Buffer} @@ -2195,12 +2193,10 @@ added: v10.5.0 - `salt` {string|Buffer|TypedArray} - `keylen` {number} - `options` {Object} - - `N` {number} CPU/memory cost parameter. Must be a power of two greater - than one. **Default:** `16384`. + - `N` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`. - `r` {number} Block size parameter. **Default:** `8`. - `p` {number} Parallelization parameter. **Default:** `1`. - - `maxmem` {number} Memory upper bound. It is an error when (approximately) - `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`. + - `maxmem` {number} Memory upper bound. It is an error when (approximately) `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`. - Returns: {Buffer} Provides a synchronous [scrypt][] implementation. Scrypt is a password-based From 8c0c10237dc7bc187465be28a8aa721748a3eb12 Mon Sep 17 00:00:00 2001 From: Victor Belozyorov Date: Tue, 26 Jun 2018 16:22:18 +0200 Subject: [PATCH 2/3] Update crypto.md crypto.scrypt, crypto.scryptSync - update for formatting --- doc/api/crypto.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 20abc67782b774..fca4d868de4eb4 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -2149,10 +2149,12 @@ added: v10.5.0 - `salt` {string|Buffer|TypedArray} - `keylen` {number} - `options` {Object} - - `N` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`. + - `N` {number} CPU/memory cost parameter. Must be a power of two greater + than one. **Default:** `16384`. - `r` {number} Block size parameter. **Default:** `8`. - `p` {number} Parallelization parameter. **Default:** `1`. - - `maxmem` {number} Memory upper bound. It is an error when (approximately) `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`. + - `maxmem` {number} Memory upper bound. It is an error when (approximately) + `128 * N * r > maxmem` **Default:** `32 * 1024 * 1024`. - `callback` {Function} - `err` {Error} - `derivedKey` {Buffer} @@ -2193,10 +2195,12 @@ added: v10.5.0 - `salt` {string|Buffer|TypedArray} - `keylen` {number} - `options` {Object} - - `N` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`. + - `N` {number} CPU/memory cost parameter. Must be a power of two greater + than one. **Default:** `16384`. - `r` {number} Block size parameter. **Default:** `8`. - `p` {number} Parallelization parameter. **Default:** `1`. - - `maxmem` {number} Memory upper bound. It is an error when (approximately) `128*N*r > maxmem` **Default:** `32 * 1024 * 1024`. + - `maxmem` {number} Memory upper bound. It is an error when (approximately) + `128 * N * r > maxmem` **Default:** `32 * 1024 * 1024`. - Returns: {Buffer} Provides a synchronous [scrypt][] implementation. Scrypt is a password-based From ad420c85c51d251778f1efbde8e438f30c9d0abe Mon Sep 17 00:00:00 2001 From: Victor Belozyorov Date: Tue, 26 Jun 2018 19:47:38 +0200 Subject: [PATCH 3/3] Update crypto.md crypto.scrypt, crypto.scryptSync - added dot symbol --- doc/api/crypto.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index fca4d868de4eb4..6bb52c0a11dd9d 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -2154,7 +2154,7 @@ added: v10.5.0 - `r` {number} Block size parameter. **Default:** `8`. - `p` {number} Parallelization parameter. **Default:** `1`. - `maxmem` {number} Memory upper bound. It is an error when (approximately) - `128 * N * r > maxmem` **Default:** `32 * 1024 * 1024`. + `128 * N * r > maxmem`. **Default:** `32 * 1024 * 1024`. - `callback` {Function} - `err` {Error} - `derivedKey` {Buffer} @@ -2200,7 +2200,7 @@ added: v10.5.0 - `r` {number} Block size parameter. **Default:** `8`. - `p` {number} Parallelization parameter. **Default:** `1`. - `maxmem` {number} Memory upper bound. It is an error when (approximately) - `128 * N * r > maxmem` **Default:** `32 * 1024 * 1024`. + `128 * N * r > maxmem`. **Default:** `32 * 1024 * 1024`. - Returns: {Buffer} Provides a synchronous [scrypt][] implementation. Scrypt is a password-based