[Summary view] [Print] [Text view]

   1  // This file is part of Moodle - http://moodle.org/
   2  //
   3  // Moodle is free software: you can redistribute it and/or modify
   4  // it under the terms of the GNU General Public License as published by
   5  // the Free Software Foundation, either version 3 of the License, or
   6  // (at your option) any later version.
   7  //
   8  // Moodle is distributed in the hope that it will be useful,
   9  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  // GNU General Public License for more details.
  12  //
  13  // You should have received a copy of the GNU General Public License
  14  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  15  
  16  /**
  17   * A helper to manage pendingJS checks.
  18   *
  19   * @module     core/pending
  20   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  21   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22   * @since      3.6
  23   */
  24  define(['jquery'], function($) {
  25  
  26     /**
  27      * Request a new pendingPromise to be resolved.
  28      *
  29      * When the action you are performing is complete, simply call resolve on the returned Promise.
  30      *
  31      * @param    {Object}    pendingKey An optional key value to use
  32      * @return   {Promise}
  33      */
  34      var request = function(pendingKey) {
  35          var pendingPromise = $.Deferred();
  36  
  37          pendingKey = pendingKey || {};
  38          M.util.js_pending(pendingKey);
  39  
  40          pendingPromise.then(function() {
  41              return M.util.js_complete(pendingKey);
  42          })
  43          .catch();
  44  
  45          return pendingPromise;
  46      };
  47  
  48      request.prototype.constructor = request;
  49  
  50      return request;
  51  });