Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imagemin/imagemin
[Unmaintained] Minify images seamlessly
https://github.com/imagemin/imagemin
buffer gif imagemin jpg minify nodejs optimization png svg
Last synced: 20 days ago
JSON representation
[Unmaintained] Minify images seamlessly
- Host: GitHub
- URL: https://github.com/imagemin/imagemin
- Owner: imagemin
- License: mit
- Created: 2013-11-04T09:26:16.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2022-07-23T22:31:35.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T11:14:57.781Z (about 1 month ago)
- Topics: buffer, gif, imagemin, jpg, minify, nodejs, optimization, png, svg
- Language: JavaScript
- Homepage:
- Size: 749 KB
- Stars: 5,493
- Watchers: 60
- Forks: 257
- Open Issues: 89
-
Metadata Files:
- Readme: readme.md
- License: license
Lists
- awesome-wpo - Imagemin - Minify images seamlessly with Node.js. (Image Optimizers / Meetups)
- awesome-nodejs - imagemin - Image minifier. (Packages / Minifiers)
- awesome-nodejs-cn - imagemin - Image压缩工具. (目录 / 文件压缩)
- awesome-nodejs-cn - imagemin - Image minifier. (Number / Minifiers)
- awesome-stars - imagemin - Minify images seamlessly (JavaScript)
- awesome-stars - imagemin
- Front-End-Checklist - Imagemin
- Front-End-Checklist - Imagemin
- awesome - imagemin/imagemin - \[Unmaintained] Minify images seamlessly (JavaScript)
- awesome-tools - imagemin - 压缩图片的库，需要引入插件 (图片)
- Front-End-Checklist - Imagemin
- awesome-nodejs - imagemin - Image minifier.  (Repository / Minifiers)
- awesome-nodejs-cn - imagemin - Image 压缩工具 (包 / 代码压缩)
- awesome-wpo-chinese - Imagemin - Minify images seamlessly with Node.js. (Image Optimizers)
- awesome-nodejs-cn - imagemin - Image 压缩工具 (包 / 代码压缩)
- awesome-github-star - imagemin
- awesome-nodejs - imagemin - Image minifier. (Packages / Minifiers)
- awesome-stars - imagemin/imagemin - [Unmaintained] Minify images seamlessly (JavaScript)
- awesome-node - imagemin - Image minifier. (Packages / Minifiers)
- awesome-node.js - imagemin - Image minifier. (Packages / Minifiers)
- awesome-stars - imagemin
- awesome-stars - imagemin - Tense, nervous, minifying images? (JavaScript)
- awesome - imagemin - Minify images seamlessly. (Tools / React Components)
- awesome-nodejs - imagemin - Image minifier. (Packages / Minifiers)
- awesome-nodejs - imagemin - Image 压缩工具。  (GIT 仓库 / 最小化)
- awesome-nodejs - imagemin - Image minifier. (Packages / Minifiers)
- awesome-nodejs-precise - imagemin - square)]() | Image minifier. | (Packages / Minifiers)
- awesome-wpo-dup - Imagemin - Minify images seamlessly with Node.js. (Image Optimizers)
- awesome-stars - imagemin/imagemin - [Unmaintained] Minify images seamlessly (JavaScript)
- awesome-stars - imagemin/imagemin - [Unmaintained] Minify images seamlessly (JavaScript)
- awesome-stars - imagemin
- awesome-nodejs - imagemin - Tense, nervous, minifying images? - ★ 2584 (Minifiers)
- awesome - imagemin/imagemin - [Unmaintained] Minify images seamlessly (JavaScript)
- awesome-nodejs-cn - imagemin - **star:5497** 图像缩小镜 ![star > 2000][Awesome] (包 / 代码压缩)
- awesome-nodejs-new - imagemin - Image minifier. (Packages / Minifiers)
- Front-End-Checklist - Imagemin
- Front-End-Checklist - Imagemin
- awesome-nodejs - imagemin - Image minifier. (Number / Minifiers)
- awesome-nodejs - imagemin - Image minifier. (Packages / Minifiers)
- awesome-nodejs - imagemin - Image minifier. (Packages / Minifiers)
- awesome-nodejs - imagemin - Image minifier. (Packages / Minifiers)
- awesome-star-libs - imagemin / imagemin
- Front-End-Checklist - Imagemin
- awesome-stars - imagemin/imagemin - `★5504` [Unmaintained] Minify images seamlessly (JavaScript)
- awesome-bookmarks - **imagemin**
- awesome-stars-webVueBlog - imagemin/imagemin - \[Unmaintained] Minify images seamlessly (JavaScript / 运维\&DevOps)
README
# imagemin
> Minify images seamlessly
---
Sindre Sorhus' open source work is supported by the community
Special thanks to:
All your environment variables, in one place
Stop struggling with scattered API keys, hacking together home-brewed tools,
and avoiding access controls. Keep your team and servers in sync with Doppler.
Strapi is the leading open-source headless CMS.
It’s 100% JavaScript, fully customizable, and developer-first.
---
## Install
```
$ npm install imagemin
```
## Usage
```js
import imagemin from 'imagemin';
import imageminJpegtran from 'imagemin-jpegtran';
import imageminPngquant from 'imagemin-pngquant';
const files = await imagemin(['images/*.{jpg,png}'], {
destination: 'build/images',
plugins: [
imageminJpegtran(),
imageminPngquant({
quality: [0.6, 0.8]
})
]
});
console.log(files);
//=> [{data: , destinationPath: 'build/images/foo.jpg'}, …]
```
## API
### imagemin(input, options?)
Returns `Promise` in the format `{data: Buffer, sourcePath: string, destinationPath: string}`.
#### input
Type: `string[]`
File paths or [glob patterns](https://github.com/sindresorhus/globby#globbing-patterns).
#### options
Type: `object`
##### destination
Type: `string`
Set the destination folder to where your files will be written. If no destination is specified, no files will be written.
##### plugins
Type: `Array`
[Plugins](https://www.npmjs.com/browse/keyword/imageminplugin) to use.
##### glob
Type: `boolean`\
Default: `true`
Enable globbing when matching file paths.
### imagemin.buffer(buffer, options?)
Returns `Promise`.
#### buffer
Type: `Buffer`
Buffer to optimize.
#### options
Type: `object`
##### plugins
Type: `Array`
[Plugins](https://www.npmjs.com/browse/keyword/imageminplugin) to use.
## Related
- [imagemin-cli](https://github.com/imagemin/imagemin-cli) - CLI for this module
- [imagemin-app](https://github.com/imagemin/imagemin-app) - GUI app for this module
- [gulp-imagemin](https://github.com/sindresorhus/gulp-imagemin) - Gulp plugin
- [grunt-contrib-imagemin](https://github.com/gruntjs/grunt-contrib-imagemin) - Grunt plugin