Socket
Socket
Sign inDemoInstall

imagemin

Package Overview
Dependencies
54
Maintainers
6
Versions
48
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    imagemin

Minify images seamlessly


Version published
Weekly downloads
934K
increased by1.76%
Maintainers
6
Install size
1.82 MB
Created
Weekly downloads
 

Package description

What is imagemin?

The imagemin npm package is a powerful tool for image compression and optimization. It allows developers to reduce the size of images without losing quality, which can significantly improve the performance of web applications by reducing load times.

What are imagemin's main functionalities?

Basic Image Compression

This code demonstrates how to use imagemin to compress JPEG and PNG images. The images are taken from the 'images' directory and the compressed versions are saved in the 'build/images' directory. The quality of JPEG images is set to 75, and the quality of PNG images is set between 60% and 80%.

const imagemin = require('imagemin');
const imageminMozjpeg = require('imagemin-mozjpeg');
const imageminPngquant = require('imagemin-pngquant');

(async () => {
    const files = await imagemin(['images/*.{jpg,png}'], {
        destination: 'build/images',
        plugins: [
            imageminMozjpeg({quality: 75}),
            imageminPngquant({quality: [0.6, 0.8]})
        ]
    });

    console.log(files);
})();

GIF Optimization

This code demonstrates how to optimize GIF images using imagemin. The GIF images are taken from the 'images' directory and the optimized versions are saved in the 'build/images' directory. The optimization level is set to 3, which is the highest level of optimization.

const imagemin = require('imagemin');
const imageminGifsicle = require('imagemin-gifsicle');

(async () => {
    const files = await imagemin(['images/*.gif'], {
        destination: 'build/images',
        plugins: [
            imageminGifsicle({optimizationLevel: 3})
        ]
    });

    console.log(files);
})();

SVG Optimization

This code demonstrates how to optimize SVG images using imagemin. The SVG images are taken from the 'images' directory and the optimized versions are saved in the 'build/images' directory. The SVGO plugin is configured to keep the viewBox attribute and not to remove IDs.

const imagemin = require('imagemin');
const imageminSvgo = require('imagemin-svgo');

(async () => {
    const files = await imagemin(['images/*.svg'], {
        destination: 'build/images',
        plugins: [
            imageminSvgo({
                plugins: [
                    {removeViewBox: false},
                    {cleanupIDs: false}
                ]
            })
        ]
    });

    console.log(files);
})();

Other packages similar to imagemin

Readme

Source

imagemin

Minify images seamlessly



Sindre Sorhus' open source work is supported by the community

Special thanks to:



Strapi
Strapi is the leading open-source headless CMS.
It’s 100% JavaScript, fully customizable, and developer-first.



Install

npm install imagemin

Usage

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.

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 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 to use.

Keywords

FAQs

Last updated on 05 May 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc