Document progressCallback

Author: dcodeIO

README.md

@@ -156,14 +156,15 @@ Synchronously generates a hash for the given string.
 |   |||
 | **returns** | ?string | Resulting hash, actually never null
 
-### bcrypt.hash(s, salt, callback)
+### bcrypt.hash(s, salt, callback, progressCallback=)
 Asynchronously generates a hash for the given string.
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | s | string | String to hash |
 | salt | number ¦ string | Salt length to generate or salt to use |
 | callback | function(Error, ?string) | Callback receiving the error, if any, and the resulting hash |
+| progressCallback | function(number) | Callback successively called with the percentage of rounds completed (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
 
 ### bcrypt.compareSync(s, hash)
 Synchronously tests a string against a hash.
@@ -176,14 +177,15 @@ Synchronously tests a string against a hash.
 | **returns** | boolean | true if matching, otherwise false
 | **throws** | Error | If an argument is illegal
 
-### bcrypt.compare(s, hash, callback)
+### bcrypt.compare(s, hash, callback, progressCallback=)
 Asynchronously compares the given data against the given hash.
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | s | string | Data to compare |
 | hash | string | Data to be compared to |
 | callback | function(Error, boolean) | Callback receiving the error, if any, otherwise the result |
+| progressCallback | function(number) | Callback successively called with the percentage of rounds completed (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
 |   |||
 | **throws** | Error | If the callback argument is invalid
 

dist/bcrypt.js

@@ -812,7 +812,7 @@
         // Validate the salt
         var minor, offset;
         if (salt.charAt(0) !== '$' || salt.charAt(1) !== '2') {
-            err = new Error("Invalid salt version: "+salt.substring(0,2));
+            err = Error("Invalid salt version: "+salt.substring(0,2));
             if (callback) {
                 _nextTick(callback.bind(this, err));
                 return;
@@ -1014,7 +1014,8 @@
      * @param {string} s String to hash
      * @param {number|string} salt Salt length to generate or salt to use
      * @param {function(Error, string=)} callback Callback receiving the error, if any, and the resulting hash
-     * @param {function(number)=} progressCallback Callback called with the current progress
+     * @param {function(number)=} progressCallback Callback successively called with the percentage of rounds completed
+     *  (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
      * @expose
      */
     bcrypt.hash = function(s, salt, callback, progressCallback) {
@@ -1059,15 +1060,16 @@
      * @param {string} s Data to compare
      * @param {string} hash Data to be compared to
      * @param {function(Error, boolean)} callback Callback receiving the error, if any, otherwise the result
-     * @param {function(number)=} progressCallback Callback called with the current progress
+     * @param {function(number)=} progressCallback Callback successively called with the percentage of rounds completed
+     *  (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
      * @throws {Error} If the callback argument is invalid
      * @expose
      */
     bcrypt.compare = function(s, hash, callback, progressCallback) {
         if (typeof callback !== 'function')
-            throw(new Error("Illegal callback: "+callback));
+            throw Error("Illegal callback: "+callback);
         if (typeof s !== "string" || typeof hash !== "string") {
-            _nextTick(callback.bind(this, new Error("Illegal argument types: "+(typeof s)+', '+(typeof hash))));
+            _nextTick(callback.bind(this, Error("Illegal argument types: "+(typeof s)+', '+(typeof hash))));
             return;
         }
         bcrypt.hash(s, hash.substr(0, 29), function(err, comp) {

src/bcrypt.js

@@ -565,7 +565,7 @@
         // Validate the salt
         var minor, offset;
         if (salt.charAt(0) !== '$' || salt.charAt(1) !== '2') {
-            err = new Error("Invalid salt version: "+salt.substring(0,2));
+            err = Error("Invalid salt version: "+salt.substring(0,2));
             if (callback) {
                 _nextTick(callback.bind(this, err));
                 return;
@@ -767,7 +767,8 @@
      * @param {string} s String to hash
      * @param {number|string} salt Salt length to generate or salt to use
      * @param {function(Error, string=)} callback Callback receiving the error, if any, and the resulting hash
-     * @param {function(number)=} progressCallback Callback called with the current progress
+     * @param {function(number)=} progressCallback Callback successively called with the percentage of rounds completed
+     *  (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
      * @expose
      */
     bcrypt.hash = function(s, salt, callback, progressCallback) {
@@ -812,15 +813,16 @@
      * @param {string} s Data to compare
      * @param {string} hash Data to be compared to
      * @param {function(Error, boolean)} callback Callback receiving the error, if any, otherwise the result
-     * @param {function(number)=} progressCallback Callback called with the current progress
+     * @param {function(number)=} progressCallback Callback successively called with the percentage of rounds completed
+     *  (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
      * @throws {Error} If the callback argument is invalid
      * @expose
      */
     bcrypt.compare = function(s, hash, callback, progressCallback) {
         if (typeof callback !== 'function')
-            throw(new Error("Illegal callback: "+callback));
+            throw Error("Illegal callback: "+callback);
         if (typeof s !== "string" || typeof hash !== "string") {
-            _nextTick(callback.bind(this, new Error("Illegal argument types: "+(typeof s)+', '+(typeof hash))));
+            _nextTick(callback.bind(this, Error("Illegal argument types: "+(typeof s)+', '+(typeof hash))));
             return;
         }
         bcrypt.hash(s, hash.substr(0, 29), function(err, comp) {