FutureJS

An easy to use JavaScript library for returning futures/promises without any dependencies and with full browser support. It also supports future grouping providing automatic wait-for-completion and evaluation of all grouped Futures. There are a lot of libraries out there as well, like jQuery's promises, also, native promises support is on it's way. I started this library a long time ago by taking a whole different approach to the same problem and still find it simple, powerful and useful enough.

FutureGroups will resolve to:

• success: if every future is success.
• error: if any future is an error.
• cancel: if any future is a cancel and there are no errors.

Take a look at demo_future.html & demo_futuregroup.html for all working examples and advanced usage. Do not forget to open the dev tools to see the output ;)

Interactive demos

https://rawgit.com/rmruano/FutureJS/master/demo_futuregroup.html https://rawgit.com/rmruano/FutureJS/master/demo_future.html

Returning a Future

Instead of accepting callbacks, your async function just return a Future object and triggers the result when completed.

function myAsyncFunction() {
    var future = new Future();
    future.enableDebug(); // This will send debug messages to the dev console
    setTimeout(function() {future.success("My payload");}, 1000); // Asynchronous success simulation
    // setTimeout(function() {future.cancel();}, 1000); // Asynchronous cancel simulation
    // setTimeout(function() {future.error(new Error("Something went wrong!");}, 1000); // Asynchronous error simulation
    return future;
};

Future EventListeners Sample

<script src="future.js"></script>
<input type="button" id="test1" value="TEST 1"/>
<input type="button" id="test2" value="TEST 2"/>
<script>
document.getElementById("test1").addEventListener("click", function() {
    var future = myAsyncFunction(); // It will return a Future object that will trigger the listeners when completed
    future.onSuccess(function(future, payload) {
        alert("SuccessListener triggered: "+payload);
    });
    future.onError(function(future, error) {
        alert("ErrorListener triggered: "+error.message);
    });
    future.onCancel(function(future) {
        alert("CancelListener triggered");
    });
    future.onComplete(function(future) {
        alert("CompleteListener triggered (on any result)");
    });
});
// You can use it also as a fluent interface
document.getElementById("test2").addEventListener("click", function() {
    myAsyncFunction().onSuccess(function(future, payload) {
        alert("SuccessListener triggered: "+payload);
    }).onError(function(future, error) {
        alert("ErrorListener triggered: "+error.message);
    }).onCancel(function(future) {
        alert("CancelListener triggered");
    }).onComplete(function(future) {
        alert("CompleteListener triggered (on any result)");
    });
});
</script>

Returning FutureGroups

When multiple asynchronous operations must be performed, your async function can return a FutureGroup and add Future objects returned by other asynchronous functions, the FutureGroup will automatically wait for all futures to be completed and will also resolve automatically the result that must be triggered. You can also easily add synchronous closures as well.

function myComplexAsyncFunction() {
    var futureGroup = new FutureGroup()
        .enableDebug() // This will send debug messages to the dev console
        .add(myAsyncFunction1())
        .add(myAsyncFunction2())
        .add(myAsyncFunction3())
        .add(function(){/* My super awesome synchronous closure that returns TRUE for ok or FALSE for ko */});
    return futureGroup;
};

FutureGroup EventListeners Sample

<script src="future.js"></script>
<input type="button" id="test1" value="TEST"/>
<script>
document.getElementById("test1").addEventListener("click", function() {
    var futureGroup = myComplexAsyncFunction(); // It will return a FutureGroup object that will trigger the listeners when completed
    futureGroup.onSuccess(function(futureGroup) {
        alert("SuccessListener triggered");
    });
    futureGroup.onError(function(futureGroup, lastError, errorsList) {
        alert("ErrorListener triggered: "+lastError.message);
        // errorList contains a Error[]
    });
    futureGroup.onCancel(function(futureGroup) {
        alert("CancelListener triggered");
    });
    futureGroup.onComplete(function(futureGroup) {
        alert("CompleteListener triggered");
    });
});
</script>