Code Monkey home page Code Monkey logo

image-size's Introduction

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 (nodejs 10.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.

image-size's People

Contributors

netroy avatar renovate-bot avatar shinnn avatar zanehannanau avatar borodean avatar zeke avatar mannyclicks avatar swftvsn avatar jushar avatar linusu avatar rkrol avatar jiang-xuan avatar jorrit avatar kornelski avatar rossj avatar zcei avatar vinicius0026 avatar zzahos-kg avatar adamrenklint avatar hupfis avatar vampirical avatar bahmutov avatar evert avatar chrisvxd avatar yous avatar ashsearle avatar andreyvolokitin avatar andrewleedham avatar amorgaut avatar bv-vd avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.