#5 - add to resolved value of the checkFn to the resolve of the busyw… (#6)

* #5 - add to resolved value of the checkFn to the resolve of the busywait promise

* #5 - add to resolved value of the checkFn to the resolve of the busywait promise

* #5 - add to resolved value of the checkFn to the resolve of the busywait promise

Author: regevbr

.jshintrc

@@ -50,5 +50,8 @@
   "validthis": false,
   "mocha": true,
   "node": true,
-  "nonstandard": false
+  "nonstandard": false,
+  "predef":[
+    "toString"
+  ]
 }

README.md

@@ -27,7 +27,7 @@ npm install --save busywait
 
 Running:
 ```js
-const busywait = require('busywait').sync;
+const busywait = require('../lib/index').sync;
 
 const waitUntil = Date.now() + 2500;
 
@@ -40,21 +40,22 @@ busywait(syncCheck, {
     sleepTime: 500,
     maxChecks: 20
 })
-    .then(function (iterations) {
-        console.log('finished after', iterations, 'iterations');
+    .then(function (result) {
+        console.log('finished after', result.iterations, 'iterations', 'with' +
+            ' result', result.result);
     });
 ```
 or:
 ```js
-const busywait = require('busywait').async;
+const busywait = require('../lib/index').async;
 
 const waitUntil = Date.now() + 2500;
 
 function asyncCheck(iteration) {
     return new Promise(function (resolve, reject) {
         console.log('running iteration', iteration);
         if (Date.now() > waitUntil) {
-            return resolve();
+            return resolve(true);
         } else {
             return reject();
         }
@@ -65,8 +66,9 @@ busywait(asyncCheck, {
     sleepTime: 500,
     maxChecks: 20
 })
-    .then(function (iterations) {
-        console.log('finished after', iterations, 'iterations');
+    .then(function (result) {
+        console.log('finished after', result.iterations, 'iterations', 'with' +
+            ' result', result.result);
     });
 ```
 Will result in:
@@ -77,7 +79,7 @@ running iteration 3
 running iteration 4
 running iteration 5
 running iteration 6
-finished after 6 iterations
+finished after 6 iterations with result true
 ```
 
 ## Methods
@@ -103,8 +105,14 @@ The current iteration number will be passed as first argument to every call of `
 #### Return value
 
 Return value is a promise.
-The promise will be resolved with the number of iterations passed if the `syncCheckFn` returned true within a legal number of checks.
-The promise will be rejected if the `syncCheckFn` rejected `maxChecks` times.
+- The promise will be resolved if the `syncCheckFn` returned true within a
+legal number of checks.
+- The promise will be rejected if the `syncCheckFn` rejected `maxChecks`
+times.
+
+Promise resolved value:
+- `iterations` - The number of iterations it took to finish
+- `result` - Constant `true`
 
 ### async(asyncCheckFn, options): Promise
 
@@ -127,5 +135,10 @@ The current iteration number will be passed as first argument to every call of `
 #### Return value
 
 Return value is a promise.
-The promise will be resolved with the number of iterations passed if the `asyncCheckFn` was resolved within a legal number of checks.
-The promise will be rejected if the `asyncCheckFn` rejected `maxChecks` times.
+- The promise will be resolved if the `asyncCheckFn` was resolved within a
+legal number of checks.
+- The promise will be rejected if the `asyncCheckFn` rejected `maxChecks` times.
+
+Promise resolved value:
+- `iterations` - The number of iterations it took to finish
+- `result` - The resolved value of `asyncCheckFn`

examples/async.js

@@ -8,7 +8,7 @@ function asyncCheck(iteration) {
     return new Promise(function (resolve, reject) {
         console.log('running iteration', iteration);
         if (Date.now() > waitUntil) {
-            return resolve();
+            return resolve(true);
         } else {
             return reject();
         }
@@ -19,6 +19,7 @@ busywait(asyncCheck, {
     sleepTime: 500,
     maxChecks: 20
 })
-    .then(function (iterations) {
-        console.log('finished after', iterations, 'iterations');
+    .then(function (result) {
+        console.log('finished after', result.iterations, 'iterations', 'with' +
+            ' result', result.result);
     });

examples/sync.js

@@ -13,6 +13,7 @@ busywait(syncCheck, {
     sleepTime: 500,
     maxChecks: 20
 })
-    .then(function (iterations) {
-        console.log('finished after', iterations, 'iterations');
+    .then(function (result) {
+        console.log('finished after', result.iterations, 'iterations', 'with' +
+            ' result', result.result);
     });

lib/index.js

@@ -1,7 +1,5 @@
 "use strict";
 
-const _ = require('underscore');
-
 module.exports = {
     sync: sync,
     async: async
@@ -33,7 +31,7 @@ function _checkArgs(checkFn, options) {
     if (isNaN(options.sleepTime) || options.sleepTime < 1) {
         return Promise.reject("sleepTime must be a valid integer greater than 0");
     }
-    if (!checkFn || !_.isFunction(checkFn)) {
+    if (!checkFn || !_isFunction(checkFn)) {
         return Promise.reject("checkFn must be a function");
     }
     return Promise.resolve();
@@ -43,7 +41,7 @@ function _wrapSyncMethod(checkFn) {
     return function (iteration) {
         return new Promise(function (resolve, reject) {
             if (checkFn(iteration)) {
-                return resolve();
+                return resolve(true);
             } else {
                 return reject();
             }
@@ -57,8 +55,11 @@ function _eventLoop(asyncCheckFn, options) {
         const iterationCheck = function () {
             iteration++;
             asyncCheckFn(iteration)
-                .then(function checkSuccess() {
-                    return resolve(iteration);
+                .then(function checkSuccess(result) {
+                    return resolve({
+                        iterations: iteration,
+                        result: result
+                    });
                 })
                 .catch(function checkFailed() {
                     if (iteration === options.maxChecks) {
@@ -70,3 +71,7 @@ function _eventLoop(asyncCheckFn, options) {
         setTimeout(iterationCheck, options.waitFirst ? options.sleepTime : 0);
     });
 }
+
+function _isFunction(obj) {
+    return toString.call(obj) === '[object Function]';
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "busywait",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Async busy wait",
   "main": "./lib/index.js",
   "scripts": {
@@ -25,7 +25,6 @@
   },
   "homepage": "https://github.com/regevbr/busywait.js#readme",
   "dependencies": {
-    "underscore": "^1.8.3"
   },
   "devDependencies": {
     "coveralls": "^3.0.0",

test/test.js

@@ -21,7 +21,7 @@ describe('busywait.js', function () {
     function asyncCheck() {
         return new Promise(function (resolve, reject) {
             if (Date.now() > waitUntil) {
-                return resolve();
+                return resolve(true);
             } else {
                 return reject();
             }
@@ -38,8 +38,9 @@ describe('busywait.js', function () {
             sleepTime: 500,
             maxChecks: 20
         })
-            .then(function (iterations) {
-                expect(iterations).to.be(6);
+            .then(function (result) {
+                expect(result.iterations).to.be(6);
+                expect(result.result).to.be(true);
             });
     });
 
@@ -49,8 +50,9 @@ describe('busywait.js', function () {
             maxChecks: 20,
             waitFirst: true
         })
-            .then(function (iterations) {
-                expect(iterations).to.be(5);
+            .then(function (result) {
+                expect(result.iterations).to.be(5);
+                expect(result.result).to.be(true);
             });
     });