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

You can use ipx command to start server using:

npx ipx@latest

The default server directory is the current working directory.

You can use IPX as a middleware or directly use IPX interface.

import { createIPX, createIPXMiddleware } from "ipx";

const ipx = createIPX({ domains: ["unjs.io"] });

// (req, res) => void
const ipxMiddleware = createIPXMiddleware(ipx);

Example: Using with unjs/h3:

import { createIPX, createIPXMiddleware } from "ipx";
import { listen } from "listhen";
import { createApp, fromNodeMiddleware, toNodeListener } from "h3";

const ipx = createIPX({});
const ipxMiddleware = createIPXMiddleware(ipx);

const app = createApp().use("/", fromNodeMiddleware(ipxMiddleware));

listen(toNodeListener(app));

Example: Using express:

import { createIPX, createIPXMiddleware } from "ipx";
import { listen } from "listhen";
import express from "express";

const ipx = createIPX({});
const ipxMiddleware = createIPXMiddleware(ipx);

const app = express().use("/", ipxMiddleware);

listen(app);

Get original image:

/_/static/buffalo.png

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

/f_webp/static/buffalo.png

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

/w_200/static/buffalo.png

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

/embed,f_webp,s_200x200/static/buffalo.png

Config can be customized using IPX_* environment variables.

• IPX_DIR

  • Default: . (current working directory)

• IPX_DOMAINS

  • Default: []

• IPX_MAX_AGE

  • Default: 300

• IPX_ALIAS

  • Default: {}

• IPX_FETCH_OPTIONS

  • Default: {}

MIT