suspend - npm Package Compare versions

Comparing version 0.5.1 to 0.6.0

lib/suspend.js

@@ -0,1 +1,3 @@
+var Promise = require('../node_modules/promise/lib/es6-extensions');
+
 /**
@@ -45,2 +47,23 @@ * Our suspend namespace, which doubles as an alias for `suspend.fn` (although
 /**
+ * Accepts a generator, and returns a new function that returns a promise.
+ */
+ suspend.promise = function promise(generator) {
+	if (!isGeneratorFunction(generator)) {
+		throw new Error('First .promise() argument must be a GeneratorFunction.');
+	}
+
+	return function() {
+		var self = this,
+			args = Array.prototype.slice.call(arguments);
+
+		return new Promise(function(resolve, reject) {
+			var suspender = new Suspender(generator, function(err, ret) {
+				err ? reject(err) : resolve(ret);
+			});
+			suspender.start(self, args);
+		});
+	};
+};
+
+/**
  * Accepts a generator and an optional callback.  The generator is invoked
@@ -47,0 +70,0 @@ * immediately - any errors or returned values are passed to the callback.

package.json

@@ -6,3 +6,3 @@ {
 	"keywords": ["async", "generator", "yield", "callback", "promise", "flow", "control", "suspend"],
-	"version": "0.5.1",
+	"version": "0.6.0",
 	"repository": {
@@ -17,8 +17,10 @@ "type": "git",
 	},
+	"dependencies": {
+		"promise": "^6.0.0"
+	},
 	"devDependencies": {
-		"mocha": "~1.15.1",
-		"q": "~0.9.7",
-		"regenerator": "~0.3.1",
-		"grunt": "~0.4.2",
-		"grunt-contrib-jshint": "~0.7.2"
+		"mocha": "^1.21.4",
+		"regenerator": "^0.6.3",
+		"grunt": "^0.4.5",
+		"grunt-contrib-jshint": "^0.10.0"
 	},
@@ -25,0 +27,0 @@ "engines": {

README.md

@@ -62,4 +62,6 @@ # suspend
     * [suspend.async(fn*)](#suspendasyncfn)
+    * [suspend.promise(fn*)](#suspendpromisefn)
     * [suspend.fn(fn*)](#suspendfnfn)
     * [suspend.run(fn*)](#suspendrunfn-cb)
+    * [suspend(fn*)](#suspendfn)
 * **[Suspending and Resuming Execution](#suspending-and-resuming-execution)**
@@ -100,2 +102,22 @@ * [yield](#yield)
 
+### `suspend.promise(fn*)`
+
+Accepts a generator function `fn*`, and returns a wrapper function that returns a Promise.  If a value is returned (or the generator function completes with no explicit return value), the promise is resolved.  If an error is thrown, then the promise is rejected.
+
+**Example:**
+
+```javascript
+var getFavoriteNumberByUsername = suspend.promise(function*(username) {
+    var user = yield UserModel.find({ username: username });
+    return user.favoriteColor;
+});
+
+// the resulting function exposes a promise API:
+var promise = getFavoriteNumberByUsername('jmar777');
+```
+
+Note that the above example also demonstrates the ability to yield promises, which is [documented below](#promises).
+
+---
+
 ### `suspend.fn(fn*)`
@@ -137,2 +159,6 @@
 
+### `suspend(fn*)`
+
+An alias for [`suspend.fn(fn*)`](#suspendfnfn).
+
 ## Suspending and Resuming Execution
@@ -139,0 +165,0 @@

test/yielding-promises.js

 var assert = require('assert'),
 	suspend = require('../'),
 	run = suspend.run,
-	Q = require('q');
+	Promise = require('../node_modules/promise/lib/es6-extensions');
 
@@ -58,15 +58,15 @@ describe('yielded promises', function() {
 function asyncDouble(num) {
-	var deferred = Q.defer();
-	setTimeout(function() { deferred.resolve(num * 2); }, 20);
-	return deferred.promise;
+	return new Promise(function(resolve, reject) {
+		setTimeout(resolve.bind(null, num * 2), 20);
+	});
 }
 function slowAsyncDouble(num) {
-	var deferred = Q.defer();
-	setTimeout(function() { deferred.resolve(num * 2); }, 40);
-	return deferred.promise;
+	return new Promise(function(resolve, reject) {
+		setTimeout(resolve.bind(null, num * 2), 40);
+	});
 }
 function asyncError() {
-	var deferred = Q.defer();
-	setTimeout(function() { deferred.reject(new Error('oops')); }, 20);
-	return deferred.promise;
+	return new Promise(function(resolve, reject) {
+		setTimeout(reject.bind(null, new Error('oops')), 20);
+	});
 }

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

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

4

decreased by-20%

Number of lines in readme file

378

increased by7.39%

Number of low supply chain risk alerts

1

decreased by-85.71%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

50144

decreased by-6.09%

Dependency count

1

increased byInfinity%

Number of package files

15

decreased by-16.67%

Lines of code

1143

decreased by-8.41%

Dependency changes

• + Addedpromise@^6.0.0

• + Addedasap@1.0.0(transitive)

• + Addedpromise@6.1.0(transitive)