js-image-lib
👋 Intro
An image manipulation library using only pure JavaScript
This library lets you:
- Resize images to different sizes
- Convert between the following file types:
png
, jpeg
, gif
, bmp
, and tiff
- Apply operations like
crop
, rotate
, blur
, and flip
This library uses pure browser-compatible JavaScript, relying on no Node packages.
This means js-image-lib can be run anywhere you use JavaScript!
Note: The use of pure JavaScript means this library will run much slower
than alternative libraries that have C/etc bindings. You should primarily use js-image-lib
in environments where speed is not the first concern, especially in cases where you are trying to support all platforms!
🚀 How to use
Install
To install this library, use on of the following commands:
npm install -S js-image-lib
yarn add js-image-lib
Use
Retrieve your image as a Uint8Array, then transform it with imageTransformer
by providing the image and the options to use.
import { imageTransformer, MimeType } from "js-image-lib";
const image: Uint8Array = ...;
const contentType: MimeType = ...;
const transformOptions = {
width: 100,
};
const newImage = imageTransformer({
data: image,
contentType
}, transformOptions);
Note: The parameter contentType
is optional, but should be provided if it is known to speed up performance.
Transform Options
export interface TransformOptions {
width: number;
height?: number;
contentType?: MimeType;
fit?: ImageFit;
position?: ImagePosition;
background?: Color;
quality?: number;
compressionLevel?: number;
loop?: number;
delay?: number;
blurRadius?: number | null;
rotate?: number | null;
flip?: FlipDirection | null;
crop?: CropOptions | null;
}
Docs