https://github.com/ahmadawais/resize-optimize-images
🗃 Resize and optimize bmp, gif, jpeg, png, & tiff images in Node.js.
https://github.com/ahmadawais/resize-optimize-images
Last synced: 3 months ago
JSON representation
🗃 Resize and optimize bmp, gif, jpeg, png, & tiff images in Node.js.
- Host: GitHub
- URL: https://github.com/ahmadawais/resize-optimize-images
- Owner: ahmadawais
- License: mit
- Created: 2019-08-15T07:48:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-15T14:14:07.000Z (almost 5 years ago)
- Last Synced: 2025-04-15T01:08:51.716Z (3 months ago)
- Language: JavaScript
- Homepage: https://ahmadawais.com/resize-optimize-images-javascript-node/
- Size: 277 KB
- Stars: 66
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# resize-optimize-images
[](https://www.npmjs.com/package/resize-optimize-images) [](https://VSCode.pro/?utm_source=GitHubFOSS)
[](https://twitter.com/mrahmadawais/)
> 🗃 Resize and optimize bmp, gif, jpeg, png, & tiff images in Node.js.
[](./../../)
## Install
```sh
npm install resize-optimize-images
```
[](./../../)
## Usage
```js
const resizeOptimizeImages = require('resize-optimize-images');
(async () => {
// Set the options.
const options = {
images: ['path/to/image.jpg', 'path/to/image.png'],
width: 1920,
quality: 90
};
// Run the module.
await resizeOptimizeImages(options);
})();
```
[](./../../)
## API
### resizeOptimizeImages(options)
#### ❯ options
Type: `object`
You can specify the options below.
##### images
Type: `Array`
Array of paths to images that you want to resize and optimize.
##### width
Type: `Number`
Default: `1920`
A number value of width e.g. 1920.
##### height
Type: `Number`
Optional number value of height e.g. 1080. If you don't pass a height then image is scaled accordingly with width to preserve the aspect ratio.
##### quality
Type: `Number`
Default: `90`
Set image quality. `100` being the best quality.
[](changelog.md)
## Changelog
[❯ Read the changelog here →](changelog.md)
**KEY**: `📦 NEW`, `👌 IMPROVE`, `🐛 FIX`, `📖 DOC`, `🚀 RELEASE`, and `✅ TEST`
> _I use [Emoji-log](https://github.com/ahmadawais/Emoji-Log), you should try it and simplify your git commits._
[](./../../)
## License & Conduct
- MIT © [Ahmad Awais](https://twitter.com/MrAhmadAwais/)
- [Code of Conduct](code-of-conduct.md)
[](./../../)
## Connect
(follow) To stay up to date on free & open-source software
(follow) To get #OneDevMinute daily hot tips & trolls
(subscribe) To tech talks & #OneDevMinute videos
(read) In-depth & long form technical articles
(connect) On the LinkedIn profile y'all
[](./../../)
## Sponsor
Me ([Ahmad Awais](https://twitter.com/mrahmadawais/)) and my incredible wife ([Maedah Batool](https://twitter.com/MaedahBatool/)) are two engineers who fell in love with open source and then with each other. You can read more [about me here](https://ahmadawais.com/about). If you or your company use any of my projects or like what I’m doing then consider backing me. I'm in this for the long run. An open-source developer advocate.
- 🌟 **$9.99/month (recommended)** ❯ [Two cups of Caffè latte (coffee) every month →](https://pay.paddle.com/checkout/540217)
- 🚀 **$99.99 (one-time sponsor)** ❯ [Support an hour of open-source code →](https://pay.paddle.com/checkout/515568)
- 🔰 **$49.99 (one-time sponsor)** ❯ [Support an hour of maintenance →](https://pay.paddle.com/checkout/527253)
- ☕️ **$9.99 (one-time sponsor)** ❯ [Lunch/coffee →](https://pay.paddle.com/checkout/527254)
Or you can back me by checking out my super fun video course. As developers, we spend over 200 Hrs/month with our code editors — it's only fair to learn your next editor deeply. This course will save you 15-20 hours every month. Become a VSCode Power User →
[](https://VSCode.pro/?utm_source=GitHubFOSS)
[](https://twitter.com/mrahmadawais/)
