Skip to content

Package Guide

Dus Mamud edited this page Nov 9, 2026 · 1 revision

Package Guide

Every package is separately installable under the @dusrel/ scope, ESM-only, and versioned in lockstep (all 24 are at 1.0.1). No codec WASM is ever bundled into the core.

npm install @dusrel/image   # the flagship — engine + pipeline + batch
npm install @dusrel/image-avif @dusrel/image-crop   # or just the pieces you need

Not sure which package a task needs? The Cookbook maps common jobs to packages, and Core Concepts explains how they compose.

Core

Package What it does
@dusrel/image One-call processing, fluent pipeline, plugins, fallback policies, batch
@dusrel/image-core The zero-dependency Canvas engine underneath

Codecs (WASM, lazily loaded)

Package Engine
@dusrel/image-jpeg MozJPEG — progressive JPEG encode/decode
@dusrel/image-webp libwebp — lossy + lossless WebP
@dusrel/image-avif libaom + libavif — AVIF encode/decode
@dusrel/image-png Rust png crate — PNG encode/decode
@dusrel/image-oxipng OxiPNG — lossless PNG optimisation
@dusrel/image-resize Rust resize crate — high-quality resampling, 7 filters
@dusrel/image-quantize quantizr — palette quantisation for PNG-8 style savings
@dusrel/image-qoi Rust qoi crate — lossless QOI encode/decode
@dusrel/image-jxl libjxl — JPEG XL encode/decode
@dusrel/image-heic libheif + libde265 — HEIC/HEIF decode only, native-first on Safari (engine LGPL-3.0, wrapper MIT)

Sizes, options and picking advice: Codec Guide.

Features

Package What it does
@dusrel/image-crop Crop geometry core + the accessible <dusrel-crop> Web Component
@dusrel/image-transform Flip, rotate, perspective warp
@dusrel/image-adjust Brightness/contrast/exposure/gamma/hue/saturation, blur, sharpen
@dusrel/image-metadata EXIF read (incl. GPS), metadata strip (all or GPS-only)
@dusrel/image-watermark Image and text watermarks — positioned or tiled, with opacity/scale/margin control
@dusrel/image-batch Worker-pool batch engine — retries, timeouts, pause/resume, memory caps
@dusrel/image-gif Animated GIF encode/decode/optimise — Rust gif crate
@dusrel/image-svg SVG optimisation — SVGO browser build, multipass
@dusrel/image-placeholder ThumbHash + BlurHash placeholders — pure TypeScript, aspect + alpha aware

Frameworks

Package What it does
@dusrel/image-react useProcessImage / useProcessBatch hooks + <DusrelCrop>
@dusrel/image-vue Composables + <DusrelCrop> with v-model
@dusrel/image-svelte Store factories + DusrelCrop.svelte with bind:crop

Snippets for each: Framework Integrations. Full API reference for every package: dusmamud.github.io/dusrel-image/api.

Clone this wiki locally