lib,doc: remove unused parameter, improve docs
1) Remove 'callback' in 'check' function, because we don't check or use that directly. 2) Make 'digest' clearer in the documentation. PR-URL: https://github.com/nodejs/node/pull/22858 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit is contained in:
Родитель
566075967d
Коммит
25220f0ce1
|
@ -1808,6 +1808,9 @@ otherwise `err` will be `null`. By default, the successfully generated
|
|||
`derivedKey` will be passed to the callback as a [`Buffer`][]. An error will be
|
||||
thrown if any of the input arguments specify invalid values or types.
|
||||
|
||||
If `digest` is `null`, `'sha1'` will be used. This behavior will be deprecated
|
||||
in a future version of Node.js.
|
||||
|
||||
The `iterations` argument must be a number set as high as possible. The
|
||||
higher the number of iterations, the more secure the derived key will be,
|
||||
but will take a longer amount of time to complete.
|
||||
|
@ -1871,6 +1874,9 @@ applied to derive a key of the requested byte length (`keylen`) from the
|
|||
If an error occurs an `Error` will be thrown, otherwise the derived key will be
|
||||
returned as a [`Buffer`][].
|
||||
|
||||
If `digest` is `null`, `'sha1'` will be used. This behavior will be deprecated
|
||||
in a future version of Node.js.
|
||||
|
||||
The `iterations` argument must be a number set as high as possible. The
|
||||
higher the number of iterations, the more secure the derived key will be,
|
||||
but will take a longer amount of time to complete.
|
||||
|
|
|
@ -22,7 +22,7 @@ function pbkdf2(password, salt, iterations, keylen, digest, callback) {
|
|||
}
|
||||
|
||||
({ password, salt, iterations, keylen, digest } =
|
||||
check(password, salt, iterations, keylen, digest, callback));
|
||||
check(password, salt, iterations, keylen, digest));
|
||||
|
||||
if (typeof callback !== 'function')
|
||||
throw new ERR_INVALID_CALLBACK();
|
||||
|
@ -42,7 +42,7 @@ function pbkdf2(password, salt, iterations, keylen, digest, callback) {
|
|||
|
||||
function pbkdf2Sync(password, salt, iterations, keylen, digest) {
|
||||
({ password, salt, iterations, keylen, digest } =
|
||||
check(password, salt, iterations, keylen, digest, pbkdf2Sync));
|
||||
check(password, salt, iterations, keylen, digest));
|
||||
const keybuf = Buffer.alloc(keylen);
|
||||
handleError(keybuf, password, salt, iterations, digest);
|
||||
const encoding = getDefaultEncoding();
|
||||
|
@ -50,7 +50,7 @@ function pbkdf2Sync(password, salt, iterations, keylen, digest) {
|
|||
return keybuf.toString(encoding);
|
||||
}
|
||||
|
||||
function check(password, salt, iterations, keylen, digest, callback) {
|
||||
function check(password, salt, iterations, keylen, digest) {
|
||||
if (typeof digest !== 'string') {
|
||||
if (digest !== null)
|
||||
throw new ERR_INVALID_ARG_TYPE('digest', ['string', 'null'], digest);
|
||||
|
|
Загрузка…
Ссылка в новой задаче