dojo/DeferredList.js

• Provides:

  • dojo.DeferredList

• dojo.DeferredList

  • type

    Function

  • parameters:
    • list: (typeof Array)

      The list of deferreds to be synchronizied with this DeferredList

    • fireOnOneCallback: (typeof Boolean)

      Will cause the DeferredLists callback to be fired as soon as any
      of the deferreds in its list have been fired instead of waiting until
      the entire list has finished
      fireonOneErrback:
      Will cause the errback to fire upon any of the deferreds errback

    • fireOnOneErrback: (typeof Boolean)
    • consumeErrors: (typeof Boolean)
    • canceller: (typeof Function)

      A deferred canceller function, see dojo.Deferred

  • source: [view]
     var resultList = [];
     dojo.Deferred.call(this);
     var self = this;
     if(list.length === 0 && !fireOnOneCallback){
      this.resolve([0, []]);
     }
     var finished = 0;
     dojo.forEach(list, function(item, i){
      item.then(function(result){
       if(fireOnOneCallback){
        self.resolve([i, result]);
       }else{
        addResult(true, result);
       }
      },function(error){
       if(fireOnOneErrback){
        self.reject(error);
       }else{
        addResult(false, error);
       }
       if(consumeErrors){
        return null;
       }
       throw error;
      });
      function addResult(succeeded, result){
       resultList[i] = [succeeded, result];
       finished++;
       if(finished === list.length){
        self.resolve(resultList);
       }
    
       
      }
     });
  • summary

    Provides event handling for a group of Deferred objects.

  • description

    DeferredList takes an array of existing deferreds and returns a new deferred of its own
    this new deferred will typically have its callback fired when all of the deferreds in
    the given list have fired their own deferreds.  The parameters `fireOnOneCallback` and
    fireOnOneErrback, will fire before all the deferreds as appropriate

  • chains:
    • dojo.Deferred: (call)

• dojo.DeferredList.gatherResults

  • type

    Function

  • parameters:
    • deferredList: (typeof )
  • source: [view]
     var d = new dojo.DeferredList(deferredList, false, true, false);
     d.addCallback(function(results){
      var ret = [];
      dojo.forEach(results, function(result){
       ret.push(result[1]);
      });
      return ret;
     });
     return d;
  • summary

    Gathers the results of the deferreds for packaging
    as the parameters to the Deferred Lists' callback

• dojo.DeferredList.prototype

  • summary

• dojo

  • type

    Object

  • summary