https://github.com/hackplan/imagemin-oxipng
OxiPNG plugin for Imagemin
https://github.com/hackplan/imagemin-oxipng
Last synced: about 1 year ago
JSON representation
OxiPNG plugin for Imagemin
- Host: GitHub
- URL: https://github.com/hackplan/imagemin-oxipng
- Owner: HackPlan
- License: mit
- Created: 2020-08-03T13:30:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T16:50:16.000Z (about 3 years ago)
- Last Synced: 2025-01-28T15:30:43.038Z (about 1 year ago)
- Language: JavaScript
- Size: 1.36 MB
- Stars: 1
- Watchers: 7
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# OxiPNG plugin for Imagemin
## Usage
```js
const imagemin = require('imagemin');
const imageminOxipng = require('imagemin-oxipng');
(async () => {
await imagemin(['images/*.png'], {
destination: 'build/images',
plugins: [
imageminOxipng()
]
});
console.log('Images optimized');
})();
```
## API
### imageminOxipng(options?)(input)
Returns `Promise`.
#### options
Type: `object`
##### quality
Type: `number`
Default: `2`
Values: `1` (faster) to `6` (better compression)
Optimization: -o 1 through -o 6, lower is faster, higher is better compression. The default (-o 2) is sufficiently fast on a modern CPU and provides 30-50% compression gains over an unoptimized PNG. -o 4 is 6 times slower than -o 2 but can provide 5-10% extra compression over -o 2. Using any setting higher than -o 4 is unlikely to give any extra compression gains and is not recommended.