toolkit/modules/PromiseUtils.jsm

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 "use strict";
   6
   7 var EXPORTED_SYMBOLS = ["PromiseUtils"];
   8
   9 const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
  10
  11 var PromiseUtils = {
  12   /*
  13    * Creates a new pending Promise and provide methods to resolve and reject this Promise.
  14    *
  15    * @return {Deferred} an object consisting of a pending Promise "promise"
  16    * and methods "resolve" and "reject" to change its state.
  17    */
  18   defer() {
  19     return new Deferred();
  20   },
  21
  22   /**
  23    * Requests idle dispatch to the main thread for the given callback,
  24    * and returns a promise which resolves to the callback's return value
  25    * when it has been executed.
  26    *
  27    * @param {function} callback
  28    * @param {integer} [timeout]
  29    *        An optional timeout, after which the callback will be
  30    *        executed immediately if idle dispatch has not yet occurred.
  31    *
  32    * @returns {Promise}
  33    */
  34   idleDispatch(callback, timeout = 0) {
  35     return new Promise((resolve, reject) => {
  36       Services.tm.idleDispatchToMainThread(() => {
  37         try {
  38           resolve(callback());
  39         } catch (e) {
  40           reject(e);
  41         }
  42       }, timeout);
  43     });
  44   },
  45 };
  46
  47 /**
  48  * The definition of Deferred object which is returned by PromiseUtils.defer(),
  49  * It contains a Promise and methods to resolve/reject it.
  50  */
  51 function Deferred() {
  52   /* A method to resolve the associated Promise with the value passed.
  53    * If the promise is already settled it does nothing.
  54    *
  55    * @param {anything} value : This value is used to resolve the promise
  56    * If the value is a Promise then the associated promise assumes the state
  57    * of Promise passed as value.
  58    */
  59   this.resolve = null;
  60
  61   /* A method to reject the assocaited Promise with the value passed.
  62    * If the promise is already settled it does nothing.
  63    *
  64    * @param {anything} reason: The reason for the rejection of the Promise.
  65    * Generally its an Error object. If however a Promise is passed, then the Promise
  66    * itself will be the reason for rejection no matter the state of the Promise.
  67    */
  68   this.reject = null;
  69
  70   /* A newly created Pomise object.
  71    * Initially in pending state.
  72    */
  73   this.promise = new Promise((resolve, reject) => {
  74     this.resolve = resolve;
  75     this.reject = reject;
  76   });
  77 }