# imagemin

> Minify images seamlessly

Latest version **9.0.1** (published 2025-03-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install imagemin
pnpm add imagemin
yarn add imagemin
bun add imagemin
```

## Health

**Score 38/100 (D)** — status: maintenance-mode.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 9.0.1 |
| Published | 2025-03-07 |
| First published | 2013-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/imagemin) |
| Module format | ESM |
| Node | >=18 |
| Dependencies | 10 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5721 |
| Maintainers | sindresorhus |
| Keywords | minify, compress, image, images, jpeg, jpg, png, gif, svg |

## Links

- npm: https://www.npmjs.com/package/imagemin
- Repository: https://github.com/imagemin/imagemin
- Homepage: https://github.com/imagemin/imagemin#readme
- Issues: https://github.com/imagemin/imagemin/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/imagemin

## Dependencies (10)

- [ow](https://npm.io/package/ow.md) ^2.0.0
- [junk](https://npm.io/package/junk.md) ^4.0.1
- [slash](https://npm.io/package/slash.md) ^5.1.0
- [globby](https://npm.io/package/globby.md) ^14.0.1
- [p-pipe](https://npm.io/package/p-pipe.md) ^4.0.0
- [file-type](https://npm.io/package/file-type.md) ^19.0.0
- [environment](https://npm.io/package/environment.md) ^1.0.0
- [image-dimensions](https://npm.io/package/image-dimensions.md) ^2.3.0
- [uint8array-extras](https://npm.io/package/uint8array-extras.md) ^1.1.0
- [change-file-extension](https://npm.io/package/change-file-extension.md) ^0.1.1

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 9.0.1 (latest) — 2025-03-07
- 9.0.0 — 2024-05-05
- 8.0.1 — 2021-08-11
- 8.0.0 — 2021-04-21
- 7.0.1 — 2019-11-15
- 7.0.0 — 2019-06-30
- 6.1.0 — 2018-12-25
- 6.0.0 — 2018-07-23
- 5.3.1 — 2017-05-12
- 5.3.0 — 2017-05-12
- 5.2.2 — 2016-06-27
- 5.2.1 — 2016-05-27
- 5.2.0 — 2016-05-26
- 5.1.3 — 2016-05-23
- 5.1.2 — 2016-05-15
- … 34 more at https://npm.io/package/imagemin/versions

## README

# imagemin

> Minify images seamlessly

## Install

```sh
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: <Uint8Array 89 50 4e …>, destinationPath: 'build/images/foo.jpg'}, …]
```

## API

### imagemin(input, options?)

Returns `Promise<object[]>` in the format `{data: Uint8Array, 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`

The [plugins](https://www.npmjs.com/browse/keyword/imageminplugin) to use.

##### glob

Type: `boolean`\
Default: `true`

Enable globbing when matching file paths.

### imagemin.buffer(data, options?)

Returns `Promise<Uint8Array>`.

#### data

Type: `Uint8Array`

The image data 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
- [gulp-imagemin](https://github.com/sindresorhus/gulp-imagemin) - Gulp plugin

---
_Source: https://npm.io/package/imagemin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._