ipx

What is ipx?

The ipx npm package is an image processing server that allows you to manipulate images on-the-fly. It supports various image transformations such as resizing, cropping, and format conversion, making it useful for web applications that need dynamic image processing.

What are ipx's main functionalities?

Resizing Images

This feature allows you to resize images to specified dimensions. In the code sample, the image is resized to a width of 300 pixels and a height of 200 pixels.

const ipx = require('ipx')();
const url = '/_ipx/w_300,h_200/image.jpg';
const result = await ipx(url);

Cropping Images

This feature allows you to crop images to specified dimensions. In the code sample, the image is cropped to a width of 300 pixels and a height of 200 pixels.

const ipx = require('ipx')();
const url = '/_ipx/c_crop,w_300,h_200/image.jpg';
const result = await ipx(url);

Format Conversion

This feature allows you to convert images to different formats. In the code sample, the image is converted to the WebP format.

const ipx = require('ipx')();
const url = '/_ipx/f_webp/image.jpg';
const result = await ipx(url);

Other packages similar to ipx

sharp

Sharp is a high-performance image processing library that supports resizing, cropping, and format conversion. It is known for its speed and efficiency, making it a popular choice for server-side image processing. Compared to ipx, sharp is more of a low-level library that requires more manual setup and configuration.

jimp

Jimp is a JavaScript image processing library that supports various image manipulations such as resizing, cropping, and format conversion. It is easy to use and does not require any external dependencies. Compared to ipx, Jimp is more suitable for client-side applications and smaller projects.

gm

GraphicsMagick (gm) is a Node.js wrapper for the GraphicsMagick and ImageMagick image processing libraries. It supports a wide range of image manipulations and is highly configurable. Compared to ipx, gm offers more advanced features but requires the installation of external software.

README

IPX

High performance, secure and easy to use image proxy based on sharp and libvips.

Usage

Quick Start

You can use ipx command to start server using:

$ npx ipx

The default server directory is the current working directory.

Programatic Usage

You can use IPX as a Connect/Express middleware or directly use ipx api.

import { createIPX, createIPXMiddleware } from "ipx";

const ipx = createIPX(/* options */);
const app = express();
app.use("/image", createIPXMiddleware(ipx));

Examples

The examples assume that a static folder with buffalo.png file is present in the directory where IPX server is running.

Get original image:

http://localhost:3000/_/static/buffalo.png

Change format to webp and keep other things same as source:

http://localhost:3000/f_webp/static/buffalo.png

Keep original format (png) and set width to 200:

http://localhost:3000/w_200/static/buffalo.png

Resize to 200x200px using embed method and change format to webp:

http://localhost:3000/embed,f_webp,s_200x200/static/buffalo.png

Modifiers

Property	Docs	Example	Comments
width	_	http://localhost:3000/width_200/buffalo.png
height	_	http://localhost:3000/height_200/buffalo.png
trim	Docs	http://localhost:3000/trim_100/buffalo.png
format	Docs	http://localhost:3000/format_webp/buffalo.png	Supported format: jpg, jpeg, png, webp, avif, gif, heif
quality	_	http://localhost:3000/quality_50/buffalo.png	Accepted values: 0 to 100
rotate	Docs	http://localhost:3000/rotate_45/buffalo.png
flip	Docs	http://localhost:3000/flip/buffalo.png
flop	Docs	http://localhost:3000/flop/buffalo.png
sharpen	Docs	http://localhost:3000/sharpen_30/buffalo.png
median	Docs	http://localhost:3000/median_10/buffalo.png
gamma	Docs	http://localhost:3000/gamma_3/buffalo.png
negate	Docs	http://localhost:3000/negate/buffalo.png
normalize	Docs	http://localhost:3000/normalize/buffalo.png
threshold	Docs	http://localhost:3000/threshold_10/buffalo.png
tint	Docs	http://localhost:3000/tint_1098123/buffalo.png
grayscale	Docs	http://localhost:3000/grayscale/buffalo.png
animated	-	http://localhost:3000/animated/buffalo.gif	Experimental

Config

Config can be customized using IPX_* environment variables.

• IPX_DIR

  • Default: . (current working directory)

• IPX_DOMAINS

  • Default: []

License

MIT

Changelog

0.7.1 (2021-07-02)

Bug Fixes

• handle background number (2f82a56)
• resize with width and hight (3ca70a0)
• support background with rotate (b6c8f8c)