zudo-image-tweaker
GitHub repository

Type to search...

to open search from anywhere

Introduction

What zudo-image-tweaker is and how its eleven subpath modules are organized.

What is zudo-image-tweaker?

@takazudo/zudo-image-tweaker is a sharp-based image-tweaking toolkit, published as eleven focused subpath modules rather than one flat API. Each module is its own exports entry, so a consumer only pulls in the code paths — and the optional/native dependencies — that the modules they actually import need.

The eleven modules

SubpathWhat it does
/variantsMulti-width WebP variant engine: content-hash cache, corruption repair, filename-tag dispatch.
/heifHEIC/HEIF → JPEG conversion with ICC profile preservation.
/ogpSocial-card (Open Graph / Twitter card) image compositor.
/budgetByte-budget encode ladder — search for the highest quality that still fits a byte cap.
/squareFive-mode square-crop toolbox.
/product-photoML background removal plus procedural shadow synthesis for product photography.
/calibrateBackground color normalization toward a target color.
/compositeOverlay batch compositing.
/blurhashBlurHash placeholder generation.
/exifEXIF metadata extraction and orientation helpers.
/browserClient-side upload preparation pipeline.

Every module is reachable both as a dedicated subpath (@takazudo/zudo-image-tweaker/variants) and, for most exports, from the flat root import (@takazudo/zudo-image-tweaker) — see Installation for both forms.

Where to go next

  • Installation — add the package and handle the sharp build-script prompt.

  • Quick Start — process a directory of source photos into responsive variants.

  • Configuration — the full /variants engine config surface.