Get image size without full download. Supported image types: JPG, GIF, PNG, WebP, BMP, TIFF, PSD.
npm install probe-image-size --savevar probe = require('probe-image-size');
// Get by URL
//
probe('http://example.com/image.jpg', function (err, result) {
console.log(result); // => { width: xx, height: yy, type: 'jpg', mime: 'image/jpeg' }
});
// By URL with options
//
probe({ url: 'http://example.com/image.jpg', timeout: 5000 }, function (err, result) {
console.log(result); // => { width: xx, height: yy, length: zz, type: 'jpg', mime: 'image/jpeg' }
});
// From the stream
//
var input = require('fs').createReadStream('image.jpg');
probe(input, function (err, result) {
console.log(result); // => { width: xx, height: yy, type: 'jpg', mime: 'image/jpeg' }
// terminate input, depends on stream type,
// this example is for fs streams only.
input.destroy();
});src can be of this types:
- String - URL to fetch
- Object - options for request,
defaults are
{ timeout: 5000, maxRedirects: 2 } - Stream - readable stream
result contains:
{
width: XX,
height: YY,
length: ZZ, // byte length of the file (if available, HTTP only)
type: ..., // image 'type' (usual file name extention)
mime: ... // mime type
}err is an error, which is extended with:
code- equals toECONTENTif the library failed to parse the file;status- equals to a HTTP status code if it receives a non-200 response.
Note. If you use stream as source, it's your responsibility to terminate reading in callback. That will release resources as soon as possible. On http requests that's done automatically.