run-async - npm Package Compare versions

Comparing version 0.1.0 to 1.0.0

index.js

 'use strict';
 
 var once = require('once');
+var isPromise = require('is-promise');
 
@@ -15,12 +16,22 @@ /**
   var async = false;
-  var answer = func.apply({
-    async: function () {
-      async = true;
-      return once(cb);
+  cb = once(cb);
+
+  try {
+    var answer = func.apply({
+      async: function () {
+        async = true;
+        return cb;
+      }
+    }, Array.prototype.slice.call(arguments, 2) );
+
+    if (!async) {
+      if (isPromise(answer)) {
+        answer.then(cb.bind(null, null), cb);
+      } else {
+        setImmediate(cb.bind(null, null, answer));
+      }
     }
-  }, Array.prototype.slice.call(arguments, 2) );
-
-  if (!async) {
-    cb(answer);
+  } catch (e) {
+    setImmediate(cb.bind(null, e));
   }
 };

package.json

 {
   "name": "run-async",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Utility method to run function either synchronously or asynchronously using the common `this.async()` style.",
@@ -25,7 +25,9 @@ "main": "index.js",
   "dependencies": {
+    "is-promise": "^2.1.0",
     "once": "^1.3.0"
   },
   "devDependencies": {
+    "bluebird": "^2.10.2",
     "mocha": "^1.21.4"
   }
 }

README.md

@@ -6,3 +6,3 @@ Run Async
 
-Utility method to run function either synchronously or asynchronously using the common `this.async()` style.
+Utility method to run function either synchronously or asynchronously using the common `this.async()` style. Also provides for promise returning functions.
 
@@ -29,7 +29,7 @@ This is useful for library author accepting sync or async functions as parameter. `runAsync` will always run them as async method, and normalize the function handling.
   setTimeout(function () {
-    done('running: ' + a);
+    done(null, 'running: ' + a);
   }, 10);
 };
 
-runAsync(asyncFn, function (answer) {
+runAsync(asyncFn, function (err, answer) {
   console.log(answer); // 'running: async'
@@ -43,5 +43,15 @@ }, 'async');
 
-runAsync(asyncFn, function (answer) {
+runAsync(syncFn, function (err, answer) {
   console.log(answer); // 'running: sync'
 }, 'sync');
+
+var promiseFunc = function(a) {
+  return new Promise(function (resolve, reject) {
+    resolve('running: ' + a);
+  });
+}
+
+runAsync(promiseFunc, function (err, answer) {
+  console.log(answer); // 'running: promise'
+}, 'promise');
 ```
@@ -48,0 +58,0 @@

test.js

@@ -5,12 +5,17 @@ 'use strict';
 var runAsync = require('./index');
+var Promise = require('bluebird');
 
 describe('runAsync', function () {
   it('run synchronous method', function (done) {
+    var ranAsync = false;
     var aFunc = function () {
       return 'pass1';
     };
-    runAsync(aFunc, function (val) {
+    runAsync(aFunc, function (err, val) {
+      assert.ifError(err);
+      assert(ranAsync);
       assert.equal(val, 'pass1');
       done();
     });
+    ranAsync = true;
   });
@@ -21,6 +26,7 @@
       var returns = this.async();
-      setTimeout(returns.bind(null, 'pass2'), 0);
+      setImmediate(returns.bind(null, null, 'pass2'));
     };
 
-    runAsync(aFunc, function (val) {
+    runAsync(aFunc, function (err, val) {
+      assert.ifError(err);
       assert.equal(val, 'pass2');
@@ -37,3 +43,4 @@ done();
     };
-    runAsync(aFunc, function (val) {
+    runAsync(aFunc, function (err, val) {
+      assert.ifError(err);
       done();
@@ -50,6 +57,51 @@ }, 1, 'bar');
 
-    runAsync(aFunc, function (val) {
+    runAsync(aFunc, function (err, val) {
+      assert.ifError(err);
       done();
     });
   });
+
+  it('handles promises', function (done) {
+    var fn = function () {
+      return new Promise(function (resolve, reject) {
+        setImmediate(function () {
+          resolve('as promised!');
+        });
+      });
+    };
+
+    runAsync(fn, function (err, val) {
+      assert.ifError(err);
+      assert.equal('as promised!', val);
+      done();
+    });
+  });
+
+  it('throwing synchronously passes error to callback', function (done) {
+    var throws = function () {
+      throw new Error('sync error');
+    };
+
+    runAsync(throws, function (err, val) {
+      assert(err);
+      assert.equal(err.message, 'sync error');
+      done();
+    });
+  });
+
+  it('rejecting a promise passes error to callback', function (done) {
+    var rejects = function () {
+      return new Promise(function (resolve, reject) {
+        setImmediate(function () {
+          reject(new Error('broken promise'));
+        });
+      });
+    };
+
+    runAsync(rejects, function (err, val) {
+      assert(err);
+      assert.equal(err.message, 'broken promise');
+      done();
+    });
+  });
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7226

increased by36.88%

Lines of code

121

increased by86.15%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

61

increased by19.61%

Worsened metrics

Dependency count

2

increased by100%

Dev dependency count

2

increased by100%

Dependency changes

• + Addedis-promise@^2.1.0

• + Addedis-promise@2.2.2(transitive)