Get the dimensions of an image
Works in any modern JavaScript environment (browsers, Node.js, Bun, Deno, etc).
Supporting all kinds of image formats is a non-goal. However, pull requests for adding JPEG XL and HEIC formats are welcome.
npm install image-dimensions
import {imageDimensionsFromStream} from 'image-dimensions';
// In this example, it will only read a few bytes of the image instead of fetching the whole thing.
const url = 'https://sindresorhus.com/unicorn';
const {body} = await fetch(url);
console.log(await imageDimensionsFromStream(body));
//=> {width: 1920, height: 1080}imageDimensionsFromStream(stream: ReadableStream<Uint8Array>): Promise<{width: number; height: number} | undefined>
Get the dimensions of an image by reading the least amount of data.
Prefer this method.
Returns the image dimensions, or undefined if the image format is not supported or the image data is invalid.
// Node.js example
import {createReadStream} from 'node:fs';
import {imageDimensionsFromStream} from 'image-dimensions';
const stream = ReadableStream.from(createReadStream('unicorn.png'));
console.log(await imageDimensionsFromStream(stream));
//=> {width: 1920, height: 1080}imageDimensionsFromData(data: Uint8Array): {width: number; height: number} | undefined
Get the dimensions of an image from data.
This method can be useful if you already have the image loaded in memory.
Returns the image dimensions, or undefined if the image format is not supported or the image data is invalid.
import {imageDimensionsFromData} from 'image-dimensions';
const data = getImage();
console.log(imageDimensionsFromData(data));
//=> {width: 1920, height: 1080}
npx image-dimensions unicorn.png 630x400
Advantages of this package
Advantages of image-size
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4