compressorjs 1.2.1 → 1.4.0

package/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright 2018-present Chen Fengyuan
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright 2018-present Chen Fengyuan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -2,23 +2,23 @@
 
 [![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 [canvas.toBlob](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob) API 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](#main)
-- [Getting started](#getting-started)
+- [Main Files](#main-files)
+- [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)
 
-## Main
+## Main Files
 
 ```text
 dist/
@@ -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,9 +208,9 @@ 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 [canvas.toBlob](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob) for more detail.
+> Check out the documentation of the [HTMLCanvasElement.toBlob()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob) method for more detail.
 
 **Examples**:
 
@@ -222,19 +228,24 @@ The quality of the output image. It must be a number between `0` and `1`. If thi
 
 - Type: `string`
 - Default: `'auto'`
+- Options: `"auto"`, `"image/png"`, `"image/jpeg"`, and `"image/webp"`.
 
 The mime type of the output image. By default, the original mime type of the source image file will be used.
 
+> **Note:** Safari does not support `mimeType` conversion to `"image/webp"`. For more details, see the [browser compatibility of the `HTMLCanvasElement.toBlob()` method](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob#browser_compatibility).
+
 ### convertTypes
 
 - Type: `Array` or `string` (multiple types should be separated by commas)
-- Default: `['image/png']`
+- Default: `["image/png"]`
 - Examples:
-  - `['image/png', 'image/webp']`
-  - `'image/png,image/webp'`
+  - `["image/png", "image/webp"]`
+  - `"image/png,image/webp"`
 
 Files whose file type is included in this list, and whose file size exceeds the `convertSize` value will be converted to JPEGs.
 
+> For image file type support, see the [Image file type and format guide](https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types).
+
 ### convertSize
 
 - Type: `number`
@@ -258,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, {
@@ -278,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, {
@@ -295,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)
 
@@ -306,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)
 
@@ -323,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.
 
@@ -336,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)