Fix type definitions.

blueimp · blueimp · commit 9233ecdfab98 · 2020-05-08T01:37:25.000+09:00
diff --git a/js/load-image-meta.js b/js/load-image-meta.js
@@ -67,10 +67,10 @@
    * - disableImageHead: Disables creating the imageHead property.
    *
    * @param {Blob} file Blob object
-   * @param {Function} callback Callback fynction
+   * @param {Function} [callback] Callback function
    * @param {object} [options] Parsing options
    * @param {object} [data] Result data object
-   * @returns {Promise|undefined} Returns Promise if no callback is provided.
+   * @returns {Promise<object>|undefined} Returns Promise if no callback given.
    */
   function parseMetaData(file, callback, options, data) {
     var that = this
@@ -205,7 +205,7 @@
    * @param {Blob} blob Blob object
    * @param {ArrayBuffer} head New JPEG head
    * @param {Function} [callback] Callback function
-   * @returns {Promise|undefined} Combined Blob
+   * @returns {Promise<Blob|null>|undefined} Combined Blob
    */
   function replaceHead(blob, head, callback) {
     var options = { maxMetaDataSize: 256, disableMetaDataParsers: true }
diff --git a/js/load-image.js b/js/load-image.js
@@ -87,21 +87,25 @@
     return Object.prototype.toString.call(obj) === '[object ' + type + ']'
   }
 
+  /**
+   * @typedef { HTMLImageElement|HTMLCanvasElement } Result
+   */
+
   /**
    * Loads an image for a given File object.
    *
    * @param {Blob|string} file Blob object or image URL
    * @param {Function|object} [callback] Image load event callback or options
    * @param {object} [options] Options object
-   * @returns {HTMLImageElement|HTMLCanvasElement|FileReader|Promise} Object
+   * @returns {HTMLImageElement|FileReader|Promise<Result>} Object
    */
   function loadImage(file, callback, options) {
     /**
      * Promise executor
      *
      * @param {Function} resolve Resolution function
      * @param {Function} reject Rejection function
-     * @returns {HTMLImageElement|HTMLCanvasElement|FileReader} Object
+     * @returns {HTMLImageElement|FileReader} Object
      */
     function executor(resolve, reject) {
       var img = document.createElement('img')
