1.1.1 • Published 4 months ago

lite-image-resizer v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

Lite Image Resizer

  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.

ParamsDescriptionTypeDefault
fileRaw file from HTML inputFilenone
resizeWidthThe width you want to resize the image to. The imageResizer function will maintain aspect ratio.Numbernone
newFileNameThe function receives the newFileName and prefixes it with the current timestamp.Stringnone

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