bugcore/lib/promise/Deferred.js

bugcore is a JavaScript library that provides a foundational architecture for object oriented JS

/*
 * Copyright (c) 2016 airbug Inc. http://airbug.com
 *
 * bugcore may be freely distributed under the MIT license.
 */


//-------------------------------------------------------------------------------
// Annotations
//-------------------------------------------------------------------------------

//@Export('Deferred')

//@Require('ArgUtil')
//@Require('Class')
//@Require('Obj')
//@Require('Promise')


//-------------------------------------------------------------------------------
// Context
//-------------------------------------------------------------------------------

require('bugpack').context("*", function(bugpack) {

    //-------------------------------------------------------------------------------
    // BugPack
    //-------------------------------------------------------------------------------

    var ArgUtil     = bugpack.require('ArgUtil');
    var Class       = bugpack.require('Class');
    var Obj         = bugpack.require('Obj');
    var Promise     = bugpack.require('Promise');


    //-------------------------------------------------------------------------------
    // Declare Class
    //-------------------------------------------------------------------------------

    /**
     * @class
     * @extends {Obj}
     */
    var Deferred = Class.extend(Obj, {

        _name: "Deferred",


        //-------------------------------------------------------------------------------
        // Constructor
        //-------------------------------------------------------------------------------

        /**
         * @constructs
         */
        _constructor: function() {

            this._super();


            //-------------------------------------------------------------------------------
            // Private Properties
            //-------------------------------------------------------------------------------

            /**
             * @private
             * @type {Promise}
             */
            this.deferredPromise    = new Promise();
        },


        //-------------------------------------------------------------------------------
        // Getters and Setters
        //-------------------------------------------------------------------------------

        /**
         * @return {Promise}
         */
        getDeferredPromise: function() {
            return this.deferredPromise;
        },


        //-------------------------------------------------------------------------------
        // Public Methods
        //-------------------------------------------------------------------------------

        /**
         * @param {function(Throwable=, *...=)} callback
         * @return {Promise}
         */
        callback: function(callback) {
            return this.deferredPromise.callback(callback);
        },

        /**
         * @param {*...} args
         */
        reject: function() {
            var args = ArgUtil.toArray(arguments);
            this.deferredPromise.reject(args);
        },

        /**
         * @param {*...} args
         */
        resolve: function() {
            var args = ArgUtil.toArray(arguments);
            this.deferredPromise.resolve(args);
        },

        /**
         * @return {Promise}
         */
        promise: function() {
            return this.getDeferredPromise();
        },

        /**
         * @param {function(...):*=} fulfilledFunction
         * @param {function(...):*=} rejectedFunction
         * @return {Promise}
         */
        then: function(fulfilledFunction, rejectedFunction) {
            return this.deferredPromise.then(fulfilledFunction, rejectedFunction);
        }
    });


    //-------------------------------------------------------------------------------
    // Exports
    //-------------------------------------------------------------------------------

    bugpack.export('Deferred', Deferred);
});