image-size
A Node module to get dimensions of any image file
Supported formats
- BMP
- CUR
- DDS
- GIF
- HEIC (HEIF, AVCI, AVIF)
- ICNS
- ICO
- J2C
- JP2
- JPEG
- KTX
- PNG
- PNM (PAM, PBM, PFM, PGM, PPM)
- PSD
- SVG
- TGA
- TIFF
- WebP
Installation
npm install image-size --save
or
yarn add image-size
Programmatic Usage
Passing in a Buffer/Uint8Array
const { imageSize } = require('image-size')
const { width, height } = imageSize(bufferObject)
console.log(width, height)
Reading from a file
const { imageSize } = require('image-size/fromFile')
const dimensions = await imageSize('images/funny-cats.png')
console.log(dimensions.width, dimensions.height)
NOTE: Reading from files haa a default concurrency limit of 100
To change this limit, you can call the setConcurrency
function like this:
const sizeOf = require('image-size/fromFile')
sizeOf.setConcurrency(123456)
Multi-size
If the target file/buffer is an icon (.ico) or a cursor (.cur), the width
and height
will be the ones of the first found image.
An additional images
array is available and returns the dimensions of all the available images
const { imageSize } = require('image-size')
const { images } = imageSize('images/multi-size.ico')
for (const dimensions of images) {
console.log(dimensions.width, dimensions.height)
}
Using a URL
const url = require('node:url')
const http = require('node:http')
const { imageSize } = require('image-size')
const imgUrl = 'http://my-amazing-website.com/image.jpeg'
const options = url.parse(imgUrl)
http.get(options, function (response) {
const chunks = []
response
.on('data', function (chunk) {
chunks.push(chunk)
})
.on('end', function () {
const buffer = Buffer.concat(chunks)
console.log(imageSize(buffer))
})
})
You can optionally check the buffer lengths & stop downloading the image after a few kilobytes.
You don't need to download the entire image
Disabling certain image types
const { disableTypes } = require('image-size')
disableTypes(['tiff', 'ico'])
JPEG image orientation
If the orientation is present in the JPEG EXIF metadata, it will be returned by the function. The orientation value is a number between 1 and 8 representing a type of orientation.
const { imageSize } = require('image-size/fromFile')
const { width, height, orientation } = imageSize('images/photo.jpeg')
console.log(width, height, orientation)
Command-Line Usage (CLI)
npm install image-size --global
or
yarn global add image-size
followed by
image-size image1 [image2] [image3] ...
Credits
not a direct port, but an attempt to have something like
dabble's imagesize as a node module.