compress-images Minify size your images. Image compression with extension: jpg/jpeg, svg, png, gif.
Minify size your images. Image compression with extension: jpg/jpeg
, svg
, png
, gif
.
You can use different algorithms and methods for compress images with many options.
- For JPG:
jpegtran
,mozjpeg
,webp
,guetzli
,jpegRecompress
,jpegoptim
,tinify
; - For PNG:
pngquant
,optipng
,pngout
,webp
,pngcrush
,tinify
; - For SVG:
svgo
; - For GIF:
gifsicle
,giflossy
,gif2webp
;
You even can minify images with use combine algorithms compress images. As example -
mozjpeg
+jpegoptim
orjpegtran
+mozjpeg
or any other algorithm.
If you got error, will be save log of error. Default path
./log/compress-images
.
If you get error, can be used alternative algorithm compressing images. As example: you want to compress images in
jpegRecompress
, but got an error Unsupported color conversion request, and then will be used alternative algorithm compress images inmozjpeg
.
You can specify the path to source images folder and all images in the folder will be compression and moved to output folder.
As an example, one of many:
INPUT ['src/img/source/**/*.{jpg,JPG,jpeg,JPEG,gif,png,svg}']
OUTPUT ['build/img/']
npm install compress-images --save-dev
https://github.com/semiromid/compress-images/tree/master/example
- Read to Manual
var compress_images = require('compress-images'), INPUT_path_to_your_images, OUTPUT_path;
INPUT_path_to_your_images = 'src/img/**/*.{jpg,JPG,jpeg,JPEG,png,svg,gif}';
OUTPUT_path = 'build/img/';
compress_images(INPUT_path_to_your_images, OUTPUT_path, {compress_force: false, statistic: true, autoupdate: true}, false,
{jpg: {engine: 'mozjpeg', command: ['-quality', '60']}},
{png: {engine: 'pngquant', command: ['--quality=20-50']}},
{svg: {engine: 'svgo', command: '--multipass'}},
{gif: {engine: 'gifsicle', command: ['--colors', '64', '--use-col=web']}}, function(){
});
var compress_images = require('compress-images');
function MyFun(){
compress_images('src/img/**/*.{jpg,JPG,jpeg,JPEG,png,svg,gif}', 'build/img/', {compress_force: false, statistic: true, autoupdate: true}, false,
{jpg: {engine: 'mozjpeg', command: ['-quality', '60']}},
{png: {engine: 'pngquant', command: ['--quality=20-50']}},
{svg: {engine: 'svgo', command: '--multipass'}},
{gif: {engine: 'gifsicle', command: ['--colors', '64', '--use-col=web']}}, function(err, completed){
if(completed === true){
// Doing something.
}
});
}
var gulp = require('gulp');
var compress_images = require('compress-images');
// We will be compress images [jpg] with two algorithms, [webp] and [jpg];
// gulp compress_images
gulp.task('compress_images', function() {
//[jpg] ---to---> [webp]
compress_images('src/img/**/*.{jpg,JPG,jpeg,JPEG}', 'build/img/', {compress_force: false, statistic: true, autoupdate: true}, false,
{jpg: {engine: 'webp', command: false}},
{png: {engine: false, command: false}},
{svg: {engine: false, command: false}},
{gif: {engine: false, command: false}}, function(err){
if(err === null){
//[jpg] ---to---> [jpg(jpegtran)] WARNING!!! autoupdate - recommended turn off, he is not needed here - autoupdate: false
compress_images('src/img/**/*.{jpg,JPG,jpeg,JPEG}', 'build/img/', {compress_force: false, statistic: true, autoupdate: false}, false,
{jpg: {engine: 'jpegtran', command: false}},
{png: {engine: false, command: false}},
{svg: {engine: false, command: false}},
{gif: {engine: false, command: false}}, function(){
});
}else{
console.error(err);
}
});
});
var gulp = require('gulp');
var compress_images = require('compress-images');
// Combine compressing images [jpg] with two different algorithms, [jpegtran] and [mozjpeg];
// gulp compress_images
gulp.task('compress_images', function() {
//[jpg] ---to---> [jpg(jpegtran)]
compress_images('src/img/source/**/*.{jpg,JPG,jpeg,JPEG}', 'src/img/combination/', {compress_force: false, statistic: true, autoupdate: true}, false,
{jpg: {engine: 'jpegtran', command: ['-trim', '-progressive', '-copy', 'none', '-optimize']}},
{png: {engine: false, command: false}},
{svg: {engine: false, command: false}},
{gif: {engine: false, command: false}}, function(){
//[jpg(jpegtran)] ---to---> [jpg(mozjpeg)] WARNING!!! autoupdate - recommended turn off, he is not needed here - autoupdate: false
compress_images('src/img/combination/**/*.{jpg,JPG,jpeg,JPEG}', 'build/img/', {compress_force: false, statistic: true, autoupdate: false}, false,
{jpg: {engine: 'mozjpeg', command: ['-quality', '75']}},
{png: {engine: false, command: false}},
{svg: {engine: false, command: false}},
{gif: {engine: false, command: false}}, function(){
});
});
});
var gulp = require('gulp');
var compress_images = require('compress-images');
//gulp compress_images
gulp.task('compress_images', function() {
//[jpg+gif+png+svg] ---to---> [jpg(webp)+gif(gifsicle)+png(webp)+svg(svgo)]
compress_images('src/img/source/**/*.{jpg,JPG,jpeg,JPEG,gif,png,svg}', 'build/img/', {compress_force: false, statistic: true, autoupdate: true}, false,
{jpg: {engine: 'webp', command: false}},
{png: {engine: 'webp', command: false}},
{svg: {engine: 'svgo', command: false}},
{gif: {engine: 'gifsicle', command: ['--colors', '64', '--use-col=web']}}, function(){
//-------------------------------------------------
//[jpg] ---to---> [jpg(jpegtran)] WARNING!!! autoupdate - recommended turn off, he is not needed here - autoupdate: false
compress_images('src/img/source/**/*.{jpg,JPG,jpeg,JPEG}', 'src/img/combine/', {compress_force: false, statistic: true, autoupdate: false}, false,
{jpg: {engine: 'jpegtran', command: ['-trim', '-progressive', '-copy', 'none', '-optimize']}},
{png: {engine: false, command: false}},
{svg: {engine: false, command: false}},
{gif: {engine: false, command: false}}, function(){
//[jpg(jpegtran)] ---to---> [jpg(mozjpeg)] WARNING!!! autoupdate - recommended turn off, he is not needed here - autoupdate: false
compress_images('src/img/combine/**/*.{jpg,JPG,jpeg,JPEG}', 'build/img/', {compress_force: false, statistic: true, autoupdate: false}, false,
{jpg: {engine: 'mozjpeg', command: ['-quality', '75']}},
{png: {engine: false, command: false}},
{svg: {engine: false, command: false}},
{gif: {engine: false, command: false}}, function(){
//[png] ---to---> [png(pngquant)] WARNING!!! autoupdate - recommended turn off, he is not needed here - autoupdate: false
compress_images('src/img/source/**/*.png', 'build/img/', {compress_force: false, statistic: true, autoupdate: false}, false,
{jpg: {engine: false, command: false}},
{png: {engine: 'pngquant', command: ['--quality=30-60']}},
{svg: {engine: false, command: false}},
{gif: {engine: false, command: false}}, function(){
});
});
});
//-------------------------------------------------
});
});
Sometime you could get errors, and then use alternative configuration "compress-images". As example one of many:
-
If you get error from 'jpegRecompress', as example can be the error "Unsupported color conversion request" In this case will be use alternative image compression.
-
Will be created log of error in path './log/lib/compress-images'.
-
Will be try compress this image in 'mozjpeg'.
var compress_images = require('compress-images');
const INPUT_path_to_your_images = 'src/**/*.{jpg,JPG,jpeg,JPEG,png,svg,gif}';
const OUTPUT_path = 'build/';
compress_images(INPUT_path_to_your_images, OUTPUT_path, {compress_force: false, statistic: true, autoupdate: true, pathLog: './log/lib/compress-images'}, false,
{jpg: {engine: 'jpegRecompress', command: ['--quality', 'high', '--min', '60']}},
{png: {engine: 'pngquant', command: ['--quality=20-50']}},
{svg: {engine: 'svgo', command: '--multipass'}},
{gif: {engine: 'gifsicle', command: ['--colors', '64', '--use-col=web']}}, function(err, completed){
if(err !== null){
//---------------------------------------
//if you get an ERROR from 'jpegRecompress' ---> We can use alternate config of compression
//---------------------------------------
if(err.engine === 'jpegRecompress'){
compress_images(err.input, err.output, {compress_force: false, statistic: true, autoupdate: true}, false,
{jpg: {engine: 'mozjpeg', command: ['-quality', '60']}},
{png: {engine: false, command: false}},
{svg: {engine: false, command: false}},
{gif: {engine: false, command: false}}, function(err){
if(err !== null){
//Alternative config of compression
}
});
}
//---------------------------------------
}
});
<picture>
<source type="image/webp" srcset="//hostname/build/img/art/1/chat.webp">
<img width="700" height="922" alt="test" src="//hostname/build/img/art/1/chat.jpg">
</picture>
compress_images
(input
, output
, option
, globoption
, enginejpg
, enginepng
, enginesvg
, enginegif
, callback
)
-
input (type:string): Path to source image or images;
Example:
1.'src/img/**/*.{jpg,JPG,jpeg,JPEG,png,svg,gif}'
;
2.'src/img/**/*.jpg'
;
3.'src/img/*.jpg'
;
4.'src/img/myimagename.jpg'
; -
output (type:string): Path to compress images;
Example:
1.'build/img/'
; -
option (type:plainObject): Options module`s «compress-images»;
- compress_force (type:boolean): Force compress images already compressed images
true
orfalse
; - statistic (type:boolean): show image compression statistics
true
orfalse
; - pathLog (type:string): Path to log file. Default is
./log/compress-images
; - autoupdate (type:boolean): Auto-update module «compress_images» to the latest version
true
orfalse
;
Example:
1.{compress_force: false, statistic: true, autoupdate: true}
;
- compress_force (type:boolean): Force compress images already compressed images
-
globoption (type:boolean|other): Options module`s glob. Also you can set
false
; -
enginejpg (type:plainObject): Engine for compress jpeg and options compress. Key to be
jpg
;- engine (type:string): Engine for compress jpeg. Possible values:
jpegtran
,mozjpeg
,webp
,guetzli
,jpegRecompress
,jpegoptim
,tinify
; - command (type:boolean|array): Options compress. Can be
false
or commands array.- For jpegtran -
['-trim', '-progressive', '-copy', 'none', '-optimize']
in details; jpegtran; - For mozjpeg -
['-quality', '10']
in details mozjpeg; - For webp -
['-q', '60']
in details webp; - For guetzli -
['--quality', '84']
(Very long compresses on Win 8.1 google/guetzli#238) in details guetzli; - For jpegRecompress -
['--quality', 'high', '--min', '60']
in details jpegRecompress; - For jpegoptim -
['--all-progressive', '-d']
Caution! if do not specify'-d'
all images will be compressed on source folder and will be replace. (Maybe problem on Win 8.1: tjko/jpegoptim#54)) In details jpegoptim; - For tinify -
['copyright', 'creation', 'location']
In details tinify;
- For jpegtran -
- key (type:string): Key which using for engine tinify. In details; tinify;
Example:
1.{jpg: {engine: 'mozjpeg', command: ['-quality', '60']}
;
2.{jpg: {engine: 'tinify', key: "sefdfdcv335fxgfe3qw", command: ['copyright', 'creation', 'location']}}
;
3.{jpg: {engine: 'tinify', key: "sefdfdcv335fxgfe3qw", command: false}}
;
- engine (type:string): Engine for compress jpeg. Possible values:
-
enginepng (type:plainObject): Engine for compress png and options compress. Key to be
png
;- engine (type:string): Engine for compress png. Possible values:
pngquant
,optipng
,pngout
,webp
,pngcrush
,tinify
; - command (type:boolean|array): Options compress. Can be
false
or commands array.- For pngquant -
['--quality=20-50']
- Quality should be in format min-max where min and max are numbers in range 0-100. In details pngquant; - For optipng - in details optipng;
- For pngout - in details pngout;
- For webp -
['-q', '60']
in details webp; - For pngcrush -
['-reduce', '-brute']
in details pngcrush; - For tinify -
['copyright', 'creation', 'location']
in details tinify;
- For pngquant -
- key (type:string): Key which using for engine tinify. In details; tinify;
Example:
1.{png: {engine: 'webp', command: ['-q', '100']}
;
2.{png: {engine: 'tinify', key: "sefdfdcv335fxgfe3qw", command: ['copyright', 'creation', 'location']}}
;
3.{png: {engine: 'optipng', command: false}}
;
- engine (type:string): Engine for compress png. Possible values:
-
enginesvg (type:plainObject): Engine for compress svg and options compress. Key to be
svg
;- engine (type:string): Engine for compress svg. Possible values:
svgo
; - command (type:string): Options compress. Can be
false
or commands type string.- For svgo -
'--multipass'
in details svgo;
Example:
1.{svg: {engine: 'svgo', command: '--multipass'}
;
2.{svg: {engine: 'svgo', command: false}}
;
- For svgo -
- engine (type:string): Engine for compress svg. Possible values:
-
enginegif (type:plainObject): Engine for compress gif and options compress. Key to be
gif
;- engine (type:string): Engine for compress gif. Possible values:
gifsicle
,giflossy
,gif2webp
; - command (type:boolean|array): Options compress. Can be
false
or commands type array.- For gifsicle -
['--colors', '64', '--use-col=web']
or['--optimize']
In details gifsicle; - For giflossy - (For Linux x64 and Mac OS X)
['--lossy=80']
In details giflossy; - For gif2webp -
['-f', '80', '-mixed', '-q', '30', '-m', '2']
in details gif2webp;
Example:
1.{gif: {engine: 'gifsicle', command: ['--colors', '64', '--use-col=web', '--scale', ' 0.8']}}
;
2.{gif: {engine: 'giflossy', command: false}}
;
3.{gif: {engine: 'gif2webp', command: ['-f', '80', '-mixed', '-q', '30', '-m', '2']}}
;
- For gifsicle -
- engine (type:string): Engine for compress gif. Possible values:
-
callback (err, completed): returns:
- err (type:object|null)
- engine - The name of the algorithm engine
- input - The path to the input image
- output - The path to the output image
- completed (type:boolean)
true
- result completed.false
- result do not complete.
- err (type:object|null)
If for you is useful thing, support the project.
PayPal | https://www.paypal.com/myaccount/transfer/send [email protected]
Visa Card | 4731 1856 1426 6432
First name and Last name: SEMINA TAMARA
or SEMINA TAMARA PETROVNA
Payeer | payeer.com No.[P77135727
]
PaYoneer | https://www.payoneer.com [email protected]
gif2webp https://developers.google.com/speed/webp/docs/gif2webp author is Google;
Node package giflossy https://www.npmjs.com/package/giflossy Author is Jihchi;
gifsicle and giflossy http://www.lcdf.org/gifsicle/ author is Eddie Kohler;
gifsicle-bin https://github.com/imagemin/gifsicle-bin author is Kevva;
svgo https://www.npmjs.com/package/svgo author is Greli;
pngcrush https://pmt.sourceforge.io/pngcrush/ author is Glenn Randers-Pehrson;
pngcrush-bin https://github.com/imagemin/pngcrush-bin author is Kevva;
webp https://developers.google.com/speed/webp/ author is Google;
pngout http://advsys.net/ken/util/pngout.htm author is Kerry Watson, with updates by Ken Silverman and Matthew Fearnley;
pngout-bin https://github.com/imagemin/pngout-bin author is 1000ch;
pngquant https://pngquant.org/ author is Kornel Lesiński and contributors. It's based on code by Greg Roelofs and Jef Poskanzer;
pngquant-bin https://github.com/imagemin/pngquant-bin author is Kevva;
tinypng https://tinypng.com/developers/reference/nodejs author is Voormedia;
tinyjpg https://tinyjpg.com/ author is Voormedia;
jpegoptim https://github.com/tjko/jpegoptim author is Tjko;
jpegoptim-bin https://github.com/imagemin/jpegoptim-bin author is 1000ch;
jpeg-archive https://github.com/danielgtaylor/jpeg-archive author is Danielgtaylor;
jpeg-recompress-bin https://github.com/imagemin/jpeg-recompress-bin author is 1000ch;
guetzli https://github.com/google/guetzli author is Google;
guetzli-bin https://github.com/imagemin/guetzli-bin author is 1000ch;
mozjpeg-bin https://github.com/imagemin/mozjpeg-bin author is 1000ch;
mozjpeg https://github.com/mozilla/mozjpeg author is Pornel;
jpegtran-bin https://github.com/imagemin/jpegtran-bin author is 1000ch;
libjpeg-turbo https://libjpeg-turbo.org/ author is Dcommander;
Vectors https://www.flaticon.com/authors/vectors-market author is Vectors Market;
colors https://www.npmjs.com/package/colors author is Marak;
glob https://www.npmjs.com/package/glob author is Isaacs;
mkdirp https://www.npmjs.com/package/mkdirp author is Substack;
bytes https://www.npmjs.com/package/bytes author is Dougwilson;
SEMINA TAMARA
MIT License
Copyright (c) 2017 TAMARA SEMINA
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.