Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
ipx
Advanced tools
Changelog
Readme
High performance, secure and easy-to-use image optimizer.
[!IMPORTANT] This is the development branch for IPX v2. Check out ipx/v1 for latest stable docs and #71 for v2 roadmap.
You can use ipx
command to start server.
Using npx
:
npx ipx@next-2 serve --dir ./
Usin bun
bun x npx ipx@next-2 serve --dir ./
The default serve directory is the current working directory.
You can use IPX as a middleware or directly use IPX interface.
import {
createIPX,
createIPXMiddleware,
ipxFSStorage,
ipxHttpStorage,
} from "ipx";
const ipx = createIPX({
storage: ipxFSStorage({ dir: "./public" }),
httpStorage: ipxHttpStorage({ domains: ["picsum.photos"] }),
});
const ipxMiddleware = createIPXMiddleware(ipx);
Example: Using with unjs/h3:
import { createIPX, createIPXMiddleware } from "ipx";
import { listen } from "listhen";
const app = createApp().use("/", fromNodeMiddleware(ipxMiddleware));
listen(toNodeListener(app));
Example: Using express:
import { listen } from "listhen";
import express from "express";
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
You can universally customize IPX configuration using IPX_*
environment variables.
IPX_ALIAS
{}
(enabled by default with CLI only)
IPX_FS_DIR
.
(current working directory)IPX_FS_MAX_AGE
300
(enabled by default with CLI only)
IPX_HTTP_DOMAINS
[]
IPX_HTTP_MAX_AGE
300
IPX_HTTP_FETCH_OPTIONS
{}
IPX_HTTP_ALLOW_ALL_DOMAINS
false
Property | Docs | Example | Comments |
---|---|---|---|
width / w | Docs | /width_200/buffalo.png | |
height / h | Docs | /height_200/buffalo.png | |
resize / s | Docs | /s_200x200/buffalo.png | |
kernel | Docs | /s_200x200,kernel_nearest/buffalo.png | Supported kernel: nearest , cubic , mitchell , lanczos2 and lanczos3 (default). |
fit | Docs | /s_200x200,fit_outside/buffalo.png | Sets fit option for resize . |
position / pos | Docs | /s_200x200,pos_top/buffalo.png | Sets position option for resize . |
trim | Docs | /trim_100/buffalo.png | |
extend | Docs | /extend_{top}_{right}_{bottom}_{left}/buffalo.png | Extend / pad / extrude one or more edges of the image with either the provided background colour or pixels derived from the image. |
background / b | _ | /r_45,b_00ff00/buffalo.png | |
extract | Docs | /extract_{left}_{top}_{width}_{height}/buffalo.png | Extract/crop a region of the image. |
format / f | Docs | /format_webp/buffalo.png | Supported format: jpg , jpeg , png , webp , avif , gif , heif , tiff and auto (experimental only with middleware) |
quality / q | _ | /quality_50/buffalo.png | Accepted values: 0 to 100 |
rotate | Docs | /rotate_45/buffalo.png | |
enlarge | _ | /enlarge,s_2000x2000/buffalo.png | Allow the image to be upscaled. By default the returned image will never be larger than the source in any dimension, while preserving the requested aspect ratio. |
flip | Docs | /flip/buffalo.png | |
flop | Docs | /flop/buffalo.png | |
sharpen | Docs | /sharpen_30/buffalo.png | |
median | Docs | /median_10/buffalo.png | |
blur | Docs | /blur_5/buffalo.png | |
gamma | Docs | /gamma_3/buffalo.png | |
negate | Docs | /negate/buffalo.png | |
normalize | Docs | /normalize/buffalo.png | |
threshold | Docs | /threshold_10/buffalo.png | |
tint | Docs | /tint_1098123/buffalo.png | |
grayscale | Docs | /grayscale/buffalo.png | |
animated | - | /animated/buffalo.gif | Experimental |
FAQs
High performance, secure and easy-to-use image optimizer.
We found that ipx demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).