@jimp/plugin-resize

What is @jimp/plugin-resize?

@jimp/plugin-resize is a plugin for the Jimp image processing library that provides functionality for resizing images. It allows you to scale images up or down, fit them within specific dimensions, and apply various resizing algorithms.

What are @jimp/plugin-resize's main functionalities?

Resize to specific dimensions

This feature allows you to resize an image to specific dimensions. In this example, the image is resized to 256x256 pixels.

const Jimp = require('jimp');

Jimp.read('path/to/image.jpg')
  .then(image => {
    return image.resize(256, 256) // resize to 256x256
      .write('path/to/resized_image.jpg'); // save
  })
  .catch(err => {
    console.error(err);
  });

Scale image proportionally

This feature allows you to scale an image proportionally. In this example, the image is scaled to 50% of its original size.

const Jimp = require('jimp');

Jimp.read('path/to/image.jpg')
  .then(image => {
    return image.scale(0.5) // scale image to 50%
      .write('path/to/scaled_image.jpg'); // save
  })
  .catch(err => {
    console.error(err);
  });

Contain image within specific dimensions

This feature allows you to resize an image to fit within specific dimensions while maintaining the aspect ratio. In this example, the image is resized to fit within a 300x300 pixel box.

const Jimp = require('jimp');

Jimp.read('path/to/image.jpg')
  .then(image => {
    return image.contain(300, 300) // contain within 300x300
      .write('path/to/contained_image.jpg'); // save
  })
  .catch(err => {
    console.error(err);
  });

Other packages similar to @jimp/plugin-resize

sharp

Sharp is a high-performance image processing library that supports resizing, cropping, and various other transformations. It is known for its speed and efficiency, especially with large images. Compared to @jimp/plugin-resize, Sharp offers more advanced features and better performance.

gm

GraphicsMagick (gm) is a powerful image processing library that provides a wide range of image manipulation capabilities, including resizing. It is a wrapper around the GraphicsMagick and ImageMagick tools. While it offers extensive functionality, it requires the installation of external dependencies, unlike @jimp/plugin-resize which is a pure JavaScript solution.

lwip

Lightweight Image Processor (lwip) is a simple and efficient image processing library that supports resizing, cropping, and other basic transformations. It is lightweight and easy to use, but it may not offer as many features or the same level of performance as @jimp/plugin-resize or Sharp.

README

@jimp/plugin-resize

Resize an image.

Resizes the image to a set width and height using a 2-pass bilinear algorithm.

Usage

• @param {number} w the width to resize the image to (or ResizeStrategy.AUTO)
• @param {number} h the height to resize the image to (or ResizeStrategy.AUTO)
• @param {string} mode (optional) a scaling method (e.g. ResizeStrategy.BEZIER)

import jimp, { ResizeStrategy } from "jimp";

async function main() {
  // Read the image.
  const image = await jimp.read("test/image.png");

  // Resize the image to width 150 and auto height.
  await image.resize(150, ResizeStrategy.AUTO);

  // Save and overwrite the image
  await image.writeAsync("test/image.png");
}

main();

Auto

ResizeStrategy.AUTO can be passes to either the height or width and jimp will scale the image accordingly. ResizeStrategy.AUTO cannot be both height and width.

// resize the height to 250 and scale the width accordingly
image.resize(ResizeStrategy.AUTO, 250);
// resize the width to 250 and scale the height accordingly
image.resize(250, ResizeStrategy.AUTO);

Resize modes

The default resizing algorithm uses a bilinear method.

Optionally, the following constants can be passed to choose a particular resizing algorithm:

ResizeStrategy.NEAREST_NEIGHBOR;
ResizeStrategy.BILINEAR;
ResizeStrategy.BICUBIC;
ResizeStrategy.HERMITE;
ResizeStrategy.BEZIER;

image.resize(250, 250, ResizeStrategy.BEZIER);

scale

Uniformly scales the image by a factor.

• @param {number} f the factor to scale the image by
• @param {string} mode (optional) a scaling method (e.g. Jimp.RESIZE_BEZIER)
• @param {function(Error, Jimp)} cb (optional) a callback for when complete

import jimp from "jimp";

async function main() {
  const image = await jimp.read("test/image.png");

  image.scale(2);
  image.scale(2, jimp.RESIZE_BEZIER);
}

main();

scaleToFit

Scale the image to the largest size that fits inside the rectangle that has the given width and height.

• @param {number} w the width to resize the image to
• @param {number} h the height to resize the image to
• @param {string} mode (optional) a scaling method (e.g. Jimp.RESIZE_BEZIER)
• @param {function(Error, Jimp)} cb (optional) a callback for when complete

import jimp from "jimp";

async function main() {
  const image = await jimp.read("test/image.png");

  image.scaleToFit(100, 100);
}

main();