Skip to content

ahmadawais/resize-optimize-images

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

16 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

resize-optimize-images

DOWNLOADS Learn VSCode Follow @MrAhmadAwais on Twitter

πŸ—ƒ Resize and optimize bmp, gif, jpeg, png, & tiff images in Node.js.


πŸ“Ÿ

Install

npm install resize-optimize-images

βš™οΈ

Usage

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

❯ Read the changelog here β†’


KEY: πŸ“¦ NEW, πŸ‘Œ IMPROVE, πŸ› FIX, πŸ“– DOC, πŸš€ RELEASE, and βœ… TEST

I use Emoji-log, you should try it and simplify your git commits.


πŸ“ƒ

License & Conduct


πŸ™Œ

Connect

GitHub @AhmadAwaisΒ (follow) To stay up to date on free & open-source software

Twitter @MrAhmadAwaisΒ (follow) To get #OneDevMinute daily hot tips & trolls

YouTube AhmadAwaisΒ (subscribe) To tech talks & #OneDevMinute videos

Blog: AhmadAwais.comΒ (read) In-depth & long form technical articles

LinkedIn @MrAhmadAwaisΒ (connect) On the LinkedIn profile y'all

About

πŸ—ƒ Resize and optimize bmp, gif, jpeg, png, & tiff images in Node.js.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published