compressorjs 1.3.0 → 1.4.0

package/README.md

@@ -2,18 +2,18 @@
 
 [![Coverage Status](https://img.shields.io/codecov/c/github/fengyuanchen/compressorjs.svg)](https://codecov.io/gh/fengyuanchen/compressorjs) [![Downloads](https://img.shields.io/npm/dm/compressorjs.svg)](https://www.npmjs.com/package/compressorjs) [![Version](https://img.shields.io/npm/v/compressorjs.svg)](https://www.npmjs.com/package/compressorjs) [![Gzip Size](https://img.shields.io/bundlephobia/minzip/compressorjs.svg)](https://unpkg.com/compressorjs/dist/compressor.common.js)
 
-> JavaScript image compressor. Uses the Browser's native [HTMLCanvasElement.toBlob()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob) method to do the compression work, which means it is **lossy compression**, **asynchronous**, and has **different compression effects in different browsers**. Generally use this to precompress a image on the client side before uploading it.
+> JavaScript image compressor. Uses the browser's native [HTMLCanvasElement.toBlob()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob) method to do the compression work, which means it is **lossy compression**, **asynchronous**, and has **different compression effects in different browsers**. Generally use this to precompress an image on the client side before uploading it.
 
 - [Website](https://fengyuanchen.github.io/compressorjs)
 
-## Table of contents
+## Table of Contents
 
 - [Main Files](#main-files)
-- [Getting started](#getting-started)
+- [Getting Started](#getting-started)
 - [Options](#options)
 - [Methods](#methods)
-- [No conflict](#no-conflict)
-- [Browser support](#browser-support)
+- [Static Methods](#static-methods)
+- [Browser Support](#browser-support)
 - [Contributing](#contributing)
 - [Versioning](#versioning)
 - [License](#license)
@@ -28,7 +28,7 @@ dist/
 └── compressor.esm.js    (ES Module)
 ```
 
-## Getting started
+## Getting Started
 
 ### Install
 
@@ -44,18 +44,15 @@ npm install compressorjs
 new Compressor(file[, options])
 ```
 
-**file**
+- **file**
+  - Type: [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) or [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)
+  - The target image file to compress.
 
-- Type: [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) or [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)
+- **options** (optional)
+  - Type: `Object`
+  - The configuration options. Check out the available [options](#options).
 
-The target image file for compressing.
-
-**options**
-
-- Type: `Object`
-- Optional
-
-The options for compressing. Check out the available [options](#options).
+Alternatively, you may use `Compressor.create(file[, options])`.
 
 #### Example
 
@@ -64,7 +61,6 @@ The options for compressing. Check out the available [options](#options).
 ```
 
 ```js
-import axios from 'axios';
 import Compressor from 'compressorjs';
 
 document.getElementById('file').addEventListener('change', (e) => {
@@ -78,32 +74,42 @@ document.getElementById('file').addEventListener('change', (e) => {
     quality: 0.6,
 
     // The compression process is asynchronous,
-    // which means you have to access the `result` in the `success` hook function.
+    // which means you need to access the `result` inside the `success` hook.
     success(result) {
       const formData = new FormData();
 
-      // The third parameter is required for server
-      formData.append('file', result, result.name);
+      // The third parameter is required by the server.
+      formData.append('file', result, result.name || 'compressed-image.jpg');
 
-      // Send the compressed image file to server with XMLHttpRequest.
-      axios.post('/path/to/upload', formData).then(() => {
+      fetch('/path/to/upload', {
+        method: 'POST',
+        body: formData,
+      }).then(() => {
         console.log('Upload success');
+      }).catch((error) => {
+        console.error('Upload failed', error);
       });
     },
     error(err) {
       console.log(err.message);
     },
   });
-
 });
 ```
 
 [⬆ back to top](#table-of-contents)
 
+### Tips
+
+- Use `quality` between `0.6` and `0.8` for a good balance between file size and visual quality.
+- Avoid `quality: 1` unless you need the image to stay as close as possible to the original; it can increase the file size.
+- For very large images, set `maxWidth` and `maxHeight` to limit the canvas size and avoid browser memory issues.
+- `convertTypes` and `convertSize` are useful for automatically converting large PNG files to JPEG to reduce file size.
+
 ## Options
 
 You may set compressor options with `new Compressor(file, options)`.
-If you want to change the global default options, You may use `Compressor.setDefaults(options)`.
+If you want to change the global default options, you may use `Compressor.setDefaults(options)`.
 
 ### strict
 
@@ -193,7 +199,7 @@ The height of the output image. If not specified, the natural height of the orig
 
 Sets how the size of the image should be resized to the container specified by the `width` and `height` options.
 
-**Note:** This option only available when both the `width` and `height` options are specified.
+**Note:** This option is only available when both the `width` and `height` options are specified.
 
 ### quality
 
@@ -202,7 +208,7 @@ Sets how the size of the image should be resized to the container specified by t
 
 The quality of the output image. It must be a number between `0` and `1`. If this argument is anything else, the default values `0.92` and `0.80` are used for `image/jpeg` and `image/webp` respectively. Other arguments are ignored. Be careful to use `1` as it may make the size of the output image become larger.
 
-**Note:** This option only available for `image/jpeg` and `image/webp` images.
+**Note:** This option is only available for `image/jpeg` and `image/webp` images.
 
 > Check out the documentation of the [HTMLCanvasElement.toBlob()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob) method for more detail.
 
@@ -263,7 +269,7 @@ Files whose file type is included in the `convertTypes` list, and whose file siz
   - `context`: The 2d rendering context of the canvas.
   - `canvas`: The canvas for compression.
 
-The hook function to execute before drawing the image into the canvas for compression.
+The hook function to execute before drawing the image onto the canvas for compression.
 
 ```js
 new Compressor(file, {
@@ -283,7 +289,7 @@ new Compressor(file, {
   - `context`: The 2d rendering context of the canvas.
   - `canvas`: The canvas for compression.
 
-The hook function to execute after drawing the image into the canvas for compression.
+The hook function to execute after drawing the image onto the canvas for compression.
 
 ```js
 new Compressor(file, {
@@ -300,9 +306,9 @@ new Compressor(file, {
 - Type: `Function`
 - Default: `null`
 - Parameters:
-  - `result`: The compressed image (a `File` (**read only**) or `Blob` object).
+  - `result`: The compressed image (`File` in modern browsers, or `Blob` as a fallback).
 
-The hook function to execute when successful to compress the image.
+The hook function to execute when the image has been successfully compressed.
 
 ### error(err)
 
@@ -311,7 +317,7 @@ The hook function to execute when successful to compress the image.
 - Parameters:
   - `err`: The compression error (an `Error` object).
 
-The hook function executes when fails to compress the image.
+The hook function executes when the image compression fails.
 
 [⬆ back to top](#table-of-contents)
 
@@ -328,7 +334,31 @@ const compressor = new Compressor(file);
 compressor.abort();
 ```
 
-## No conflict
+[⬆ back to top](#table-of-contents)
+
+## Static Methods
+
+### create(file[, options])
+
+Create a new `Compressor` instance. This is equivalent to `new Compressor(file, options)`.
+
+```js
+const compressor = Compressor.create(file, {
+  quality: 0.6,
+});
+```
+
+### setDefaults(options)
+
+Change the global default options for subsequently created `Compressor` instances. Instance options override these defaults.
+
+```js
+Compressor.setDefaults({
+  quality: 0.6,
+});
+```
+
+### noConflict()
 
 If you have to use another compressor with the same namespace, just call the `Compressor.noConflict` static method to revert to it.
 
@@ -341,7 +371,9 @@ If you have to use another compressor with the same namespace, just call the `Co
 </script>
 ```
 
-## Browser support
+[⬆ back to top](#table-of-contents)
+
+## Browser Support
 
 - Chrome (latest)
 - Firefox (latest)

package/dist/compressor.common.js

@@ -1,11 +1,11 @@
 /*!
- * Compressor.js v1.3.0
+ * Compressor.js v1.4.0
  * https://fengyuanchen.github.io/compressorjs
  *
  * Copyright 2018-present Chen Fengyuan
  * Released under the MIT license
  *
- * Date: 2026-04-06T07:12:45.816Z
+ * Date: 2026-10-01T04:45:36.902Z
  */
 
 'use strict';
@@ -77,6 +77,10 @@ function _toPropertyKey(t) {
   return "symbol" == typeof i ? i : i + "";
 }
 
+function getDefaultExportFromCjs (x) {
+	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+}
+
 var canvasToBlob = {exports: {}};
 
 /*
@@ -190,7 +194,8 @@ var canvasToBlob = {exports: {}};
     }
   })(window);
 })(canvasToBlob);
-var toBlob = canvasToBlob.exports;
+var canvasToBlobExports = canvasToBlob.exports;
+var toBlob = /*@__PURE__*/getDefaultExportFromCjs(canvasToBlobExports);
 
 var isBlob = function isBlob(value) {
   if (typeof Blob === 'undefined') {
@@ -198,22 +203,23 @@ var isBlob = function isBlob(value) {
   }
   return value instanceof Blob || Object.prototype.toString.call(value) === '[object Blob]';
 };
+var isBlob$1 = /*@__PURE__*/getDefaultExportFromCjs(isBlob);
 
 var DEFAULTS = {
   /**
-   * Indicates if output the original image instead of the compressed one
+   * Indicates whether to output the original image instead of the compressed one
    * when the size of the compressed image is greater than the original one's
    * @type {boolean}
    */
   strict: true,
   /**
-   * Indicates if read the image's Exif Orientation information,
+   * Indicates whether to read the image's Exif Orientation information,
    * and then rotate or flip the image automatically.
    * @type {boolean}
    */
   checkOrientation: true,
   /**
-   * Indicates if retain the image's Exif information after compressed.
+   * Indicates whether to retain the image's Exif information after compression.
    * @type {boolean}
   */
   retainExif: false,
@@ -272,7 +278,7 @@ var DEFAULTS = {
   /**
    * Files whose file type is included in this list,
    * and whose file size exceeds the `convertSize` value will be converted to JPEGs.
-   * @type {string｜Array}
+   * @type {string|string[]}
    */
   convertTypes: ['image/png'],
   /**
@@ -282,9 +288,9 @@ var DEFAULTS = {
    */
   convertSize: 5000000,
   /**
-   * The hook function to execute before draw the image into the canvas for compression.
+   * The hook function to execute before drawing the image into the canvas for compression.
    * @type {Function}
-   * @param {CanvasRenderingContext2D} context - The 2d rendering context of the canvas.
+   * @param {CanvasRenderingContext2D} context - The 2D rendering context of the canvas.
    * @param {HTMLCanvasElement} canvas - The canvas for compression.
    * @example
    * function (context, canvas) {
@@ -293,9 +299,9 @@ var DEFAULTS = {
    */
   beforeDraw: null,
   /**
-   * The hook function to execute after drew the image into the canvas for compression.
+   * The hook function to execute after drawing the image into the canvas for compression.
    * @type {Function}
-   * @param {CanvasRenderingContext2D} context - The 2d rendering context of the canvas.
+   * @param {CanvasRenderingContext2D} context - The 2D rendering context of the canvas.
    * @param {HTMLCanvasElement} canvas - The canvas for compression.
    * @example
    * function (context, canvas) {
@@ -304,7 +310,7 @@ var DEFAULTS = {
    */
   drew: null,
   /**
-   * The hook function to execute when success to compress the image.
+   * The hook function to execute when the image is compressed successfully.
    * @type {Function}
    * @param {File} file - The compressed image File object.
    * @example
@@ -349,9 +355,9 @@ function toArray(value) {
 var REGEXP_IMAGE_TYPE = /^image\/.+$/;
 
 /**
- * Check if the given value is a mime type of image.
+ * Check if the given value is an image MIME type.
  * @param {*} value - The value to check.
- * @returns {boolean} Returns `true` if the given is a mime type of image, else `false`.
+ * @returns {boolean} Returns `true` if the given value is an image MIME type, else `false`.
  */
 function isImageType(value) {
   return REGEXP_IMAGE_TYPE.test(value);
@@ -360,7 +366,7 @@ function isImageType(value) {
 /**
  * Convert image type to extension.
  * @param {string} value - The image type to convert.
- * @returns {boolean} Returns the image extension.
+ * @returns {string} Returns the image extension.
  */
 function imageTypeToExtension(value) {
   var extension = isImageType(value) ? value.substr(6) : '';
@@ -390,7 +396,7 @@ function getStringFromCharCode(dataView, start, length) {
 
 /**
  * Check if `canvas.getContext('2d').getImageData` is available,
- * FireFox randomizes the output of that function in `privacy.resistFingerprinting` mode (#137)
+ * Firefox randomizes the output of that function in `privacy.resistFingerprinting` mode (#137)
  * @link https://github.com/nodeca/pica/blob/master/lib/utils.js
  * @returns {boolean} Returns `true` if it is available, else `false`.
  */
@@ -435,7 +441,7 @@ var btoa = WINDOW.btoa;
 /**
  * Transform array buffer to Data URL.
  * @param {ArrayBuffer} arrayBuffer - The array buffer to transform.
- * @param {string} mimeType - The mime type of the Data URL.
+ * @param {string} mimeType - The MIME type of the Data URL.
  * @returns {string} The result Data URL.
  */
 function arrayBufferToDataURL(arrayBuffer, mimeType) {
@@ -683,11 +689,12 @@ var AnotherCompressor = WINDOW.Compressor;
  */
 var Compressor = /*#__PURE__*/function () {
   /**
-   * The constructor of Compressor.
-   * @param {File|Blob} file - The target image file for compressing.
-   * @param {Object} [options] - The options for compressing.
+   * Create a new Compressor.
+   * @param {File|Blob} file - The target image file to compress.
+   * @param {Object} [options={}] - The configuration options.
    */
-  function Compressor(file, options) {
+  function Compressor(file) {
+    var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
     _classCallCheck(this, Compressor);
     this.file = file;
     this.exif = [];
@@ -703,7 +710,7 @@ var Compressor = /*#__PURE__*/function () {
       var _this = this;
       var file = this.file,
         options = this.options;
-      if (!isBlob(file)) {
+      if (!isBlob$1(file)) {
         this.fail(new Error('The first argument must be a File or Blob object.'));
         return;
       }
@@ -1074,14 +1081,15 @@ var Compressor = /*#__PURE__*/function () {
     }
 
     /**
-     * Get the no conflict compressor class.
-     * @returns {Compressor} The compressor class.
+     * Creates a new Compressor instance.
+     * @param {File|Blob} file - The target image file to compress.
+     * @param {Object} [options={}] - The configuration options.
+     * @returns {Compressor} A new Compressor instance.
      */
   }], [{
-    key: "noConflict",
-    value: function noConflict() {
-      window.Compressor = AnotherCompressor;
-      return Compressor;
+    key: "create",
+    value: function create(file, options) {
+      return new Compressor(file, options);
     }
 
     /**
@@ -1093,6 +1101,17 @@ var Compressor = /*#__PURE__*/function () {
     value: function setDefaults(options) {
       _extends(DEFAULTS, options);
     }
+
+    /**
+     * Get the no conflict compressor class.
+     * @returns {Compressor} The compressor class.
+     */
+  }, {
+    key: "noConflict",
+    value: function noConflict() {
+      window.Compressor = AnotherCompressor;
+      return Compressor;
+    }
   }]);
 }();
 

package/dist/compressor.esm.js

@@ -1,11 +1,11 @@
 /*!
- * Compressor.js v1.3.0
+ * Compressor.js v1.4.0
  * https://fengyuanchen.github.io/compressorjs
  *
  * Copyright 2018-present Chen Fengyuan
  * Released under the MIT license
  *
- * Date: 2026-04-06T07:12:45.816Z
+ * Date: 2026-10-01T04:45:36.902Z
  */
 
 function _classCallCheck(a, n) {
@@ -75,6 +75,10 @@ function _toPropertyKey(t) {
   return "symbol" == typeof i ? i : i + "";
 }
 
+function getDefaultExportFromCjs (x) {
+	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+}
+
 var canvasToBlob = {exports: {}};
 
 /*
@@ -188,7 +192,8 @@ var canvasToBlob = {exports: {}};
     }
   })(window);
 })(canvasToBlob);
-var toBlob = canvasToBlob.exports;
+var canvasToBlobExports = canvasToBlob.exports;
+var toBlob = /*@__PURE__*/getDefaultExportFromCjs(canvasToBlobExports);
 
 var isBlob = function isBlob(value) {
   if (typeof Blob === 'undefined') {
@@ -196,22 +201,23 @@ var isBlob = function isBlob(value) {
   }
   return value instanceof Blob || Object.prototype.toString.call(value) === '[object Blob]';
 };
+var isBlob$1 = /*@__PURE__*/getDefaultExportFromCjs(isBlob);
 
 var DEFAULTS = {
   /**
-   * Indicates if output the original image instead of the compressed one
+   * Indicates whether to output the original image instead of the compressed one
    * when the size of the compressed image is greater than the original one's
    * @type {boolean}
    */
   strict: true,
   /**
-   * Indicates if read the image's Exif Orientation information,
+   * Indicates whether to read the image's Exif Orientation information,
    * and then rotate or flip the image automatically.
    * @type {boolean}
    */
   checkOrientation: true,
   /**
-   * Indicates if retain the image's Exif information after compressed.
+   * Indicates whether to retain the image's Exif information after compression.
    * @type {boolean}
   */
   retainExif: false,
@@ -270,7 +276,7 @@ var DEFAULTS = {
   /**
    * Files whose file type is included in this list,
    * and whose file size exceeds the `convertSize` value will be converted to JPEGs.
-   * @type {string｜Array}
+   * @type {string|string[]}
    */
   convertTypes: ['image/png'],
   /**
@@ -280,9 +286,9 @@ var DEFAULTS = {
    */
   convertSize: 5000000,
   /**
-   * The hook function to execute before draw the image into the canvas for compression.
+   * The hook function to execute before drawing the image into the canvas for compression.
    * @type {Function}
-   * @param {CanvasRenderingContext2D} context - The 2d rendering context of the canvas.
+   * @param {CanvasRenderingContext2D} context - The 2D rendering context of the canvas.
    * @param {HTMLCanvasElement} canvas - The canvas for compression.
    * @example
    * function (context, canvas) {
@@ -291,9 +297,9 @@ var DEFAULTS = {
    */
   beforeDraw: null,
   /**
-   * The hook function to execute after drew the image into the canvas for compression.
+   * The hook function to execute after drawing the image into the canvas for compression.
    * @type {Function}
-   * @param {CanvasRenderingContext2D} context - The 2d rendering context of the canvas.
+   * @param {CanvasRenderingContext2D} context - The 2D rendering context of the canvas.
    * @param {HTMLCanvasElement} canvas - The canvas for compression.
    * @example
    * function (context, canvas) {
@@ -302,7 +308,7 @@ var DEFAULTS = {
    */
   drew: null,
   /**
-   * The hook function to execute when success to compress the image.
+   * The hook function to execute when the image is compressed successfully.
    * @type {Function}
    * @param {File} file - The compressed image File object.
    * @example
@@ -347,9 +353,9 @@ function toArray(value) {
 var REGEXP_IMAGE_TYPE = /^image\/.+$/;
 
 /**
- * Check if the given value is a mime type of image.
+ * Check if the given value is an image MIME type.
  * @param {*} value - The value to check.
- * @returns {boolean} Returns `true` if the given is a mime type of image, else `false`.
+ * @returns {boolean} Returns `true` if the given value is an image MIME type, else `false`.
  */
 function isImageType(value) {
   return REGEXP_IMAGE_TYPE.test(value);
@@ -358,7 +364,7 @@ function isImageType(value) {
 /**
  * Convert image type to extension.
  * @param {string} value - The image type to convert.
- * @returns {boolean} Returns the image extension.
+ * @returns {string} Returns the image extension.
  */
 function imageTypeToExtension(value) {
   var extension = isImageType(value) ? value.substr(6) : '';
@@ -388,7 +394,7 @@ function getStringFromCharCode(dataView, start, length) {
 
 /**
  * Check if `canvas.getContext('2d').getImageData` is available,
- * FireFox randomizes the output of that function in `privacy.resistFingerprinting` mode (#137)
+ * Firefox randomizes the output of that function in `privacy.resistFingerprinting` mode (#137)
  * @link https://github.com/nodeca/pica/blob/master/lib/utils.js
  * @returns {boolean} Returns `true` if it is available, else `false`.
  */
@@ -433,7 +439,7 @@ var btoa = WINDOW.btoa;
 /**
  * Transform array buffer to Data URL.
  * @param {ArrayBuffer} arrayBuffer - The array buffer to transform.
- * @param {string} mimeType - The mime type of the Data URL.
+ * @param {string} mimeType - The MIME type of the Data URL.
  * @returns {string} The result Data URL.
  */
 function arrayBufferToDataURL(arrayBuffer, mimeType) {
@@ -681,11 +687,12 @@ var AnotherCompressor = WINDOW.Compressor;
  */
 var Compressor = /*#__PURE__*/function () {
   /**
-   * The constructor of Compressor.
-   * @param {File|Blob} file - The target image file for compressing.
-   * @param {Object} [options] - The options for compressing.
+   * Create a new Compressor.
+   * @param {File|Blob} file - The target image file to compress.
+   * @param {Object} [options={}] - The configuration options.
    */
-  function Compressor(file, options) {
+  function Compressor(file) {
+    var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
     _classCallCheck(this, Compressor);
     this.file = file;
     this.exif = [];
@@ -701,7 +708,7 @@ var Compressor = /*#__PURE__*/function () {
       var _this = this;
       var file = this.file,
         options = this.options;
-      if (!isBlob(file)) {
+      if (!isBlob$1(file)) {
         this.fail(new Error('The first argument must be a File or Blob object.'));
         return;
       }
@@ -1072,14 +1079,15 @@ var Compressor = /*#__PURE__*/function () {
     }
 
     /**
-     * Get the no conflict compressor class.
-     * @returns {Compressor} The compressor class.
+     * Creates a new Compressor instance.
+     * @param {File|Blob} file - The target image file to compress.
+     * @param {Object} [options={}] - The configuration options.
+     * @returns {Compressor} A new Compressor instance.
      */
   }], [{
-    key: "noConflict",
-    value: function noConflict() {
-      window.Compressor = AnotherCompressor;
-      return Compressor;
+    key: "create",
+    value: function create(file, options) {
+      return new Compressor(file, options);
     }
 
     /**
@@ -1091,6 +1099,17 @@ var Compressor = /*#__PURE__*/function () {
     value: function setDefaults(options) {
       _extends(DEFAULTS, options);
     }
+
+    /**
+     * Get the no conflict compressor class.
+     * @returns {Compressor} The compressor class.
+     */
+  }, {
+    key: "noConflict",
+    value: function noConflict() {
+      window.Compressor = AnotherCompressor;
+      return Compressor;
+    }
   }]);
 }();
 

package/dist/compressor.js

@@ -1,11 +1,11 @@
 /*!
- * Compressor.js v1.3.0
+ * Compressor.js v1.4.0
  * https://fengyuanchen.github.io/compressorjs
  *
  * Copyright 2018-present Chen Fengyuan
  * Released under the MIT license
  *
- * Date: 2026-04-06T07:12:45.816Z
+ * Date: 2026-10-01T04:45:36.902Z
  */
 
 (function (global, factory) {
@@ -81,6 +81,10 @@
     return "symbol" == typeof i ? i : i + "";
   }
 
+  function getDefaultExportFromCjs (x) {
+  	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+  }
+
   var canvasToBlob = {exports: {}};
 
   /*
@@ -194,7 +198,8 @@
       }
     })(window);
   })(canvasToBlob);
-  var toBlob = canvasToBlob.exports;
+  var canvasToBlobExports = canvasToBlob.exports;
+  var toBlob = /*@__PURE__*/getDefaultExportFromCjs(canvasToBlobExports);
 
   var isBlob = function isBlob(value) {
     if (typeof Blob === 'undefined') {
@@ -202,22 +207,23 @@
     }
     return value instanceof Blob || Object.prototype.toString.call(value) === '[object Blob]';
   };
+  var isBlob$1 = /*@__PURE__*/getDefaultExportFromCjs(isBlob);
 
   var DEFAULTS = {
     /**
-     * Indicates if output the original image instead of the compressed one
+     * Indicates whether to output the original image instead of the compressed one
      * when the size of the compressed image is greater than the original one's
      * @type {boolean}
      */
     strict: true,
     /**
-     * Indicates if read the image's Exif Orientation information,
+     * Indicates whether to read the image's Exif Orientation information,
      * and then rotate or flip the image automatically.
      * @type {boolean}
      */
     checkOrientation: true,
     /**
-     * Indicates if retain the image's Exif information after compressed.
+     * Indicates whether to retain the image's Exif information after compression.
      * @type {boolean}
     */
     retainExif: false,
@@ -276,7 +282,7 @@
     /**
      * Files whose file type is included in this list,
      * and whose file size exceeds the `convertSize` value will be converted to JPEGs.
-     * @type {string｜Array}
+     * @type {string|string[]}
      */
     convertTypes: ['image/png'],
     /**
@@ -286,9 +292,9 @@
      */
     convertSize: 5000000,
     /**
-     * The hook function to execute before draw the image into the canvas for compression.
+     * The hook function to execute before drawing the image into the canvas for compression.
      * @type {Function}
-     * @param {CanvasRenderingContext2D} context - The 2d rendering context of the canvas.
+     * @param {CanvasRenderingContext2D} context - The 2D rendering context of the canvas.
      * @param {HTMLCanvasElement} canvas - The canvas for compression.
      * @example
      * function (context, canvas) {
@@ -297,9 +303,9 @@
      */
     beforeDraw: null,
     /**
-     * The hook function to execute after drew the image into the canvas for compression.
+     * The hook function to execute after drawing the image into the canvas for compression.
      * @type {Function}
-     * @param {CanvasRenderingContext2D} context - The 2d rendering context of the canvas.
+     * @param {CanvasRenderingContext2D} context - The 2D rendering context of the canvas.
      * @param {HTMLCanvasElement} canvas - The canvas for compression.
      * @example
      * function (context, canvas) {
@@ -308,7 +314,7 @@
      */
     drew: null,
     /**
-     * The hook function to execute when success to compress the image.
+     * The hook function to execute when the image is compressed successfully.
      * @type {Function}
      * @param {File} file - The compressed image File object.
      * @example
@@ -353,9 +359,9 @@
   var REGEXP_IMAGE_TYPE = /^image\/.+$/;
 
   /**
-   * Check if the given value is a mime type of image.
+   * Check if the given value is an image MIME type.
    * @param {*} value - The value to check.
-   * @returns {boolean} Returns `true` if the given is a mime type of image, else `false`.
+   * @returns {boolean} Returns `true` if the given value is an image MIME type, else `false`.
    */
   function isImageType(value) {
     return REGEXP_IMAGE_TYPE.test(value);
@@ -364,7 +370,7 @@
   /**
    * Convert image type to extension.
    * @param {string} value - The image type to convert.
-   * @returns {boolean} Returns the image extension.
+   * @returns {string} Returns the image extension.
    */
   function imageTypeToExtension(value) {
     var extension = isImageType(value) ? value.substr(6) : '';
@@ -394,7 +400,7 @@
 
   /**
    * Check if `canvas.getContext('2d').getImageData` is available,
-   * FireFox randomizes the output of that function in `privacy.resistFingerprinting` mode (#137)
+   * Firefox randomizes the output of that function in `privacy.resistFingerprinting` mode (#137)
    * @link https://github.com/nodeca/pica/blob/master/lib/utils.js
    * @returns {boolean} Returns `true` if it is available, else `false`.
    */
@@ -439,7 +445,7 @@
   /**
    * Transform array buffer to Data URL.
    * @param {ArrayBuffer} arrayBuffer - The array buffer to transform.
-   * @param {string} mimeType - The mime type of the Data URL.
+   * @param {string} mimeType - The MIME type of the Data URL.
    * @returns {string} The result Data URL.
    */
   function arrayBufferToDataURL(arrayBuffer, mimeType) {
@@ -687,11 +693,12 @@
    */
   var Compressor = /*#__PURE__*/function () {
     /**
-     * The constructor of Compressor.
-     * @param {File|Blob} file - The target image file for compressing.
-     * @param {Object} [options] - The options for compressing.
+     * Create a new Compressor.
+     * @param {File|Blob} file - The target image file to compress.
+     * @param {Object} [options={}] - The configuration options.
      */
-    function Compressor(file, options) {
+    function Compressor(file) {
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       _classCallCheck(this, Compressor);
       this.file = file;
       this.exif = [];
@@ -707,7 +714,7 @@
         var _this = this;
         var file = this.file,
           options = this.options;
-        if (!isBlob(file)) {
+        if (!isBlob$1(file)) {
           this.fail(new Error('The first argument must be a File or Blob object.'));
           return;
         }
@@ -1078,14 +1085,15 @@
       }
 
       /**
-       * Get the no conflict compressor class.
-       * @returns {Compressor} The compressor class.
+       * Creates a new Compressor instance.
+       * @param {File|Blob} file - The target image file to compress.
+       * @param {Object} [options={}] - The configuration options.
+       * @returns {Compressor} A new Compressor instance.
        */
     }], [{
-      key: "noConflict",
-      value: function noConflict() {
-        window.Compressor = AnotherCompressor;
-        return Compressor;
+      key: "create",
+      value: function create(file, options) {
+        return new Compressor(file, options);
       }
 
       /**
@@ -1097,6 +1105,17 @@
       value: function setDefaults(options) {
         _extends(DEFAULTS, options);
       }
+
+      /**
+       * Get the no conflict compressor class.
+       * @returns {Compressor} The compressor class.
+       */
+    }, {
+      key: "noConflict",
+      value: function noConflict() {
+        window.Compressor = AnotherCompressor;
+        return Compressor;
+      }
     }]);
   }();
 

package/dist/compressor.min.js

@@ -1,10 +1,10 @@
 /*!
- * Compressor.js v1.3.0
+ * Compressor.js v1.4.0
  * https://fengyuanchen.github.io/compressorjs
  *
  * Copyright 2018-present Chen Fengyuan
  * Released under the MIT license
  *
- * Date: 2026-04-06T07:12:45.816Z
+ * Date: 2026-10-01T04:45:36.902Z
  */
-((e,t)=>{"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).Compressor=t()})(this,function(){function a(e,t){for(var r=0;r<t.length;r++){var i=t[r];i.enumerable=i.enumerable||!1,i.configurable=!0,"value"in i&&(i.writable=!0),Object.defineProperty(e,o(i.key),i)}}function s(){return(s=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r,i=arguments[t];for(r in i)!{}.hasOwnProperty.call(i,r)||(e[r]=i[r])}return e}).apply(null,arguments)}function t(t,e){var r,i=Object.keys(t);return Object.getOwnPropertySymbols&&(r=Object.getOwnPropertySymbols(t),e&&(r=r.filter(function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable})),i.push.apply(i,r)),i}function n(i){for(var e=1;e<arguments.length;e++){var a=null!=arguments[e]?arguments[e]:{};e%2?t(Object(a),!0).forEach(function(e){var t,r;t=i,r=a[e=e],(e=o(e))in t?Object.defineProperty(t,e,{value:r,enumerable:!0,configurable:!0,writable:!0}):t[e]=r}):Object.getOwnPropertyDescriptors?Object.defineProperties(i,Object.getOwnPropertyDescriptors(a)):t(Object(a)).forEach(function(e){Object.defineProperty(i,e,Object.getOwnPropertyDescriptor(a,e))})}return i}function o(e){e=((e,t)=>{if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0===r)return("string"===t?String:Number)(e);if("object"!=typeof(r=r.call(e,t||"default")))return r;throw new TypeError("@@toPrimitive must return a primitive value.")})(e,"string");return"symbol"==typeof e?e:e+""}function x(e){return 0<e&&e<1/0}var e,r,l,c,h,u,f,d,i={exports:{}},O=(e=i,"undefined"!=typeof window&&(l=(r=window).HTMLCanvasElement&&r.HTMLCanvasElement.prototype,c=r.Blob&&(()=>{try{return Boolean(new Blob)}catch(e){return!1}})(),h=c&&r.Uint8Array&&(()=>{try{return 100===new Blob([new Uint8Array(100)]).size}catch(e){return!1}})(),u=r.BlobBuilder||r.WebKitBlobBuilder||r.MozBlobBuilder||r.MSBlobBuilder,f=/^data:((.*?)(;charset=.*?)?)(;base64)?,/,d=(c||u)&&r.atob&&r.ArrayBuffer&&r.Uint8Array&&function(e){var t,r,i,a,n,o=e.match(f);if(!o)throw new Error("invalid data URI");for(t=o[2]?o[1]:"text/plain"+(o[3]||";charset=US-ASCII"),n=!!o[4],e=e.slice(o[0].length),r=(n?atob:decodeURIComponent)(e),o=new ArrayBuffer(r.length),i=new Uint8Array(o),a=0;a<r.length;a+=1)i[a]=r.charCodeAt(a);return c?new Blob([h?i:o],{type:t}):((n=new u).append(o),n.getBlob(t))},r.HTMLCanvasElement&&!l.toBlob&&(l.mozGetAsFile?l.toBlob=function(e,t,r){var i=this;setTimeout(function(){r&&l.toDataURL&&d?e(d(i.toDataURL(t,r))):e(i.mozGetAsFile("blob",t))})}:l.toDataURL&&d&&(l.msToBlob?l.toBlob=function(e,t,r){var i=this;setTimeout(function(){(t&&"image/png"!==t||r)&&l.toDataURL&&d?e(d(i.toDataURL(t,r))):e(i.msToBlob(t))})}:l.toBlob=function(e,t,r){var i=this;setTimeout(function(){e(d(i.toDataURL(t,r)))})})),e.exports?e.exports=d:r.dataURLtoBlob=d),i.exports),m={strict:!0,checkOrientation:!0,retainExif:!1,maxWidth:1/0,maxHeight:1/0,minWidth:0,minHeight:0,width:void 0,height:void 0,resize:"none",quality:.8,mimeType:"auto",convertTypes:["image/png"],convertSize:5e6,beforeDraw:null,drew:null,success:null,error:null},g="undefined"!=typeof window&&void 0!==window.document?window:{},p=Array.prototype.slice;function j(e){return Array.from?Array.from(e):p.call(e)}var b=/^image\/.+$/;function T(e){return b.test(e)}var y=String.fromCharCode;var w=g.btoa;function A(e,t){for(var r=[],i=new Uint8Array(e);0<i.length;)r.push(y.apply(null,j(i.subarray(0,8192)))),i=i.subarray(8192);return"data:".concat(t,";base64,").concat(w(r.join("")))}function v(e){var t,r,i,a,n,o,l,s=new DataView(e);try{if(255===s.getUint8(0)&&216===s.getUint8(1))for(var c=s.byteLength,h=2;h+1<c;){if(255===s.getUint8(h)&&225===s.getUint8(h+1)){r=h;break}h+=1}if(i=r&&(a=r+10,"Exif"===((e,t,r)=>{var i,a="";for(r+=t,i=t;i<r;i+=1)a+=y(e.getUint8(i));return a})(s,r+4,4))&&((l=18761===(n=s.getUint16(a)))||19789===n)&&42===s.getUint16(a+2,l)&&8<=(o=s.getUint32(a+4,l))?a+o:i)for(var u,f=s.getUint16(i,l),d=0;d<f;d+=1)if(u=i+12*d+2,274===s.getUint16(u,l)){u+=8,t=s.getUint16(u,l),s.setUint16(u,1,l);break}}catch(e){t=1}return t}var B=/\.\d*(?:0|9){12}\d*$/;function R(e,t){t=1<arguments.length&&void 0!==t?t:1e11;return B.test(e)?Math.round(e*t)/t:e}function E(e,t){var r,i=e.aspectRatio,a=e.height,e=e.width,t=1<arguments.length&&void 0!==t?t:"none",n=x(e),o=x(a);return n&&o?(r=a*i,("contain"===t||"none"===t)&&e<r||"cover"===t&&r<e?a=e/i:e=a*i):n?a=e/i:o&&(e=a*i),{width:e,height:a}}var U=g.ArrayBuffer,k=g.FileReader,D=g.URL||g.webkitURL,M=/\.\w+$/,L=g.Compressor;return(()=>{function r(e,t){if(!(this instanceof r))throw new TypeError("Cannot call a class as a function");this.file=e,this.exif=[],this.image=new Image,this.options=n(n({},m),t),this.aborted=!1,this.result=null,this.init()}return e=r,i=[{key:"noConflict",value:function(){return window.Compressor=L,r}},{key:"setDefaults",value:function(e){s(m,e)}}],(t=[{key:"init",value:function(){var i,a,n,e,o=this,l=this.file,t=this.options;e=l,"undefined"!=typeof Blob&&(e instanceof Blob||"[object Blob]"===Object.prototype.toString.call(e))?T(i=l.type)?D&&k?(U||(t.checkOrientation=!1,t.retainExif=!1),a=(e="image/jpeg"===i)&&t.checkOrientation,n=e&&t.retainExif,!D||a||n?(e=new k,(this.reader=e).onload=function(e){var e=e.target.result,t={},r=1;a&&1<(r=v(e))&&s(t,(e=>{var t=0,r=1,i=1;switch(e){case 2:r=-1;break;case 3:t=-180;break;case 4:i=-1;break;case 5:t=90,i=-1;break;case 6:t=90;break;case 7:t=90,r=-1;break;case 8:t=-90}return{rotate:t,scaleX:r,scaleY:i}})(r)),n&&(o.exif=(e=>{for(var t=j(new Uint8Array(e)),r=t.length,i=[],a=0;a+3<r;){var n=t[a],o=t[a+1];if(255===n&&218===o)break;255===n&&216===o?a+=2:(n=a+(256*t[a+2]+t[a+3])+2,o=t.slice(a,n),i.push(o),a=n)}return i.reduce(function(e,t){return 255===t[0]&&225===t[1]?e.concat(t):e},[])})(e)),t.url=a||n?!D||1<r?A(e,i):D.createObjectURL(l):e,o.load(t)},e.onabort=function(){o.fail(new Error("Aborted to read the image with FileReader."))},e.onerror=function(){o.fail(new Error("Failed to read the image with FileReader."))},e.onloadend=function(){o.reader=null},a||n?e.readAsArrayBuffer(l):e.readAsDataURL(l)):this.load({url:D.createObjectURL(l)})):this.fail(new Error("The current browser does not support image compression.")):this.fail(new Error("The first argument must be an image File or Blob object.")):this.fail(new Error("The first argument must be a File or Blob object."))}},{key:"load",value:function(e){var t=this,r=this.file,i=this.image;i.onload=function(){(()=>{try{var e,t,r,i=document.createElement("canvas"),a=(i.width=2,i.height=1,i.getContext("2d"));if(a)return(e=a.createImageData(2,1)).data[0]=12,e.data[1]=23,e.data[2]=34,e.data[3]=255,e.data[4]=45,e.data[5]=56,e.data[6]=67,e.data[7]=255,a.putImageData(e,0,0),t=a.getImageData(0,0,2,1),r=[12,23,34,255,45,56,67,255],t.data.every(function(e,t){return e===r[t]})}catch(e){}})()?t.draw(n(n({},e),{},{naturalWidth:i.naturalWidth,naturalHeight:i.naturalHeight})):t.done({naturalWidth:i.naturalWidth,naturalHeight:i.naturalHeight,result:null})},i.onabort=function(){t.fail(new Error("Aborted to load the image."))},i.onerror=function(){t.fail(new Error("Failed to load the image."))},g.navigator&&/(?:iPad|iPhone|iPod).*?AppleWebKit/i.test(g.navigator.userAgent)&&(i.crossOrigin="anonymous"),i.alt=r.name,i.src=e.url}},{key:"draw",value:function(e){var a=this,n=e.naturalWidth,o=e.naturalHeight,t=e.rotate,t=void 0===t?0:t,r=e.scaleX,r=void 0===r?1:r,e=e.scaleY,e=void 0===e?1:e,i=this.file,l=this.image,s=this.options,c=document.createElement("canvas"),h=c.getContext("2d"),u=Math.abs(t)%180==90,f=("contain"===s.resize||"cover"===s.resize)&&x(s.width)&&x(s.height),d=Math.max(s.maxWidth,0)||1/0,m=Math.max(s.maxHeight,0)||1/0,g=Math.max(s.minWidth,0)||0,p=Math.max(s.minHeight,0)||0,b=n/o,y=s.width,w=s.height,v=(u&&(d=(v=[m,d])[0],m=v[1],g=(v=[p,g])[0],p=v[1],y=(v=[w,y])[0],w=v[1]),E({aspectRatio:b=f?y/w:b,width:d,height:m},"contain")),v=(d=v.width,m=v.height,E({aspectRatio:b,width:g,height:p},"cover")),v=(g=v.width,p=v.height,w=f?(y=(v=E({aspectRatio:b,width:y,height:w},s.resize)).width,v.height):(y=void 0===(B=(v=E({aspectRatio:b,width:y,height:w})).width)?n:B,void 0===(B=v.height)?o:B),-(y=Math.floor(R(Math.min(Math.max(y,g),d))))/2),B=-(w=Math.floor(R(Math.min(Math.max(w,p),m))))/2,g=y,d=w,p=[],m=(f&&(0,m=(b=E({aspectRatio:b,width:m=n,height:f=o},{contain:"cover",cover:"contain"}[s.resize])).width,p.push((n-m)/2,(o-(f=b.height))/2,m,f)),p.push(v,B,g,d),u&&(y=(b=[w,y])[0],w=b[1]),c.width=y,c.height=w,T(s.mimeType)||(s.mimeType=i.type),"transparent"),U=(i.size>s.convertSize&&0<=s.convertTypes.indexOf(s.mimeType)&&(s.mimeType="image/jpeg"),"image/jpeg"===s.mimeType);h.fillStyle=m=U?"#fff":m,h.fillRect(0,0,y,w),s.beforeDraw&&s.beforeDraw.call(this,h,c),this.aborted||(h.save(),h.translate(y/2,w/2),h.rotate(t*Math.PI/180),h.scale(r,e),h.drawImage.apply(h,[l].concat(p)),h.restore(),s.drew&&s.drew.call(this,h,c),this.aborted)||(f=function(e){var i,t,r;a.aborted||(i=function(e){return a.done({naturalWidth:n,naturalHeight:o,result:e})},e&&U&&s.retainExif&&a.exif&&0<a.exif.length?(t=function(e){return i(O(A((e=e,t=a.exif,255!==(r=j(new Uint8Array(e)))[2]||224!==r[3]?e:(e=[255,216].concat(t,r.slice(4+(256*r[4]+r[5]))),new Uint8Array(e))),s.mimeType)));var t,r},e.arrayBuffer?e.arrayBuffer().then(t).catch(function(){a.fail(new Error("Failed to read the compressed image with Blob.arrayBuffer()."))}):(r=new k,(a.reader=r).onload=function(e){e=e.target;t(e.result)},r.onabort=function(){a.fail(new Error("Aborted to read the compressed image with FileReader."))},r.onerror=function(){a.fail(new Error("Failed to read the compressed image with FileReader."))},r.onloadend=function(){a.reader=null},r.readAsArrayBuffer(e))):i(e))},c.toBlob?c.toBlob(f,s.mimeType,s.quality):f(O(c.toDataURL(s.mimeType,s.quality))))}},{key:"done",value:function(t){var e=t.naturalWidth,r=t.naturalHeight,t=t.result,i=this.file,a=this.image,n=this.options;if(D&&0===a.src.indexOf("blob:")&&D.revokeObjectURL(a.src),t)if(n.strict&&!n.retainExif&&t.size>i.size&&n.mimeType===i.type&&!(n.width>e||n.height>r||n.minWidth>e||n.minHeight>r||n.maxWidth<e||n.maxHeight<r))t=i;else{a=i.name;a&&t.type!==i.type&&(a=a.replace(M,(e=T(e=t.type)?e.substr(6):"",".".concat(e="jpeg"===e?"jpg":e))));try{t=new File([t],a,{type:t.type})}catch(e){r=new Date;t.name=a,t.lastModified=r.getTime(),t.lastModifiedDate=r}}else t=i;this.result=t,n.success&&n.success.call(this,t)}},{key:"fail",value:function(e){var t=this.options;if(!t.error)throw e;t.error.call(this,e)}},{key:"abort",value:function(){this.aborted||(this.aborted=!0,this.reader?this.reader.abort():this.image.complete?this.fail(new Error("The compression process has been aborted.")):(this.image.onload=null,this.image.onabort()))}}])&&a(e.prototype,t),i&&a(e,i),Object.defineProperty(e,"prototype",{writable:!1}),e;var e,t,i})()});
+((e,t)=>{"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).Compressor=t()})(this,function(){function a(e,t){for(var r=0;r<t.length;r++){var a=t[r];a.enumerable=a.enumerable||!1,a.configurable=!0,"value"in a&&(a.writable=!0),Object.defineProperty(e,o(a.key),a)}}function s(){return(s=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r,a=arguments[t];for(r in a)!{}.hasOwnProperty.call(a,r)||(e[r]=a[r])}return e}).apply(null,arguments)}function t(t,e){var r,a=Object.keys(t);return Object.getOwnPropertySymbols&&(r=Object.getOwnPropertySymbols(t),e&&(r=r.filter(function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable})),a.push.apply(a,r)),a}function n(a){for(var e=1;e<arguments.length;e++){var i=null!=arguments[e]?arguments[e]:{};e%2?t(Object(i),!0).forEach(function(e){var t,r;t=a,r=i[e=e],(e=o(e))in t?Object.defineProperty(t,e,{value:r,enumerable:!0,configurable:!0,writable:!0}):t[e]=r}):Object.getOwnPropertyDescriptors?Object.defineProperties(a,Object.getOwnPropertyDescriptors(i)):t(Object(i)).forEach(function(e){Object.defineProperty(a,e,Object.getOwnPropertyDescriptor(i,e))})}return a}function o(e){e=((e,t)=>{if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0===r)return("string"===t?String:Number)(e);if("object"!=typeof(r=r.call(e,t||"default")))return r;throw new TypeError("@@toPrimitive must return a primitive value.")})(e,"string");return"symbol"==typeof e?e:e+""}function e(e){return e&&e.__esModule&&Object.prototype.hasOwnProperty.call(e,"default")?e.default:e}var r,i,l,c,u,h,f,d,m={exports:{}};r=m,"undefined"!=typeof window&&(l=(i=window).HTMLCanvasElement&&i.HTMLCanvasElement.prototype,c=i.Blob&&(()=>{try{return Boolean(new Blob)}catch(e){return!1}})(),u=c&&i.Uint8Array&&(()=>{try{return 100===new Blob([new Uint8Array(100)]).size}catch(e){return!1}})(),h=i.BlobBuilder||i.WebKitBlobBuilder||i.MozBlobBuilder||i.MSBlobBuilder,f=/^data:((.*?)(;charset=.*?)?)(;base64)?,/,d=(c||h)&&i.atob&&i.ArrayBuffer&&i.Uint8Array&&function(e){var t,r,a,i,n,o=e.match(f);if(!o)throw new Error("invalid data URI");for(t=o[2]?o[1]:"text/plain"+(o[3]||";charset=US-ASCII"),n=!!o[4],e=e.slice(o[0].length),r=(n?atob:decodeURIComponent)(e),o=new ArrayBuffer(r.length),a=new Uint8Array(o),i=0;i<r.length;i+=1)a[i]=r.charCodeAt(i);return c?new Blob([u?a:o],{type:t}):((n=new h).append(o),n.getBlob(t))},i.HTMLCanvasElement&&!l.toBlob&&(l.mozGetAsFile?l.toBlob=function(e,t,r){var a=this;setTimeout(function(){r&&l.toDataURL&&d?e(d(a.toDataURL(t,r))):e(a.mozGetAsFile("blob",t))})}:l.toDataURL&&d&&(l.msToBlob?l.toBlob=function(e,t,r){var a=this;setTimeout(function(){(t&&"image/png"!==t||r)&&l.toDataURL&&d?e(d(a.toDataURL(t,r))):e(a.msToBlob(t))})}:l.toBlob=function(e,t,r){var a=this;setTimeout(function(){e(d(a.toDataURL(t,r)))})})),r.exports?r.exports=d:i.dataURLtoBlob=d);function O(e){return 0<e&&e<1/0}var x=e(m.exports),p=e(function(e){return"undefined"!=typeof Blob&&(e instanceof Blob||"[object Blob]"===Object.prototype.toString.call(e))}),g={strict:!0,checkOrientation:!0,retainExif:!1,maxWidth:1/0,maxHeight:1/0,minWidth:0,minHeight:0,width:void 0,height:void 0,resize:"none",quality:.8,mimeType:"auto",convertTypes:["image/png"],convertSize:5e6,beforeDraw:null,drew:null,success:null,error:null},b="undefined"!=typeof window&&void 0!==window.document?window:{},y=Array.prototype.slice;function j(e){return Array.from?Array.from(e):y.call(e)}var w=/^image\/.+$/;function T(e){return w.test(e)}var v=String.fromCharCode;var B=b.btoa;function A(e,t){for(var r=[],a=new Uint8Array(e);0<a.length;)r.push(v.apply(null,j(a.subarray(0,8192)))),a=a.subarray(8192);return"data:".concat(t,";base64,").concat(B(r.join("")))}function U(e){var t,r,a,i,n,o,l,s=new DataView(e);try{if(255===s.getUint8(0)&&216===s.getUint8(1))for(var c=s.byteLength,u=2;u+1<c;){if(255===s.getUint8(u)&&225===s.getUint8(u+1)){r=u;break}u+=1}if(a=r&&(i=r+10,"Exif"===((e,t,r)=>{var a,i="";for(r+=t,a=t;a<r;a+=1)i+=v(e.getUint8(a));return i})(s,r+4,4))&&((l=18761===(n=s.getUint16(i)))||19789===n)&&42===s.getUint16(i+2,l)&&8<=(o=s.getUint32(i+4,l))?i+o:a)for(var h,f=s.getUint16(a,l),d=0;d<f;d+=1)if(h=a+12*d+2,274===s.getUint16(h,l)){h+=8,t=s.getUint16(h,l),s.setUint16(h,1,l);break}}catch(e){t=1}return t}var R=/\.\d*(?:0|9){12}\d*$/;function E(e,t){t=1<arguments.length&&void 0!==t?t:1e11;return R.test(e)?Math.round(e*t)/t:e}function k(e,t){var r,a=e.aspectRatio,i=e.height,e=e.width,t=1<arguments.length&&void 0!==t?t:"none",n=O(e),o=O(i);return n&&o?(r=i*a,("contain"===t||"none"===t)&&e<r||"cover"===t&&r<e?i=e/a:e=i*a):n?i=e/a:o&&(e=i*a),{width:e,height:i}}var D=b.ArrayBuffer,M=b.FileReader,P=b.URL||b.webkitURL,L=/\.\w+$/,H=b.Compressor;return(()=>{function i(e){var t=1<arguments.length&&void 0!==arguments[1]?arguments[1]:{},r=this,a=i;if(!(r instanceof a))throw new TypeError("Cannot call a class as a function");this.file=e,this.exif=[],this.image=new Image,this.options=n(n({},g),t),this.aborted=!1,this.result=null,this.init()}return e=i,r=[{key:"create",value:function(e,t){return new i(e,t)}},{key:"setDefaults",value:function(e){s(g,e)}},{key:"noConflict",value:function(){return window.Compressor=H,i}}],(t=[{key:"init",value:function(){var a,i,n,e,o=this,l=this.file,t=this.options;p(l)?T(a=l.type)?P&&M?(D||(t.checkOrientation=!1,t.retainExif=!1),i=(e="image/jpeg"===a)&&t.checkOrientation,n=e&&t.retainExif,!P||i||n?(e=new M,(this.reader=e).onload=function(e){var e=e.target.result,t={},r=1;i&&1<(r=U(e))&&s(t,(e=>{var t=0,r=1,a=1;switch(e){case 2:r=-1;break;case 3:t=-180;break;case 4:a=-1;break;case 5:t=90,a=-1;break;case 6:t=90;break;case 7:t=90,r=-1;break;case 8:t=-90}return{rotate:t,scaleX:r,scaleY:a}})(r)),n&&(o.exif=(e=>{for(var t=j(new Uint8Array(e)),r=t.length,a=[],i=0;i+3<r;){var n=t[i],o=t[i+1];if(255===n&&218===o)break;255===n&&216===o?i+=2:(n=i+(256*t[i+2]+t[i+3])+2,o=t.slice(i,n),a.push(o),i=n)}return a.reduce(function(e,t){return 255===t[0]&&225===t[1]?e.concat(t):e},[])})(e)),t.url=i||n?!P||1<r?A(e,a):P.createObjectURL(l):e,o.load(t)},e.onabort=function(){o.fail(new Error("Aborted to read the image with FileReader."))},e.onerror=function(){o.fail(new Error("Failed to read the image with FileReader."))},e.onloadend=function(){o.reader=null},i||n?e.readAsArrayBuffer(l):e.readAsDataURL(l)):this.load({url:P.createObjectURL(l)})):this.fail(new Error("The current browser does not support image compression.")):this.fail(new Error("The first argument must be an image File or Blob object.")):this.fail(new Error("The first argument must be a File or Blob object."))}},{key:"load",value:function(e){var t=this,r=this.file,a=this.image;a.onload=function(){(()=>{try{var e,t,r,a=document.createElement("canvas"),i=(a.width=2,a.height=1,a.getContext("2d"));if(i)return(e=i.createImageData(2,1)).data[0]=12,e.data[1]=23,e.data[2]=34,e.data[3]=255,e.data[4]=45,e.data[5]=56,e.data[6]=67,e.data[7]=255,i.putImageData(e,0,0),t=i.getImageData(0,0,2,1),r=[12,23,34,255,45,56,67,255],t.data.every(function(e,t){return e===r[t]})}catch(e){}})()?t.draw(n(n({},e),{},{naturalWidth:a.naturalWidth,naturalHeight:a.naturalHeight})):t.done({naturalWidth:a.naturalWidth,naturalHeight:a.naturalHeight,result:null})},a.onabort=function(){t.fail(new Error("Aborted to load the image."))},a.onerror=function(){t.fail(new Error("Failed to load the image."))},b.navigator&&/(?:iPad|iPhone|iPod).*?AppleWebKit/i.test(b.navigator.userAgent)&&(a.crossOrigin="anonymous"),a.alt=r.name,a.src=e.url}},{key:"draw",value:function(e){var i=this,n=e.naturalWidth,o=e.naturalHeight,t=e.rotate,t=void 0===t?0:t,r=e.scaleX,r=void 0===r?1:r,e=e.scaleY,e=void 0===e?1:e,a=this.file,l=this.image,s=this.options,c=document.createElement("canvas"),u=c.getContext("2d"),h=Math.abs(t)%180==90,f=("contain"===s.resize||"cover"===s.resize)&&O(s.width)&&O(s.height),d=Math.max(s.maxWidth,0)||1/0,m=Math.max(s.maxHeight,0)||1/0,p=Math.max(s.minWidth,0)||0,g=Math.max(s.minHeight,0)||0,b=n/o,y=s.width,w=s.height,v=(h&&(d=(v=[m,d])[0],m=v[1],p=(v=[g,p])[0],g=v[1],y=(v=[w,y])[0],w=v[1]),k({aspectRatio:b=f?y/w:b,width:d,height:m},"contain")),v=(d=v.width,m=v.height,k({aspectRatio:b,width:p,height:g},"cover")),v=(p=v.width,g=v.height,w=f?(y=(v=k({aspectRatio:b,width:y,height:w},s.resize)).width,v.height):(y=void 0===(B=(v=k({aspectRatio:b,width:y,height:w})).width)?n:B,void 0===(B=v.height)?o:B),-(y=Math.floor(E(Math.min(Math.max(y,p),d))))/2),B=-(w=Math.floor(E(Math.min(Math.max(w,g),m))))/2,p=y,d=w,g=[],m=(f&&(0,m=(b=k({aspectRatio:b,width:m=n,height:f=o},{contain:"cover",cover:"contain"}[s.resize])).width,g.push((n-m)/2,(o-(f=b.height))/2,m,f)),g.push(v,B,p,d),h&&(y=(b=[w,y])[0],w=b[1]),c.width=y,c.height=w,T(s.mimeType)||(s.mimeType=a.type),"transparent"),U=(a.size>s.convertSize&&0<=s.convertTypes.indexOf(s.mimeType)&&(s.mimeType="image/jpeg"),"image/jpeg"===s.mimeType);u.fillStyle=m=U?"#fff":m,u.fillRect(0,0,y,w),s.beforeDraw&&s.beforeDraw.call(this,u,c),this.aborted||(u.save(),u.translate(y/2,w/2),u.rotate(t*Math.PI/180),u.scale(r,e),u.drawImage.apply(u,[l].concat(g)),u.restore(),s.drew&&s.drew.call(this,u,c),this.aborted)||(f=function(e){var a,t,r;i.aborted||(a=function(e){return i.done({naturalWidth:n,naturalHeight:o,result:e})},e&&U&&s.retainExif&&i.exif&&0<i.exif.length?(t=function(e){return a(x(A((e=e,t=i.exif,255!==(r=j(new Uint8Array(e)))[2]||224!==r[3]?e:(e=[255,216].concat(t,r.slice(4+(256*r[4]+r[5]))),new Uint8Array(e))),s.mimeType)));var t,r},e.arrayBuffer?e.arrayBuffer().then(t).catch(function(){i.fail(new Error("Failed to read the compressed image with Blob.arrayBuffer()."))}):(r=new M,(i.reader=r).onload=function(e){e=e.target;t(e.result)},r.onabort=function(){i.fail(new Error("Aborted to read the compressed image with FileReader."))},r.onerror=function(){i.fail(new Error("Failed to read the compressed image with FileReader."))},r.onloadend=function(){i.reader=null},r.readAsArrayBuffer(e))):a(e))},c.toBlob?c.toBlob(f,s.mimeType,s.quality):f(x(c.toDataURL(s.mimeType,s.quality))))}},{key:"done",value:function(t){var e=t.naturalWidth,r=t.naturalHeight,t=t.result,a=this.file,i=this.image,n=this.options;if(P&&0===i.src.indexOf("blob:")&&P.revokeObjectURL(i.src),t)if(n.strict&&!n.retainExif&&t.size>a.size&&n.mimeType===a.type&&!(n.width>e||n.height>r||n.minWidth>e||n.minHeight>r||n.maxWidth<e||n.maxHeight<r))t=a;else{i=a.name;i&&t.type!==a.type&&(i=i.replace(L,(e=T(e=t.type)?e.substr(6):"",".".concat(e="jpeg"===e?"jpg":e))));try{t=new File([t],i,{type:t.type})}catch(e){r=new Date;t.name=i,t.lastModified=r.getTime(),t.lastModifiedDate=r}}else t=a;this.result=t,n.success&&n.success.call(this,t)}},{key:"fail",value:function(e){var t=this.options;if(!t.error)throw e;t.error.call(this,e)}},{key:"abort",value:function(){this.aborted||(this.aborted=!0,this.reader?this.reader.abort():this.image.complete?this.fail(new Error("The compression process has been aborted.")):(this.image.onload=null,this.image.onabort()))}}])&&a(e.prototype,t),r&&a(e,r),Object.defineProperty(e,"prototype",{writable:!1}),e;var e,t,r})()});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "compressorjs",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "JavaScript image compressor.",
   "main": "dist/compressor.common.js",
   "module": "dist/compressor.esm.js",
@@ -19,7 +19,7 @@
     "lint": "npm run lint:js && npm run lint:css",
     "lint:css": "stylelint docs/**/*.css --fix",
     "lint:js": "eslint src test *.js --fix",
-    "prepare": "husky install",
+    "prepare": "simple-git-hooks",
     "release": "npm run clean && npm run lint && npm run build && npm run compress && npm test",
     "start": "npm run dev",
     "test": "cross-env NODE_ENV=test karma start test/karma.conf.js"
@@ -53,16 +53,16 @@
     "is-blob": "^2.1.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.29.0",
-    "@babel/plugin-transform-object-assign": "^7.27.1",
-    "@babel/preset-env": "^7.29.2",
+    "@babel/core": "^7.29.7",
+    "@babel/plugin-transform-object-assign": "^7.29.7",
+    "@babel/preset-env": "^7.29.7",
     "@commitlint/cli": "^17.8.1",
     "@commitlint/config-conventional": "^17.8.1",
-    "@rollup/plugin-babel": "^5.3.1",
-    "@rollup/plugin-commonjs": "^21.1.0",
-    "@rollup/plugin-node-resolve": "^13.3.0",
-    "@rollup/plugin-replace": "^3.1.0",
-    "babel-plugin-istanbul": "^6.1.1",
+    "@rollup/plugin-babel": "^6.1.0",
+    "@rollup/plugin-commonjs": "^26.0.3",
+    "@rollup/plugin-node-resolve": "^15.3.1",
+    "@rollup/plugin-replace": "^6.0.3",
+    "babel-plugin-istanbul": "^7.0.1",
     "chai": "^4.5.0",
     "change-case": "^4.1.2",
     "codecov": "^3.8.3",
@@ -72,7 +72,6 @@
     "eslint": "^8.57.1",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.32.0",
-    "husky": "^8.0.3",
     "karma": "^6.4.4",
     "karma-chai": "^0.1.0",
     "karma-chrome-launcher": "^3.2.0",
@@ -83,7 +82,8 @@
     "lint-staged": "^13.3.0",
     "mocha": "^10.8.2",
     "puppeteer": "^19.11.1",
-    "rollup": "^2.80.0",
+    "rollup": "^3.30.0",
+    "simple-git-hooks": "^2.13.1",
     "stylelint": "^15.11.0",
     "stylelint-config-standard": "^30.0.1",
     "stylelint-order": "^6.0.4",

package/src/defaults.js

@@ -1,20 +1,20 @@
 export default {
   /**
-   * Indicates if output the original image instead of the compressed one
+   * Indicates whether to output the original image instead of the compressed one
    * when the size of the compressed image is greater than the original one's
    * @type {boolean}
    */
   strict: true,
 
   /**
-   * Indicates if read the image's Exif Orientation information,
+   * Indicates whether to read the image's Exif Orientation information,
    * and then rotate or flip the image automatically.
    * @type {boolean}
    */
   checkOrientation: true,
 
   /**
-   * Indicates if retain the image's Exif information after compressed.
+   * Indicates whether to retain the image's Exif information after compression.
    * @type {boolean}
   */
   retainExif: false,
@@ -83,7 +83,7 @@ export default {
   /**
    * Files whose file type is included in this list,
    * and whose file size exceeds the `convertSize` value will be converted to JPEGs.
-   * @type {string｜Array}
+   * @type {string|string[]}
    */
   convertTypes: ['image/png'],
 
@@ -95,9 +95,9 @@ export default {
   convertSize: 5000000,
 
   /**
-   * The hook function to execute before draw the image into the canvas for compression.
+   * The hook function to execute before drawing the image into the canvas for compression.
    * @type {Function}
-   * @param {CanvasRenderingContext2D} context - The 2d rendering context of the canvas.
+   * @param {CanvasRenderingContext2D} context - The 2D rendering context of the canvas.
    * @param {HTMLCanvasElement} canvas - The canvas for compression.
    * @example
    * function (context, canvas) {
@@ -107,9 +107,9 @@ export default {
   beforeDraw: null,
 
   /**
-   * The hook function to execute after drew the image into the canvas for compression.
+   * The hook function to execute after drawing the image into the canvas for compression.
    * @type {Function}
-   * @param {CanvasRenderingContext2D} context - The 2d rendering context of the canvas.
+   * @param {CanvasRenderingContext2D} context - The 2D rendering context of the canvas.
    * @param {HTMLCanvasElement} canvas - The canvas for compression.
    * @example
    * function (context, canvas) {
@@ -119,7 +119,7 @@ export default {
   drew: null,
 
   /**
-   * The hook function to execute when success to compress the image.
+   * The hook function to execute when the image is compressed successfully.
    * @type {Function}
    * @param {File} file - The compressed image File object.
    * @example

package/src/index.js

@@ -29,11 +29,11 @@ const AnotherCompressor = WINDOW.Compressor;
  */
 export default class Compressor {
   /**
-   * The constructor of Compressor.
-   * @param {File|Blob} file - The target image file for compressing.
-   * @param {Object} [options] - The options for compressing.
+   * Create a new Compressor.
+   * @param {File|Blob} file - The target image file to compress.
+   * @param {Object} [options={}] - The configuration options.
    */
-  constructor(file, options) {
+  constructor(file, options = {}) {
     this.file = file;
     this.exif = [];
     this.image = new Image();
@@ -451,12 +451,13 @@ export default class Compressor {
   }
 
   /**
-   * Get the no conflict compressor class.
-   * @returns {Compressor} The compressor class.
+   * Creates a new Compressor instance.
+   * @param {File|Blob} file - The target image file to compress.
+   * @param {Object} [options={}] - The configuration options.
+   * @returns {Compressor} A new Compressor instance.
    */
-  static noConflict() {
-    window.Compressor = AnotherCompressor;
-    return Compressor;
+  static create(file, options) {
+    return new Compressor(file, options);
   }
 
   /**
@@ -466,4 +467,13 @@ export default class Compressor {
   static setDefaults(options) {
     Object.assign(DEFAULTS, options);
   }
+
+  /**
+   * Get the no conflict compressor class.
+   * @returns {Compressor} The compressor class.
+   */
+  static noConflict() {
+    window.Compressor = AnotherCompressor;
+    return Compressor;
+  }
 }

package/src/utilities.js

@@ -21,9 +21,9 @@ export function toArray(value) {
 const REGEXP_IMAGE_TYPE = /^image\/.+$/;
 
 /**
- * Check if the given value is a mime type of image.
+ * Check if the given value is an image MIME type.
  * @param {*} value - The value to check.
- * @returns {boolean} Returns `true` if the given is a mime type of image, else `false`.
+ * @returns {boolean} Returns `true` if the given value is an image MIME type, else `false`.
  */
 export function isImageType(value) {
   return REGEXP_IMAGE_TYPE.test(value);
@@ -32,7 +32,7 @@ export function isImageType(value) {
 /**
  * Convert image type to extension.
  * @param {string} value - The image type to convert.
- * @returns {boolean} Returns the image extension.
+ * @returns {string} Returns the image extension.
  */
 export function imageTypeToExtension(value) {
   let extension = isImageType(value) ? value.substr(6) : '';
@@ -68,7 +68,7 @@ export function getStringFromCharCode(dataView, start, length) {
 
 /**
  * Check if `canvas.getContext('2d').getImageData` is available,
- * FireFox randomizes the output of that function in `privacy.resistFingerprinting` mode (#137)
+ * Firefox randomizes the output of that function in `privacy.resistFingerprinting` mode (#137)
  * @link https://github.com/nodeca/pica/blob/master/lib/utils.js
  * @returns {boolean} Returns `true` if it is available, else `false`.
  */
@@ -117,7 +117,7 @@ const { btoa } = WINDOW;
 /**
  * Transform array buffer to Data URL.
  * @param {ArrayBuffer} arrayBuffer - The array buffer to transform.
- * @param {string} mimeType - The mime type of the Data URL.
+ * @param {string} mimeType - The MIME type of the Data URL.
  * @returns {string} The result Data URL.
  */
 export function arrayBufferToDataURL(arrayBuffer, mimeType) {

package/types/index.d.ts

@@ -1,5 +1,7 @@
 declare namespace Compressor {
-  export interface Options {
+  type ResizeMode = 'contain' | 'cover' | 'none';
+
+  interface Options {
     strict?: boolean;
     checkOrientation?: boolean;
     retainExif?: boolean;
@@ -9,22 +11,23 @@ declare namespace Compressor {
     minHeight?: number;
     width?: number;
     height?: number;
-    resize?: 'contain' | 'cover' | 'none';
+    resize?: ResizeMode;
     quality?: number;
     mimeType?: string;
     convertTypes?: string | string[];
     convertSize?: number;
-    beforeDraw?(context: CanvasRenderingContext2D, canvas: HTMLCanvasElement): void;
-    drew?(context: CanvasRenderingContext2D, canvas: HTMLCanvasElement): void;
-    success?(file: File | Blob): void;
-    error?(error: Error): void;
+    beforeDraw?: ((this: Compressor, context: CanvasRenderingContext2D, canvas: HTMLCanvasElement) => void) | null;
+    drew?: ((this: Compressor, context: CanvasRenderingContext2D, canvas: HTMLCanvasElement) => void) | null;
+    success?: ((this: Compressor, file: File) => void) | null;
+    error?: ((this: Compressor, error: Error) => void) | null;
   }
 }
 
 declare class Compressor {
   constructor(file: File | Blob, options?: Compressor.Options);
   abort(): void;
-  static noConflict(): Compressor;
+  static create(file: File | Blob, options?: Compressor.Options): Compressor;
+  static noConflict(): typeof Compressor;
   static setDefaults(options: Compressor.Options): void;
 }