Skip to content

Getting Started

Jimp (JavaScript Image Manipulation Program) is a package that makes it easy to load and manipulate images in the browser and Node.js. It aims to run anywhere that JavaScript is supported.

Read the full documentation to learn more about the API.

Terminal window
pnpm add jimp

Jimp supports the following image formats:

Usage

The workflow for using jimp

  1. Load an image.

    import { Jimp } from "jimp";
    const image = await Jimp.read("test/image.png");
  2. Manipulate the image.

    image.resize({ width: 100 });
  3. Save the image.

    await image.write("test/output.png");