jimp

library1.6.1jsnpmunverified

Jimp is a comprehensive image processing library for Node.js, written entirely in JavaScript with zero native dependencies. It enables various image manipulation tasks such as resizing, cropping, color adjustments, and format conversions without external binaries. The current stable version is 1.6.1, reflecting an active development and release cadence with multiple patch and minor versions in recent months. Key differentiators include its pure JavaScript implementation, which ensures high portability across diverse environments, and a modular plugin architecture for customized builds. Jimp supports a wide range of formats, including JPEG, PNG, BMP, TIFF, and GIF, making it a versatile choice for server-side image processing workflows.

data

npm install jimp

github ↗package ↗

INSTALL

IMPORT

SIG · JIMP

jimp

datajavascriptv1.6.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Jimp

✓ import { Jimp } from 'jimp';

✗ const Jimp = require('jimp');

While CommonJS `require` works, ESM `import` is preferred in modern Node.js environments (>=18). The Jimp class is a named export.

Jimp (default)

✓ import Jimp from 'jimp/browser';

✗ import Jimp from 'jimp';

For browser-specific builds or older bundlers, explicitly importing from `jimp/browser` was common. As of v1.1.4, bundler integration improved, allowing `import { Jimp } from 'jimp'` to often work correctly in browser contexts too, but `jimp/browser` remains an option for direct default imports.

Jimp.read

✓ import { Jimp } from 'jimp'; const image = await Jimp.read('path/to/image.png');

✗ import Jimp from 'jimp'; const image = await Jimp.read('path/to/image.png');

Jimp.read is a static method of the named `Jimp` class. Ensure you use the named import for `Jimp`.

JimpType

✓ import type { JimpType } from '@jimp/types';

For advanced TypeScript usage, you might import specific types from the `@jimp/types` package, although `Jimp` itself ships with types.

This quickstart demonstrates how to read an image, perform common manipulations like resizing, converting to grayscale, adding text, and saving the output to a new file. It includes basic error handling and uses modern ESM syntax.

import { Jimp } from 'jimp'; import path from 'path'; import fs from 'fs/promises'; async function processImage() { const inputPath = path.resolve('./input.png'); const outputPath = path.resolve('./output-processed.jpg'); const fontPath = path.resolve(__dirname, '../../node_modules/@jimp/plugin-print/fonts/open-sans/open-sans-16-black/open-sans-16-black.fnt'); // Example font path try { // Ensure input.png exists for demonstration // For a real app, you'd fetch or use an existing file // await fs.writeFile(inputPath, Buffer.from('...', 'base64')); // Example: write a placeholder image const image = await Jimp.read(inputPath); // Read the image // Resize, grayscale, and add text const font = await Jimp.loadFont(fontPath); image .resize(300, Jimp.AUTO) // resize to 300px width, auto height .quality(80) // set JPEG quality .greyscale() // set greyscale .print(font, 10, 10, 'Hello Jimp!') // add text .write(outputPath); // save console.log(`Image processed and saved to ${outputPath}`); } catch (error) { console.error('Error processing image:', error); } } // Create a dummy input.png for the quickstart if it doesn't exist async function createDummyImage() { const dummyImagePath = path.resolve('./input.png'); if (!await fs.stat(dummyImagePath).catch(() => false)) { const dummyImage = await new Jimp(100, 100, 0xFF0000FF); // 100x100 red image await dummyImage.write(dummyImagePath); console.log(`Created dummy image at ${dummyImagePath} for quickstart.`); } } createDummyImage().then(() => processImage());

Debug

Known issues

breakingStarting from `v1.2.0`, most plugins (e.g., blur, color, print) are no longer included by default with the main `jimp` package. To use these functionalities, you must explicitly import and add them to a custom Jimp instance.

fix

Initialize Jimp with desired plugins: `import Jimp from 'jimp/browser'; import { blur } from '@jimp/plugin-blur'; const customJimp = Jimp.extend(blur); await customJimp.read(...)` or `import { Jimp } from 'jimp'; Jimp.extend(blur);`

affects: >=1.2.0

breakingThe `brightness` function behavior changed in `v1.1.2` to align with standard CSS brightness implementations. Previously, it used an inverted multiplication. A value of `1` now means no change, with values above `1` increasing brightness.

fix

Review existing code using `brightness` and adjust the numeric argument (e.g., a previous `0.5` might now be `1.5` for similar brightening, or `0.5` for dimming).

affects: >=1.1.2

gotchaOlder versions of Jimp (before `v1.1.4`) often required importing from `jimp/browser` specifically for browser environments to ensure correct bundler integration. While improved, some older configurations might still encounter issues.

fix

For new projects, prefer `import { Jimp } from 'jimp';` and rely on modern bundlers to pick up the correct export. If issues persist in a browser context, consider `import Jimp from 'jimp/browser';` or refer to your bundler's configuration.

affects: <1.1.4

gotchaWhen working with `jimp` in ESM projects (e.g., Node.js with `"type": "module"` or bundlers), ensure you use `import` statements. Attempting to use `require()` might lead to errors about `require is not defined`.

fix

Always use `import { Jimp } from 'jimp';` and `await` for asynchronous operations like `Jimp.read` and `image.write`.

affects: >=1.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module ... Not supported

Attempting to use `require()` in an ES Module context (e.g., in a `type: "module"` project) for a package that is primarily ESM or has a main ESM export.

fix

Change `const { Jimp } = require('jimp');` to `import { Jimp } from 'jimp';`.

TypeError: Jimp.read is not a function

Incorrect import of the Jimp class, often caused by using a default import (`import Jimp from 'jimp'`) when `Jimp` is a named export, or trying to access a static method on an incorrectly imported object.

fix

Ensure you are using the named import: `import { Jimp } from 'jimp';`.

TypeError: Cannot read properties of undefined (reading 'write')

Attempting to call `.write()` or other manipulation methods on an image object that has not been `await`ed, or if `Jimp.read` failed to return an image.

fix

Always `await` asynchronous Jimp operations, especially `Jimp.read()`: `const image = await Jimp.read('path/to/image.png');`

Upgrade

Version history

1.6.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/jimp-dev/jimp ↗

packagehttps://www.npmjs.com/package/jimp ↗