remige v0.1.2

Remige - Forked Version of libSquoosh: Advanced Image Compression Framework for Superior File Size Reduction

Supported Platforms

Table of Contents 📝

• Features and Benefits
• Use Cases

• Friendly request to users

• Installation - Step-by-Step Guide

• Usage

• In-Action

• License

• Contributing to Our Project

• Website

• Contact Information

• Credits

Features and Benefits ✨

• Node.js Compatibility: Supports the latest Node.js versions, ensuring modern development compatibility.
• Direct Codec Integration: Integrates Squoosh's image codecs directly within JavaScript applications.
• Optimized Performance: Tailored for optimal performance in current development practices.
• ImagePool for Efficiency: Efficiently manages parallel image processing through ImagePool.
• Auto Optimizer: Includes an experimental auto optimizer for streamlined image compression.

Use Cases ✅

• Web Development: Use Remige for compressing images in web applications, ensuring faster load times.
• Node.js Applications: Integrate Remige into Node.js projects for high-performance image processing.
• Batch Processing: Manage and process large batches of images efficiently with ImagePool.
• Image Preprocessing: Resize and preprocess images before encoding for various formats.
• Automated Workflows: Use Remige in CI/CD pipelines for automatic image optimization.

🙏🏻 Friendly Request to Users

Every star on this repository is a sign of encouragement, a vote of confidence, and a reminder that our work is making a difference. If this project has brought value to you, even in the smallest way, please consider showing your support by giving it a star. ⭐

"Star" button located at the top-right of the page, near the repository name.

Your star isn’t just a digital icon—it’s a beacon that tells us we're on the right path, that our efforts are appreciated, and that this work matters. It fuels our passion and drives us to keep improving, building, and sharing.

If you believe in what we’re doing, please share this project with others who might find it helpful. Together, we can create something truly meaningful.

Thank you for being part of this journey. Your support means the world to us. 🌍💖

Installation - Step-by-Step Guide 🪜

• Step 1: Install Remige in your local project with:

$ npm install remige

• Step 2: To use Remige, import ImagePool and set up your image processing pipeline:

import { ImagePool } from "remige";
import { cpus } from "os";

const imagePool = new ImagePool(cpus().length);

Ensure to only create one ImagePool instance to avoid memory issues during parallel image processing.

Usage

All API remains same as @squoosh/lib

Ingesting Images

Ingest images using imagePool.ingestImage(), accepting ArrayBuffer from fs.readFile() or fetch().

import fs from "fs/promises";

const file = await fs.readFile("./path/to/image.png");
const image = imagePool.ingestImage(file);

Preprocessing and Encoding Images

Preprocess and encode images to various formats:

const preprocessOptions = {
  resize: {
    width: 100,
    height: 50,
  },
};

await image.preprocess(preprocessOptions);

const encodeOptions = {
  mozjpeg: {}, // default settings
  jxl: {
    quality: 90,
  },
};

const result = await image.encode(encodeOptions);

Closing ImagePool

Close the ImagePool pipeline to prevent ingesting and encoding new images:

await imagePool.close();

Writing Encoded Images to File System

Write encoded images to the file system:

const rawEncodedImage = image.encodedWith.mozjpeg.binary;

await fs.writeFile("/path/to/new/image.jpg", rawEncodedImage);

Extracting Image Information

Extract decoded and encoded image information:

console.log(await image.decoded);
console.log(image.encodedWith.jxl);

Auto Optimizer

Remige includes an experimental auto optimizer:

const encodeOptions = {
  mozjpeg: "auto",
};

In-Action 🤺

Identical Images but Different Size: Magic of Remige

License ©️

This project is licensed under the Apache License 2.0.

Contributing to Our Project 🤝

We’re always open to contributions and fixing issues—your help makes this project better for everyone.

If you encounter any errors or issues, please don’t hesitate to raise an issue. This ensures we can address problems quickly and improve the project.

For those who want to contribute, we kindly ask you to review our Contribution Guidelines before getting started. This helps ensure that all contributions align with the project's direction and comply with our existing license.

We deeply appreciate everyone who contributes or raises issues—your efforts are crucial to building a stronger community. Together, we can create something truly impactful.

Thank you for being part of this journey!

Website 🌐

squoosh.app

Contact Information

For any questions, please reach out via hello@darsan.in or LinkedIn.

Credits 🙏🏻

Remige is a forked version of libSquoosh, originally developed and maintained by the GoogleChromeLabs. We credit the Squoosh team for their foundational work and contributions to image compression technology.

Topics