Logo for jsDocs.io

image-size

  • Version 2.0.2
  • Published
  • 378 kB
  • No dependencies
  • MIT license

Install

npm i image-size
yarn add image-size
pnpm add image-size

Overview

get dimensions of any image file

Index

Variables

Functions

Variables

variable types

const types: (
    | 'bmp'
    | 'cur'
    | 'dds'
    | 'gif'
    | 'heif'
    | 'icns'
    | 'ico'
    | 'j2c'
    | 'jp2'
    | 'jpg'
    | 'jxl'
    | 'jxl-stream'
    | 'ktx'
    | 'png'
    | 'pnm'
    | 'psd'
    | 'svg'
    | 'tga'
    | 'tiff'
    | 'webp'
)[];

    Functions

    function disableTypes

    disableTypes: (types: imageType[]) => void;

      function imageSize

      imageSize: (input: Uint8Array) => ISizeCalculationResult;

      • Return size information based on an Uint8Array

        Parameter input

        Returns

        {ISizeCalculationResult}

      Package Files (3)

      Dependencies (0)

      No dependencies.

      Dev Dependencies (9)

      Peer Dependencies (0)

      No peer dependencies.

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/image-size.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/image-size)
      • HTML
        <a href="https://www.jsdocs.io/package/image-size"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>