@jsquash/resize
v2.0.0
Published
Wasm image resize methods supporting the browser and V8 environments. Repackaged from Squoosh App.
Downloads
1,481
Maintainers
Readme
@jsquash/resize
An easy experience for resizing images in the browser or V8 environment. Powered by WebAssembly ⚡️ and Rust.
ℹ️ You will need to have an already decoded ImageData object to resize. This can be accomplished by using other jSquash modules or using the Canvas API, if available.
Uses squoosh's Resize module. Composed of:
- https://github.com/PistonDevelopers/resize
- https://github.com/CryZe/wasmboy-rs/tree/master/hqx
A jSquash package. Codecs and supporting code derived from the Squoosh app.
Installation
npm install --save @jsquash/resize
# Or your favourite package manager alternative
Usage
Note: You will need to either manually include the wasm files from the codec directory or use a bundler like WebPack or Rollup to include them in your app/server.
resize(data: ImageData, options: ResizeOptions): Promise
Resizes an ImageData object to the
data
Type: ImageData
options
Type: Partial<ResizeOptions> & { width: number, height: number }
The resize options for the output image. See default values.
width
(number) the width to resize the image toheight
(number) the height to resize the image tomethod?
('triangle'
|'catrom'
|'mitchell'
|'lanczos3'
|'hqx'
) the algorithm used to resize the image. Defaults tolanczos3
.fitMethod?
('stretch'
|'contain'
) whether the image is stretched to fit the dimensions or cropped. Defaults tostretch
.premultiply?
(boolean) Defaults totrue
linearRGB?
(boolean) Defaults totrue
Example
import { decode } from '@jsquash/jpeg';
import resize from '@jsquash/resize';
const imageBuffer = fetch('/images/example.jpg').then(res => res.arrayBuffer());
const originalImageData = await decode(imageBuffer);
const resizedImageData = await resize(originalImageData, { height: 300, width: 400 };
Manual WASM initialisation (not recommended)
In most situations there is no need to manually initialise the provided WebAssembly modules. The generated glue code takes care of this and supports most web bundlers.
One situation where this arises is when using the modules in Cloudflare Workers (See the README for more info).
The main module exports initHqx
and initResize
functions that can be used to manually load their respective wasm module.
import resize, { initResize } from '@jsquash/resize';
initResize(WASM_MODULE); // The `WASM_MODULE` variable will need to be sourced by yourself and passed as an ArrayBuffer.
resize(image, options);