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

    8.0.1 • Public • Published

    imagemin

    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.

    Related

      This feature is exclusive to Teams

      Illustration of wombats

      The package file explorer is only available for Teams at the moment.

      We may support exploring this package in the future. Check back soon.

      Install

      npm i imagemin

      DownloadsWeekly Downloads

      1,211,468

      Version

      8.0.1

      License

      MIT

      Unpacked Size

      7.18 kB

      Total Files

      4

      Last publish

      Collaborators

      • nothingismagick
      • sindresorhus
      • kevva
      • shinnn
      • 1000ch
      • bradbaris
      • xhmikosr