npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

image-dimensions

v2.3.0

Published

Get the dimensions of an image

Downloads

49,028

Readme

image-dimensions

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.

Supported formats

  • JPEG
  • PNG (and APNG)
  • GIF
  • WebP
  • AVIF

Install

npm install image-dimensions

Usage

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}

API

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 = 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}

CLI

npx image-dimensions unicorn.png
630x400

FAQ

How does this differ from image-size?

Advantages of this package

  • Zero dependencies
  • Smaller
  • Works in non-Node.js environments like the browser
  • Does not include unnecessary APIs for file reading
  • Supports the AVIF image format

Advantages of image-size

  • More mature
  • Supports more image formats
  • Supports getting JPEG image orientation

Related