$ npm install image-dimensionsGet 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 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, type: 'png'}
ImageType is exported and can be one of: 'png', 'jpeg', 'gif', 'webp', 'avif', or 'heic'.
imageDimensionsFromStream(stream: ReadableStream<Uint8Array>): Promise<{width: number; height: number; type: ImageType} | undefined>Get the dimensions of an image by reading the least amount of data.
Prefer this method.
Returns the image dimensions and type, or undefined if the image format is not supported or the image data is invalid.
Note: Returns raw pixel dimensions; orientation (EXIF or HEIF/AVIF irot) is not applied.
// 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, type: 'png'}
imageDimensionsFromData(data: Uint8Array): {width: number; height: number; type: ImageType} | undefinedGet 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 and type, or undefined if the image format is not supported or the image data is invalid.
Note: Returns raw pixel dimensions; orientation (EXIF or HEIF/AVIF irot) is not applied.
import {imageDimensionsFromData} from 'image-dimensions';
const data = getImage();
console.log(imageDimensionsFromData(data));
//=> {width: 1920, height: 1080, type: 'png'}
npx image-dimensions unicorn.png
630x400
image-size?Advantages of this package
Advantages of image-size