Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/image-size/image-size
Node module for detecting image dimensions
https://github.com/image-size/image-size
dimensions image-analysis image-size
Last synced: 6 days ago
JSON representation
Node module for detecting image dimensions
- Host: GitHub
- URL: https://github.com/image-size/image-size
- Owner: image-size
- License: mit
- Created: 2013-07-01T23:58:32.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-12-25T19:59:49.000Z (25 days ago)
- Last Synced: 2025-01-11T19:07:00.661Z (8 days ago)
- Topics: dimensions, image-analysis, image-size
- Language: TypeScript
- Homepage:
- Size: 7.44 MB
- Stars: 2,077
- Watchers: 19
- Forks: 197
- Open Issues: 31
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - image-size - size | 1871 | (TypeScript)
README
# image-size
[](https://circleci.com/gh/image-size/image-size)
[](https://www.npmjs.com/package/image-size)
[](http://npm-stat.com/charts.html?package=image-size&author=&from=&to=)
A [Node](https://nodejs.org/en/) module to get dimensions of any image file
## Supported formats
- BMP
- CUR
- DDS
- GIF
- HEIC (HEIF, AVCI, AVIF)
- ICNS
- ICO
- J2C
- JPEG-2000 (JP2)
- JPEG
- JPEG-XL
- KTX (1 and 2)
- PNG
- PNM (PAM, PBM, PFM, PGM, PPM)
- PSD
- SVG
- TGA
- TIFF
- WebP
## Programmatic Usage
```shell
npm install image-size --save
```
or
```shell
yarn add image-size
```
### Synchronous
```javascript
const sizeOf = require("image-size")
const dimensions = sizeOf("images/funny-cats.png")
console.log(dimensions.width, dimensions.height)
```
### Asynchronous
```javascript
const 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 concurrency limit of **100**
To change this limit, you can call the `setConcurrency` function like this:
```javascript
const sizeOf = require("image-size")
sizeOf.setConcurrency(123456)
```
### Using promises (nodejs 10.x+)
```javascript
const { promisify } = require("util")
const 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)
```javascript
const { promisify } = require("util")
const 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
```javascript
const sizeOf = require("image-size")
const images = sizeOf("images/multi-size.ico").images
for (const dimensions of images) {
console.log(dimensions.width, dimensions.height)
}
```
### Using a URL
```javascript
const url = require("url")
const http = require("http")
const sizeOf = require("image-size")
const imgUrl = "http://my-amazing-website.com/image.jpeg"
const options = url.parse(imgUrl)
http.get(options, function (response) {
const chunks = []
response
.on("data", function (chunk) {
chunks.push(chunk)
})
.on("end", function () {
const 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**
### Disabling certain image types
```javascript
const imageSize = require("image-size")
imageSize.disableTypes(["tiff", "ico"])
```
### Disabling all file-system reads
```javascript
const imageSize = require("image-size")
imageSize.disableFS(true)
```
### JPEG image orientation
If the orientation is present in the JPEG EXIF metadata, it will be returned by the function. The orientation value is a [number between 1 and 8](https://exiftool.org/TagNames/EXIF.html#:~:text=0x0112,8%20=%20Rotate%20270%20CW) representing a type of orientation.
```javascript
const sizeOf = require("image-size")
const dimensions = sizeOf("images/photo.jpeg")
console.log(dimensions.orientation)
```
## Command-Line Usage (CLI)
```shell
npm install image-size --global
```
or
```shell
yarn global add image-size
```
followed by
```shell
image-size image1 [image2] [image3] ...
```
## Credits
not a direct port, but an attempt to have something like
[dabble's imagesize](https://github.com/dabble/imagesize/blob/master/lib/image_size.rb) as a node module.
## [Contributors](Contributors.md)