chromium/third_party/google-closure-library/closure/goog/labs/net/image.js

/**
 * @license
 * Copyright The Closure Library Authors.
 * SPDX-License-Identifier: Apache-2.0
 */

/**
 * @fileoverview Simple image loader, used for preloading.
 */

goog.provide('goog.labs.net.image');

goog.require('goog.Promise');
goog.require('goog.dispose');
goog.require('goog.dom.safe');
goog.require('goog.events.EventHandler');
goog.require('goog.events.EventType');
goog.require('goog.html.SafeUrl');
goog.require('goog.net.EventType');
goog.require('goog.userAgent');


/**
 * Loads a single image.  Useful for preloading images.
 *
 * @param {!goog.html.SafeUrl|string} uri URI of the image.
 * @param {(!Image|function(): !Image)=} opt_image If present, instead of
 *     creating a new Image instance the function will use the passed Image
 *     instance or the result of calling the Image factory respectively. This
 *     can be used to control exactly how Image instances are created, for
 *     example if they should be created in a particular document element, or
 *     have fields that will trigger CORS image fetches.
 * @return {!goog.Promise<!Image>} A Promise that will be resolved with the
 *     given image if the image successfully loads.
 */
goog.labs.net.image.load = function(uri, opt_image) {
  'use strict';
  return new goog
      .Promise(/**
                * @suppress {strictPrimitiveOperators} Part of the
                * go/strict_warnings_migration
                */
               function(resolve, reject) {
                 'use strict';
                 let image;
                 if (opt_image === undefined) {
                   image = new Image();
                 } else if (typeof opt_image === 'function') {
                   image = opt_image();
                 } else {
                   image = opt_image;
                 }

                 // IE's load event on images can be buggy.  For older browsers,
                 // wait for readystatechange events and check if readyState is
                 // 'complete'. See:
                 // http://msdn.microsoft.com/en-us/library/ie/ms536957(v=vs.85).aspx
                 // http://msdn.microsoft.com/en-us/library/ie/ms534359(v=vs.85).aspx
                 //
                 // Starting with IE11, start using standard 'load' events.
                 // See:
                 // http://msdn.microsoft.com/en-us/library/ie/dn467845(v=vs.85).aspx
                 const loadEvent =
                     (goog.userAgent.IE && goog.userAgent.VERSION < 11) ?
                     goog.net.EventType.READY_STATE_CHANGE :
                     goog.events.EventType.LOAD;

                 const handler = new goog.events.EventHandler();
                 handler.listen(
                     image,
                     [
                       loadEvent, goog.net.EventType.ABORT,
                       goog.net.EventType.ERROR
                     ],
                     function(e) {
                       'use strict';
                       // We only registered listeners for READY_STATE_CHANGE
                       // for IE. If readyState is now COMPLETE, the image has
                       // loaded. See related comment above.
                       if (e.type == goog.net.EventType.READY_STATE_CHANGE &&
                           image.readyState != goog.net.EventType.COMPLETE) {
                         return;
                       }

                       // At this point, we know whether the image load was
                       // successful and no longer care about image events.
                       goog.dispose(handler);

                       // Whether the image successfully loaded.
                       if (e.type == loadEvent) {
                         resolve(image);
                       } else {
                         reject(null);
                       }
                     });

                 // Initiate the image request.
                 goog.dom.safe.setImageSrc(image, uri);
               });
};