summaryrefslogtreecommitdiff
path: root/ext/js/language/dictionary-importer-media-loader.js
diff options
context:
space:
mode:
Diffstat (limited to 'ext/js/language/dictionary-importer-media-loader.js')
-rw-r--r--ext/js/language/dictionary-importer-media-loader.js9
1 files changed, 6 insertions, 3 deletions
diff --git a/ext/js/language/dictionary-importer-media-loader.js b/ext/js/language/dictionary-importer-media-loader.js
index 69a27f71..ce03ab20 100644
--- a/ext/js/language/dictionary-importer-media-loader.js
+++ b/ext/js/language/dictionary-importer-media-loader.js
@@ -21,9 +21,12 @@
class DictionaryImporterMediaLoader {
/**
* Attempts to load an image using an ArrayBuffer and a media type to return details about it.
- * @param content The binary content for the image, encoded as an ArrayBuffer.
- * @param mediaType The media type for the image content.
- * @returns A Promise which resolves with {content, width, height} on success, otherwise an error is thrown.
+ * @param {ArrayBuffer} content The binary content for the image, encoded as an ArrayBuffer.
+ * @param {string} mediaType The media type for the image content.
+ * @param {Transferable[]} [transfer] An optional array of data that should be transferred in `postMessage` calls.
+ * When the resulting promise resolves, this array will contain the `content` object.
+ * @returns {Promise<{content: ArrayBuffer, width: number, height: number}>} Details about the requested image content.
+ * @throws {Error} An error can be thrown if the image fails to load.
*/
getImageDetails(content, mediaType, transfer) {
return new Promise((resolve, reject) => {