https://github.com/imagemin/imagemin-mozjpeg
Imagemin plugin for mozjpeg
https://github.com/imagemin/imagemin-mozjpeg
imagemin imagemin-plugin minify-images mozjpeg
Last synced: 7 months ago
JSON representation
Imagemin plugin for mozjpeg
- Host: GitHub
- URL: https://github.com/imagemin/imagemin-mozjpeg
- Owner: imagemin
- License: mit
- Created: 2014-04-23T11:16:14.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2021-12-17T05:18:17.000Z (almost 4 years ago)
- Last Synced: 2025-04-01T07:53:37.503Z (7 months ago)
- Topics: imagemin, imagemin-plugin, minify-images, mozjpeg
- Language: JavaScript
- Homepage:
- Size: 50.8 KB
- Stars: 253
- Watchers: 12
- Forks: 58
- Open Issues: 24
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# imagemin-mozjpeg
> [Imagemin](https://github.com/imagemin/imagemin) plugin for [mozjpeg](https://github.com/mozilla/mozjpeg)
## Install
```
$ npm install imagemin-mozjpeg
```
## Usage
```js
import imagemin from 'imagemin';
import imageminMozjpeg from 'imagemin-mozjpeg';
(async () => {
await imagemin(['images/*.jpg'], {
destination: 'build/images',
plugins: [
imageminMozjpeg()
]
});
console.log('Images optimized');
})();
```
## API
### imageminMozjpeg(options?)(buffer)
Returns a `Promise`.
#### options
Type: `object`
##### quality
Type: `number`
Compression quality, in range `0` (worst) to `100` (perfect).
##### progressive
Type: `boolean`\
Default: `true`
`false` creates baseline JPEG file.
##### targa
Type: `boolean`\
Default: `false`
Input file is Targa format (usually not needed).
##### revert
Type: `boolean`\
Default: `false`
Revert to standard defaults instead of mozjpeg defaults.
##### fastCrush
Type: `boolean`\
Default: `false`
Disable progressive scan optimization.
##### dcScanOpt
Type: `number`\
Default: `1`
Set DC scan optimization mode.
- `0` One scan for all components
- `1` One scan per component
- `2` Optimize between one scan for all components and one scan for 1st component plus one scan for remaining components
##### trellis
Type: `boolean`\
Default: `true`
[Trellis optimization](https://en.wikipedia.org/wiki/Trellis_quantization).
##### trellisDC
Type: `boolean`\
Default: `true`
Trellis optimization of DC coefficients.
##### tune
Type: `string`\
Default: `hvs-psnr`
Set Trellis optimization method. Available methods: `psnr`, `hvs-psnr`, `ssim`, `ms-ssim`
##### overshoot
Type: `boolean`\
Default: `true`
Black-on-white deringing via overshoot.
##### arithmetic
Type: `boolean`\
Default: `false`
Use [arithmetic coding](https://en.wikipedia.org/wiki/Arithmetic_coding).
##### dct
Type: `string`\
Default: `int`
Set [DCT](https://en.wikipedia.org/wiki/Discrete_cosine_transform) method:
- `int` Use integer DCT
- `fast` Use fast integer DCT (less accurate)
- `float` Use floating-point DCT
##### quantBaseline
Type: `boolean`\
Default: `false`
Use 8-bit quantization table entries for baseline JPEG compatibility.
##### quantTable
Type: `number`
Use predefined quantization table.
- `0` JPEG Annex K
- `1` Flat
- `2` Custom, tuned for MS-SSIM
- `3` ImageMagick table by N. Robidoux
- `4` Custom, tuned for PSNR-HVS
- `5` Table from paper by Klein, Silverstein and Carney
##### smooth
Type: `number`
Set the strength of smooth dithered input. (1...100)
##### maxMemory
Type: `number`
Set the maximum memory to use in kilobytes.
##### sample
Type: `string[]`
Set component sampling factors. Each item should be in the format `HxV`, for example `2x1`.
#### buffer
Type: `buffer`
Buffer to optimize.