imagemin
Advanced tools
Package description
The imagemin npm package is a powerful tool for image compression and optimization. It allows developers to reduce the size of images without losing quality, which can significantly improve the performance of web applications by reducing load times.
Basic Image Compression
This code demonstrates how to use imagemin to compress JPEG and PNG images. The images are taken from the 'images' directory and the compressed versions are saved in the 'build/images' directory. The quality of JPEG images is set to 75, and the quality of PNG images is set between 60% and 80%.
const imagemin = require('imagemin');
const imageminMozjpeg = require('imagemin-mozjpeg');
const imageminPngquant = require('imagemin-pngquant');
(async () => {
const files = await imagemin(['images/*.{jpg,png}'], {
destination: 'build/images',
plugins: [
imageminMozjpeg({quality: 75}),
imageminPngquant({quality: [0.6, 0.8]})
]
});
console.log(files);
})();GIF Optimization
This code demonstrates how to optimize GIF images using imagemin. The GIF images are taken from the 'images' directory and the optimized versions are saved in the 'build/images' directory. The optimization level is set to 3, which is the highest level of optimization.
const imagemin = require('imagemin');
const imageminGifsicle = require('imagemin-gifsicle');
(async () => {
const files = await imagemin(['images/*.gif'], {
destination: 'build/images',
plugins: [
imageminGifsicle({optimizationLevel: 3})
]
});
console.log(files);
})();SVG Optimization
This code demonstrates how to optimize SVG images using imagemin. The SVG images are taken from the 'images' directory and the optimized versions are saved in the 'build/images' directory. The SVGO plugin is configured to keep the viewBox attribute and not to remove IDs.
const imagemin = require('imagemin');
const imageminSvgo = require('imagemin-svgo');
(async () => {
const files = await imagemin(['images/*.svg'], {
destination: 'build/images',
plugins: [
imageminSvgo({
plugins: [
{removeViewBox: false},
{cleanupIDs: false}
]
})
]
});
console.log(files);
})();Sharp is a high-performance image processing library that supports various image formats. It is known for its speed and efficiency, making it a popular choice for image resizing, cropping, and format conversion. Unlike imagemin, which focuses on compression and optimization, sharp provides a broader range of image manipulation functionalities.
Jimp is a pure JavaScript image processing library that does not require any external dependencies. It supports a wide range of image manipulation features, including resizing, cropping, and color adjustments. While imagemin is primarily used for image compression, Jimp offers a more comprehensive set of image editing tools.
Image-webpack-loader is a loader for webpack that optimizes images during the build process. It uses imagemin under the hood but integrates seamlessly with webpack, making it a convenient choice for developers who are already using webpack for their build process. It provides similar functionalities to imagemin but is designed to work specifically within the webpack ecosystem.
Readme
Minify images seamlessly
$ npm install --save imagemin
var Imagemin = require('imagemin');
var imagemin = new Imagemin()
.src('images/*.{gif,jpg,png,svg}')
.dest('build/images')
.use(Imagemin.jpegtran({ progressive: true }));
imagemin.run(function (err, files) {
if (err) {
throw err;
}
console.log(files[0]);
// => { contents: <Buffer 89 50 4e ...> }
});
You can use gulp-rename to rename your files:
var Imagemin = require('imagemin');
var rename = require('gulp-rename');
var imagemin = new Imagemin()
.src('images/foo.png')
.use(rename('bar.png'));
Creates a new Imagemin instance.
Type: Array|Buffer|String
Set the files to be optimized. Takes a buffer, glob string or an array of glob strings as argument.
Type: String
Set the destination folder to where your files will be written. If you don't set any destination no files will be written.
Type: Function
Add a plugin to the middleware stack.
Type: Function
Optimize your files with the given settings.
The callback will return an array of vinyl files in files and a Readable/Writable
stream in stream.
The following plugins are bundled with imagemin:
Compress GIF images.
var Imagemin = require('imagemin');
var imagemin = new Imagemin()
.use(Imagemin.gifsicle({ interlaced: true }));
Compress JPG images.
var Imagemin = require('imagemin');
var imagemin = new Imagemin()
.use(Imagemin.jpegtran({ progressive: true }));
Lossless compression of PNG images.
var Imagemin = require('imagemin');
var imagemin = new Imagemin()
.use(Imagemin.optipng({ optimizationLevel: 3 }));
Lossy compression of PNG images.
var Imagemin = require('imagemin');
var imagemin = new Imagemin()
.use(Imagemin.pngquant());
Compress SVG images.
var Imagemin = require('imagemin');
var imagemin = new Imagemin()
.use(Imagemin.svgo());
$ npm install --global imagemin
$ imagemin --help
Usage
imagemin <file> <directory>
imagemin <file> > <output>
cat <file> | imagemin > <output>
Example
imagemin images/* build
imagemin foo.png > foo-optimized.png
cat foo.png | imagemin > foo-optimized.png
Options
-i, --interlaced Interlace gif for progressive rendering
-o, --optimizationLevel <number> Select an optimization level between 0 and 7
-p, --progressive Lossless conversion to progressive
MIT © imagemin
FAQs
Minify images seamlessly
The npm package imagemin receives a total of 758,965 weekly downloads. As such, imagemin popularity was classified as popular.
We found that imagemin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers 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
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.