compressorjs
Advanced tools
Compressorjs is a JavaScript library that allows you to compress images in the browser. It is useful for reducing the size of images before uploading them to a server, which can save bandwidth and improve performance.
Image Compression
This feature allows you to compress an image file by specifying the quality of the output image. The 'success' callback provides the compressed image file, while the 'error' callback handles any errors that occur during compression.
const compressor = new Compressor(file, {
quality: 0.6,
success(result) {
console.log(result);
},
error(err) {
console.error(err.message);
},
});Resize Image
This feature allows you to resize an image by specifying the maximum width and height. The 'success' callback provides the resized image file, while the 'error' callback handles any errors that occur during resizing.
const compressor = new Compressor(file, {
maxWidth: 800,
maxHeight: 600,
success(result) {
console.log(result);
},
error(err) {
console.error(err.message);
},
});Convert Image Format
This feature allows you to convert the image format by specifying the desired MIME type. The 'success' callback provides the converted image file, while the 'error' callback handles any errors that occur during conversion.
const compressor = new Compressor(file, {
mimeType: 'image/jpeg',
success(result) {
console.log(result);
},
error(err) {
console.error(err.message);
},
});browser-image-compression is a JavaScript library that provides similar functionalities for compressing images in the browser. It offers more control over the compression process, including options for resizing and rotating images. Compared to compressorjs, it has a more extensive API and additional features like EXIF data preservation.
image-compressor is another JavaScript library for compressing images in the browser. It focuses on simplicity and ease of use, making it a good choice for basic image compression tasks. However, it lacks some of the advanced features found in compressorjs, such as format conversion and detailed error handling.
pica is a high-quality image resizing library that also supports image compression. It is known for its speed and accuracy, making it suitable for applications that require high-performance image processing. While it offers excellent resizing capabilities, it may not be as straightforward to use for basic compression tasks compared to compressorjs.
JavaScript image compressor. Uses the Browser's native canvas.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.
dist/
├── compressor.js (UMD)
├── compressor.min.js (UMD, compressed)
├── compressor.common.js (CommonJS, default)
└── compressor.esm.js (ES Module)
npm install compressorjs
new Compressor(file[, options])
file
The target image file for compressing.
options
ObjectThe options for compressing. Check out the available options.
<input type="file" id="file" accept="image/*">
import axios from 'axios';
import Compressor from 'compressorjs';
document.getElementById('file').addEventListener('change', (e) => {
const file = e.target.files[0];
if (!file) {
return;
}
new Compressor(file, {
quality: 0.6,
// The compression process is asynchronous,
// which means you have to access the `result` in the `success` hook function.
success(result) {
const formData = new FormData();
// The third parameter is required for server
formData.append('file', result, result.name);
// Send the compressed image file to server with XMLHttpRequest.
axios.post('/path/to/upload', formData).then(() => {
console.log('Upload success');
});
},
error(err) {
console.log(err.message);
},
});
});
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).
booleantrueIndicates 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, except the following cases:
retainExif option is set to true.mimeType option is set and its value is different from the mime type of the image.width option is set and its value is greater than the natural width of the image.height option is set and its value is greater than the natural height of the image.minWidth option is set and its value is greater than the natural width of the image.minHeight option is set and its value is greater than the natural height of the image.maxWidth option is set and its value is less than the natural width of the image.maxHeight option is set and its value is less than the natural height of the image.booleantrueIndicates whether to read the image's Exif Orientation value (JPEG image only), and then rotate or flip the image automatically with the value.
Notes:
booleanfalseIndicates whether to retain the image's Exif information after compressed.
numberInfinityThe max-width of the output image. The value should be greater than 0.
Avoid getting a blank output image, you might need to set the
maxWidthandmaxHeightoptions to limited numbers, because of the size limits of a canvas element, recommend to use4096or lesser.
numberInfinityThe max height of the output image. The value should be greater than 0.
number0The min-width of the output image. The value should be greater than 0 and should not be greater than the maxWidth.
number0The min-height of the output image. The value should be greater than 0 and should not be greater than the maxHeight.
numberundefinedThe width of the output image. If not specified, the natural width of the original image will be used, or if the height option is set, the width will be computed automatically by the natural aspect ratio.
numberundefinedThe height of the output image. If not specified, the natural height of the original image will be used, or if the width option is set, the height will be computed automatically by the natural aspect ratio.
string"none""none", "contain", and "cover".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.
number0.8The 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.
Check out canvas.toBlob for more detail.
Examples:
| Quality | Input size | Output size | Compression ratio | Description |
|---|---|---|---|---|
| 0 | 2.12 MB | 114.61 KB | 94.72% | - |
| 0.2 | 2.12 MB | 349.57 KB | 83.90% | - |
| 0.4 | 2.12 MB | 517.10 KB | 76.18% | - |
| 0.6 | 2.12 MB | 694.99 KB | 67.99% | Recommend |
| 0.8 | 2.12 MB | 1.14 MB | 46.41% | Recommend |
| 1 | 2.12 MB | 2.12 MB | 0% | Not recommend |
| NaN | 2.12 MB | 2.01 MB | 5.02% | - |
string'auto'The mime type of the output image. By default, the original mime type of the source image file will be used.
Array or string (multiple types should be separated by commas)['image/png']['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.
number5000000 (5 MB)Files whose file type is included in the convertTypes list, and whose file size exceeds this value will be converted to JPEGs. To disable this, just set the value to Infinity.
Examples:
| convertSize | Input size (type) | Output size (type) | Compression ratio |
|---|---|---|---|
| 5 MB | 1.87 MB (PNG) | 1.87 MB (PNG) | 0% |
| 5 MB | 5.66 MB (PNG) | 450.24 KB (JPEG) | 92.23% |
| 5 MB | 9.74 MB (PNG) | 883.89 KB (JPEG) | 91.14% |
Functionnullcontext: 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.
new Compressor(file, {
beforeDraw(context, canvas) {
context.fillStyle = '#fff';
context.fillRect(0, 0, canvas.width, canvas.height);
context.filter = 'grayscale(100%)';
},
});
Functionnullcontext: 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.
new Compressor(file, {
drew(context, canvas) {
context.fillStyle = '#fff';
context.font = '2rem serif';
context.fillText('watermark', 20, canvas.height - 20);
},
});
Functionnullresult: The compressed image (a File (read only) or Blob object).The hook function to execute when successful to compress the image.
Functionnullerr: The compression error (an Error object).The hook function executes when fails to compress the image.
Abort the compression process.
const compressor = new Compressor(file);
// Do something...
compressor.abort();
If you have to use another compressor with the same namespace, just call the Compressor.noConflict static method to revert to it.
<script src="other-compressor.js"></script>
<script src="compressor.js"></script>
<script>
Compressor.noConflict();
// Code that uses other `Compressor` can follow here.
</script>
Please read through our contributing guidelines.
Maintained under the Semantic Versioning guidelines.
FAQs
JavaScript image compressor.
The npm package compressorjs receives a total of 157,496 weekly downloads. As such, compressorjs popularity was classified as popular.
We found that compressorjs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.