pooch v0.2.0

Pooch

Promise flow control similar to the popular async module.

Installation

Install with npm

$ npm install --save pooch

Usage

Pooch works with all Promises that follow the ES6 Promise spec. To use on external libraries such as bluebird, just call pooch on the Promise object. You will only need to do this once since require caches objects.

With Node v0.11.17, just a simple require("pooch") will give you the functionality with native promises. Otherwise, you can extend an existing library:

var Promise = require("bluebird"),
	Pooch = require("pooch")(Promise);

API

• Promise#thenIgnore( Function handler )
• Promise#thenIf( Function condition, Function handler )
• Promise#thenWhile( Function condition, Function callback )

Documentation

Each of the functions below add to the Promise (or whatever implementation you use with Pooch()) prototype. Each function can also be chained from the root Pooch object (including then). So for example, using thenIf:

Pooch.thenIf(function() { // All it does it return a no-op promise that is always fulfilled.
	return true;
}, function() {
	return anotherPromise();
}).then( ... );

Promise#thenIgnore( Function handler )

Chain a new promise, fulfill it and ignore it's value. It works exactly like Promise#then except the value returned from the original promise is passed on instead of any value return from Promise#thenIf. An example probably illustrates it better.

promiseReturns3().thenIgnore(function(value) {
	console.log(value); // 3
	return promiseReturns4(); // This promise is fullfilled and returns 4
}).then(function(value) {
	// Value is the value fromm promiseReturns3()
	console.log(value); // 3
});

Promise#thenIf( Function condition, Function handler )

Conditional promise execution if a synchronous condition (with the value passed from the previous promise) returns true. The condition callback recieves one parameter, the value from the previously executed promise. The callback is the same callback you would pass to Promise#then.

NOTE: Any value returned from the conditional promise is ignored. If the conditional promise is executed, it just holds up the promise execution chain and waits until it's complete. It has no affect on the ensuing values so any proceeding Promise#then calls receive the value from the promise the Promise#thenIf is attached to effectively skipping the conditional promise. See Promise#thenIgnore.

getUser().thenIf(function(user) {
	return user.age > 18;
}, function(user) {
	return updatePrivacySettings(user);
}).then(function(user) {
	// The user from #getUser
	// Anything returned from updatePrivacySettings promise is ignored.
});

Promise#thenWhile( Function condition, Function callback )

Execute a promise while a condition is true. The condition callback recieves one parameter, the value from the previously executed promise. The callback is the same callback you would pass to Promise#then.

var i = 0;
myPromise().thenWhile(function() {
	return i <= 10;
}, function(value) {
	// `value` is the value from myPromise()
	i++;
    return myOtherPromise();
}).then(function() {
	console.log(i); // 10
});

Testing

Run npm test to run the test suite which is based upon mocha.

License

Created by Adrian Cooney. Licensed under the MIT License.