Skip to content
Node module for detecting image dimensions
TypeScript JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci nodejs 6.x & 11.x are "end of life" Aug 4, 2019
bin Migrate lib/ to Typescript Sep 16, 2019
lib Update jp2.ts Sep 30, 2019
specs
.eslintrc feat(jpg): detect image orientation Jan 8, 2019
.gitattributes Always checkout JavaScript files in Unix style Feb 12, 2019
.gitignore Migrate lib/ to Typescript Sep 16, 2019
Contributors.md
LICENSE
Readme.md
package-lock.json
package.json Update dependency typescript to v3.7.5 Jan 17, 2020
renovate.json Add renovate.json Sep 6, 2018
tsconfig.json fix jsdocs Sep 16, 2019
tslint.json Migrate lib/ to Typescript Sep 16, 2019

Readme.md

image-size

NPM Version Build Status NPM Downloads Coverage Status devDependency Status

A Node module to get dimensions of any image file

Supported formats

  • BMP
  • CUR
  • DDS
  • GIF
  • ICNS
  • ICO
  • JPEG
  • KTX
  • PNG
  • PNM (PAM, PBM, PFM, PGM, PPM)
  • PSD
  • SVG
  • TIFF
  • WebP

Programmatic Usage

npm install image-size --save

Synchronous

var sizeOf = require('image-size');
var dimensions = sizeOf('images/funny-cats.png');
console.log(dimensions.width, dimensions.height);

Asynchronous

var sizeOf = require('image-size');
sizeOf('images/funny-cats.png', function (err, dimensions) {
  console.log(dimensions.width, dimensions.height);
});

NOTE: The asynchronous version doesn't work if the input is a Buffer. Use synchronous version instead.

Also, the asynchronous functions have a default concurreny limit of 100 To change this limit, you can call the setConcurrency function like this:

var sizeOf = require('image-size');
sizeOf.setConcurrency(123456)

Using promises (node 8.x)

var { promisify } = require('util');
var sizeOf = promisify(require('image-size'));
sizeOf('images/funny-cats.png')
  .then(dimensions => { console.log(dimensions.width, dimensions.height); })
  .catch(err => console.error(err));

Async/Await (Typescript & ES7)

var { promisify } = require('util');
var sizeOf = promisify(require('image-size'));
(async () => {
  try {
    const dimensions = await sizeOf('images/funny-cats.png');
    console.log(dimensions.width, dimensions.height);
  } catch (err) {
    console.error(err);
  }
})().then(c => console.log(c));

Multi-size

If the target file 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

var sizeOf = require('image-size');
var images = sizeOf('images/multi-size.ico').images;
for (const dimensions of images) {
  console.log(dimensions.width, dimensions.height);
}

Using a URL

var url = require('url');
var http = require('http');

var sizeOf = require('image-size');

var imgUrl = 'http://my-amazing-website.com/image.jpeg';
var options = url.parse(imgUrl);

http.get(options, function (response) {
  var chunks = [];
  response.on('data', function (chunk) {
    chunks.push(chunk);
  }).on('end', function() {
    var buffer = Buffer.concat(chunks);
    console.log(sizeOf(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

Command-Line Usage (CLI)

npm install image-size --global
image-size image1 [image2] [image3] ...

Hosted API

We also provide a hosted API for image-size which may simplify your use case.

Credits

not a direct port, but an attempt to have something like dabble's imagesize as a node module.

Contributors

You can’t perform that action at this time.