Tinify-loader NPM

Tinify Loader

Optimizes your images with TinyPNG/TinyJPG and persistently caches the results to avoid eating up your API rate limit.

TinyPNG uses smart lossy compression techniques to reduce the file size of your PNG files. By selectively decreasing the number of colors in the image, fewer bytes are required to store the data. The effect is nearly invisible but it makes a very large difference in file size! Similarly, TinyJPG reduces the file size of your JPEG images. Every uploaded image is analyzed to apply the best possible JPEG encoding. Based on the content of your image an optimal strategy is chosen. The result is a quality image without wasting storage or bandwidth!

TinyPNG/TinyJPG provides 500 free compressions each month. If you reach your compression limit the API, you must upgrade your account by entering your payment details on the API account page.

Tinify Loader caches the results of your requests so you won't have to worry about hitting your free compression limit unless you work with a particularly large number of images.

Important:

This loader only handles optimization of your images.
You still need a loader to handle images in your webpack bundle such as url-loader or file-loader.

Install

npm install tinify-loader --save-dev

Setup

Get API Key

You can sign up for a developer account for free at tinypng.com/developers.

(Fun fact: This screenshot was compressed with TinyPNG. Reducing its size from 213.2 KB to just 58.2 KB—that's a 73% size reduction!)

Once you have setup your account, you'll be sent a link to login and view your API key and usage data on your dashboard.

Usage

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.(png|jpe?g)$/,
        use: [
          {
            loader: 'tinify-loader',
            options: {
              apikey: TINYPNG_KEY
            }
          }
        ]
      }
    ]
  }
};

Options

Name	Type	Default	Description
`apikey`	`{String}`	`undefined`	Developer API key from TinyPNG/TinyJPG
`cache`	`{String}`	`path.resolve('.cache/tinify')`	Path to directory where processed images will be cached.

`options.apikey`

This is where you can directly provide your API key found on your TinyPNG/TinyJPG dashboard.

However, there are options for not storing your API key directly in your webpack.config.js. If this option is not provided, Tinify Loader will check for an environmental variable process.env.TINYPNG_KEY.

TINYPNG_KEY=l4P-GCBT8K3uJRmkUtd3K5WUcdVma3Cp webpack

Note: This is not a working API key.

You also have the option of placing your API key in file located at ~/.tinypng. This can be the simplest solution for working with the Tinify Loader in multiple projects and also allows for easy interoperability with tinypng-cli.