lite-image-resizer
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

Lite Image Resizer


🥤 A utility for resizing images.

Table of Contents

  1. Installation
  2. Usage
  3. Invoke

💽Installation

 npm install lite-image-resizer

📄Usage

Import in your ts or js file

import { imageResizer } from 'lite-image-resizer'

🛠Invoke

const resizedImage = await imageResizer(file, 400, 'rabbit')

📦 Props

The imageResizer function takes in 3 arguments.

Params Description Type Default
file Raw file from HTML input File none
resizeWidth The width you want to resize the image to. The imageResizer function will maintain aspect ratio. Number none
newFileName The function receives the newFileName and prefixes it with the current timestamp. String none

Issues

If you experience any anomaly or bug while using the component, feel free to create an issue on this repo issues

👷🏽 Contribution Guide

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star. Thanks!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Package Sidebar

Install

npm i lite-image-resizer

Weekly Downloads

2

Version

1.1.1

License

MIT

Unpacked Size

14.8 kB

Total Files

15

Last publish

Collaborators

  • adebiyiart