ayepromise

Aye, promise!

ayepromise is a teeny-tiny promise library. It used to promise to pass the Promises/A+ Compliance Test Suite 1.0, but with new changes to the spec, this might only become true for 1.1 eventually in the future.

Aye tries to be fully compatible with kriskowal's Q in such a way that you can always replace aye with Q. It will not however try to implement anything close to the full feature set. Check test/CompatibilitySpecRunner.html to see ayepromise's test suite executed against Q.

Why?

Allow an asyncronous function to return a promise

aPromiseReturningFunction()
    .then(someOtherAsyncStuff)
    .then(somethingOnTopOfAllThat)
    .then(function (result) {

    })
    .fail(function (error) {

    });

omitting the "pyramid of doom".

Make an existing "old-school" function promise aware:

var myPromisingXhr = function (url) {
    var defer = aye.defer();
    ...
    xhr.onload = function (content) {
        defer.resolve(content);
    };
    xhr.onerror = function (e) {
        defer.reject(e);
    };
    xhr.send();
    return defer.promise;
};

Run the test suite

For the browser, first install dependencies via npm install and bower install and then open test/SpecRunner.html.

For NodeJS install dependencies via npm install and run npm test. This includes the Promise/A+ Compliance Test Suite.