Compress

Tinify

https://tinypng.com/developers
npm i @pi-r/tinify

TinyPNG is a web service for image compression. The first 500 images are free each month with a developer API key.

squared.json

{
  "compress": {
    "tinify": {
      "api_key": "**********", // Default API key (optional)
      "proxy": "",
      "expires": "1h"
    },
    "settings": {
      "tinify_api_key": "**********" // Alternate
    }
  }
}

{
  "selector": "p > img",
  "compress": [
    {
      "format": "png", // png | jpeg | webp
      "plugin": "tinify",
      "options": {
        "apiKey": "**********", // Overrides settings
        "expires": "30m" // Caches validation for multiple transactions
      }
    }
  ]
}

Imagemin

https://github.com/imagemin/imagemin
npm i @pi-r/imagemin

Images are transcoded locally using MIME detection to automatically choose the appropriate plugin.

squared.json

{
  "compress": {
    "imagemin": {
      "mozjpeg": {/* default */}, // https://npmjs.com/package/imagemin-mozjpeg#api
      "jpegtran": null, // https://npmjs.com/package/imagemin-jpegtran#api
      "pngquant": {/* default */}, // https://npmjs.com/package/imagemin-pngquant#api
      "webp": {/* default */}, // https://npmjs.com/package/imagemin-webp#api
      "gifsicle": {/* default */}, // https://npmjs.com/package/imagemin-gifsicle#api
      "svgo": {/* default */} // https://npmjs.com/package/imagemin-svgo#api
    }
  }
}

Note

Any null values being truthy will override the default transformer when “metadata.package” [1] is undefined.

{
  "selector": "p > img",
  "compress": [
    {
      "format": "jpeg", // Recommended
      "plugin": "imagemin",
      "worker": true,
      "options": {
        "quality": 75, // imagemin-mozjpeg (default)
        "smooth": 60
      }
    },
    {
      "format": "jpeg",
      "plugin": "imagemin",
      "metadata": {
        "package": "imagemin-jpegtran", // Alias "jpegtran"
        "mimeType": "image/jpeg" // Optional (auto-detect)
      },
      "options": {
        "progressive": true,
        "arithmetic": true
      }
    }
  ]
}

Caution

When format is not defined the plugin will be applied to all images. Multiple plugins of the same MIME will be processed in a series.

Other formats can be compressed similarly using imagemin-like plugins directly.

{
  "selector": "p > img",
  "compress": [
    {
      "format": "png",
      "plugin": "imagemin-optipng", // npm i imagemin-optipng
      "options": {
        "speed": 11,
        "quality": [0.3, 0.5]
      }
    },
    /* OR */
    {
      "format": "png",
      "plugin": "imagemin",
      "metadata": {
        "package": "imagemin-optipng" // With settings "optipng"
      }
    }
  ]
}

Important

Settings are applied only when options is undefined.

Environment Variables

Name	Value
EMC_COMPRESS_WORKER_MIN	number
EMC_COMPRESS_WORKER_MAX	number
EMC_COMPRESS_WORKER_TIMEOUT	minute

@pi-r/imagemin

Changed in version 0.12.0:

Package will be developed under pi-r for future releases. [2]

Added in version 0.10.0:

Initial package was created in pi-r2. [3]