image-dimensions-stream

A Node module to get dimensions of any image file stream

Supported formats

• BMP
• GIF
• JPEG
• PNG
• PSD
• DDS

Upcoming

• SWF
• CUR
• ICO
• ICNS
• TIFF
• WebP
• SVG

Programmatic Usage

yarn add image-dimensions-stream

Example

const ImageDimensionsStream = require('image-dimensions-stream');
const pipeline = util.promisify(require('stream').pipeline);

async function main() {
  const sizeStream = new ImageDimensionsStream();
  let result = {
    mime: null,
    dimensions: null,
  };

  sizeStream.on('mime', (mime) => {
    console.log('mime:', mime);
    result.mime = mime;
  });

  sizeStream.on('dimensions', (dimensions) => {
    console.log('dimensions:', dimensions);
    result.dimensions = dimensions;
  });

  await pipeline(fs.createReadStream('images/funny-cats.png'), sizeStream, fs.createWriteStream('/dev/null'));

  return result;
}

main().then(console.log).catch(console.error);

Options

Key | Type | Default | Description --- | --- | --- | --- requireMime | boolean function | true | destroy stream if mime can't be found requireDimensions | boolean function | true | destroy stream if dimensions can't be found exif | boolean function | false | use EXIF (Orientation) data if available requireValidExif | boolean function | false | destroy stream on invalid EXIF data otherwise just skip EXIF block. Only useful if exif option returns true maxMimeChunkOffset | number | Minimum value possible | Whether to destroy the stream if we couldn't detect mime type after reading this amount of bytes maxMimeBufferSize | number in bytes | 4100 | Maximum buffer size when detecting mime type maxDimensionsBufferSize | number in bytes | 64000 | Maximum buffer size when detecting dimensions

Credits

image-size for test images and file structures