From 1316c77b7911ab65cd484a077a4e4fe94a132bb3 Mon Sep 17 00:00:00 2001 From: "Sakthipriyan Vairamani (thefourtheye)" Date: Thu, 20 Apr 2017 20:28:42 +0530 Subject: [PATCH] doc: improve randomfill and fix broken link This patch replaces the word `buf` with `buffer` and fixes the broken link to `randomfill`. PR-URL: https://github.com/nodejs/node/pull/12541 Reviewed-By: Evan Lucas Reviewed-By: James M Snell Reviewed-By: Colin Ihrig Reviewed-By: Vse Mozhet Byt Reviewed-By: Luigi Pinca --- doc/api/crypto.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 6bf5e187b628b8..e685e15832f220 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1584,18 +1584,18 @@ This should normally never take longer than a few milliseconds. The only time when generating the random bytes may conceivably block for a longer period of time is right after boot, when the whole system is still low on entropy. -### crypto.randomFillSync(buf[, offset][, size]) +### crypto.randomFillSync(buffer[, offset][, size]) -* `buf` {Buffer|Uint8Array} Must be supplied. +* `buffer` {Buffer|Uint8Array} Must be supplied. * `offset` {number} Defaults to `0`. -* `size` {number} Defaults to `buf.length - offset`. +* `size` {number} Defaults to `buffer.length - offset`. Synchronous version of [`crypto.randomFill()`][]. -Returns `buf` +Returns `buffer` ```js const buf = Buffer.alloc(10); @@ -1609,14 +1609,14 @@ crypto.randomFillSync(buf, 5, 5); console.log(buf.toString('hex')); ``` -### crypto.randomFill(buf[, offset][, size], callback) +### crypto.randomFill(buffer[, offset][, size], callback) -* `buf` {Buffer|Uint8Array} Must be supplied. +* `buffer` {Buffer|Uint8Array} Must be supplied. * `offset` {number} Defaults to `0`. -* `size` {number} Defaults to `buf.length - offset`. +* `size` {number} Defaults to `buffer.length - offset`. * `callback` {Function} `function(err, buf) {}`. This function is similar to [`crypto.randomBytes()`][] but requires the first @@ -2064,7 +2064,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL. [`crypto.getHashes()`]: #crypto_crypto_gethashes [`crypto.pbkdf2()`]: #crypto_crypto_pbkdf2_password_salt_iterations_keylen_digest_callback [`crypto.randomBytes()`]: #crypto_crypto_randombytes_size_callback -[`crypto.randomFill()`]: #crypto_crypto_randombytesbuffer_buf_size_offset_cb +[`crypto.randomFill()`]: #crypto_crypto_randomfill_buffer_offset_size_callback [`decipher.final()`]: #crypto_decipher_final_output_encoding [`decipher.update()`]: #crypto_decipher_update_data_input_encoding_output_encoding [`diffieHellman.setPublicKey()`]: #crypto_diffiehellman_setpublickey_public_key_encoding