npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

image-compressor-soumojit-shome

v1.0.2

Published

ImageCompressor is a lightweight and efficient image compression utility that helps reduce the file size of images before uploading them to a server

Downloads

239

Readme

ImageCompressor Package

Overview

ImageCompressor is a lightweight and efficient image compression utility that helps reduce the file size of images before uploading them to a server. It supports configurable options for maximum dimensions and quality, making it ideal for web and mobile applications.

Features

  • Compresses images with custom width, height, and quality settings.
  • Reduces file sizes without significant loss of quality.
  • Easy to integrate with existing projects.
  • Compatible with modern JavaScript frameworks like React.

Installation

Install the package using npm:

npm install image-compressor-soumojit-shome

Usage :

Before

Typically, users directly upload images to the server, leading to increased storage costs and bandwidth usage:

import React, { useState } from 'react';
// Assuming the user has their own uploadFileToServer function
import { uploadFileToServer } from './yourUploadFunction'; // replace with actual import
import { ImageCompressorFunc } from 'image-compressor-soumojit-shome';

const ImageUploader = () => {
  const [selectedFile, setSelectedFile] = useState(null);

  const handleFileChange = (e) => {
    setSelectedFile(e.target.files[0]);
  };

  const handleUpload = async () => {
    if (!selectedFile) {
      alert('Please select an image first.');
      return;
    }
    try {
      // directly upload images to the server
      await uploadFiletoServer(selectedFile);

      alert('Image uploaded successfully!');
    } catch (error) {
      console.error('Error uploading image:', error);
      alert('Failed to upload the image.');
    }
  };

  return (
    <div>
      <h1>Image Uploader</h1>
      <input type="file" accept="image/*" onChange={handleFileChange} />
      <button onClick={handleUpload}>Upload Image</button>
    </div>
  );
};

export default ImageUploader;

After

With ImageCompressor, compress the image first to reduce its size before uploading:

  1. Pass the image to the compressor function.
  2. Upload the compressed image to the server.

Example Code (React.js)

Here’s a simple React example to demonstrate how to use the package:

import React, { useState } from 'react';
// Assuming the user has their own uploadFileToServer function
import { uploadFileToServer } from './yourUploadFunction'; // replace with actual import
import { ImageCompressorFunc } from 'image-compressor-soumojit-shome';


const ImageUploader = () => {
  const [selectedFile, setSelectedFile] = useState(null);

  const handleFileChange = (e) => {
    setSelectedFile(e.target.files[0]);
  };

  const handleUpload = async () => {
    if (!selectedFile) {
      alert('Please select an image first.');
      return;
    }

    try {
      // Define compression options
      const imageCompressionOptions = {
        maxWidth: 1920,
        maxHeight: 1920,
        quality: 0.2,
      };

      // Compress the image
      const compressedFile = await ImageCompressorFunc(
        selectedFile,
        imageCompressionOptions.maxWidth,
        imageCompressionOptions.maxHeight,
        imageCompressionOptions.quality
      );

      // Upload the compressed image to the server
      await uploadFiletoServer(compressedFile);

      alert('Image uploaded successfully!');
    } catch (error) {
      console.error('Error uploading image:', error);
      alert('Failed to upload the image.');
    }
  };

  return (
    <div>
      <h1>Image Uploader</h1>
      <input type="file" accept="image/*" onChange={handleFileChange} />
      <button onClick={handleUpload}>Upload Image</button>
    </div>
  );
};

export default ImageUploader;

API

ImageCompressorFunc(file, maxWidth, maxHeight, quality)

Parameters:

  • file (File): The image file to compress.
  • maxWidth (number): Maximum width of the compressed image.
  • maxHeight (number): Maximum height of the compressed image.
  • quality (number): Quality of the compressed image (0 to 1).

Returns:

  • A Promise resolving to the compressed image file.

Benefits

  • Storage Efficiency: Reduce storage costs by uploading smaller files.
  • Faster Uploads: Smaller files mean quicker uploads, especially on slower networks.
  • Better User Experience: Optimized images improve application performance.

Developer Details

If you want to learn more about the developer or see more projects, check out the links below: