Have ideas to improve npm?Join in the discussion! »

    imagemin
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/imagemin package

    8.0.0 • Public • Published

    imagemin GitHub Actions Status

    Minify images seamlessly





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

    API

    imagemin(input, options?)

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

    Plugins to use.

    glob

    Type: boolean
    Default: true

    Enable globbing when matching file paths.

    imagemin.buffer(buffer, options?)

    Returns Promise<Buffer>.

    buffer

    Type: Buffer

    Buffer to optimize.

    options

    Type: object

    plugins

    Type: Array

    Plugins to use.

    Hosted API

    We also provide a hosted API for imagemin which may simplify your use case.

    Related

    Install

    npm i imagemin

    DownloadsWeekly Downloads

    1,247,229

    Version

    8.0.0

    License

    MIT

    Unpacked Size

    6.92 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar