feat: options.useWebWorker default set to true

Author: Donaldcwl

lib/image-compression.js

@@ -16,7 +16,7 @@ import {
  * @param {Object} options
  * @param {number} [options.maxSizeMB=Number.POSITIVE_INFINITY]
  * @param {number} [options.maxWidthOrHeight=undefined]
- * @param {boolean} [options.useWebWorker=false]
+ * @param {boolean} [options.useWebWorker=true]
  * @param {number} [options.maxIteration=10]
  * @param {number} [options.exifOrientation] - default to be the exif orientation from the image file
  * @param {Function} [options.onProgress] - a function takes one progress argument (progress from 0 to 100)

lib/index.d.ts

@@ -1,14 +1,13 @@
-// Type definitions for browser-image-compression 1.0
+// Type definitions for browser-image-compression 2.0
 // Project: https://github.com/Donaldcwl/browser-image-compression
 // Definitions by: Donald <https://github.com/Donaldcwl> & Jamie Haywood <https://github.com/jamiehaywood>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 interface Options {
     /** @default Number.POSITIVE_INFINITY */
     maxSizeMB?: number;
     /** @default undefined */
     maxWidthOrHeight?: number;
-    /** @default false */
+    /** @default true */
     useWebWorker?: boolean;
     /** @default 10 */
     maxIteration?: number;

lib/index.js

@@ -22,10 +22,10 @@ import compressOnWebWorker from './web-worker';
  * Compress an image file.
  *
  * @param {File} file
- * @param {Object} opts - { maxSizeMB=Number.POSITIVE_INFINITY, maxWidthOrHeight, useWebWorker=false, maxIteration = 10, exifOrientation, fileType }
+ * @param {Object} options - { maxSizeMB=Number.POSITIVE_INFINITY, maxWidthOrHeight, useWebWorker=false, maxIteration = 10, exifOrientation, fileType }
  * @param {number} [options.maxSizeMB=Number.POSITIVE_INFINITY]
  * @param {number} [options.maxWidthOrHeight=undefined]
- * @param {boolean} [options.useWebWorker=false]
+ * @param {boolean} [options.useWebWorker=true]
  * @param {number} [options.maxIteration=10]
  * @param {number} [options.exifOrientation] - default to be the exif orientation from the image file
  * @param {Function} [options.onProgress] - a function takes one progress argument (progress from 0 to 100)

lib/web-worker.js

@@ -358,6 +358,9 @@ export default function compressOnWebWorker(file, options) {
 
     function handler(e) {
       if (e.data.id === id) {
+        if (options.signal && options.signal.aborted) {
+          return;
+        }
         if (e.data.progress !== undefined) {
           options.onProgress(e.data.progress);
           return;
@@ -372,12 +375,18 @@ export default function compressOnWebWorker(file, options) {
 
     worker.addEventListener('message', handler);
     worker.addEventListener('error', reject);
+    if (options.signal) {
+      options.signal.addEventListener('abort', () => {
+        worker.terminate();
+        reject(options.signal.reason);
+      });
+    }
 
     worker.postMessage({
       file,
       id,
       imageCompressionLibUrl,
-      options: { ...options, onProgress: undefined },
+      options: { ...options, onProgress: undefined, signal: undefined },
     });
   });
 }