# image-decode

> Decode image data from gif, jpeg, png, tiff or bmp

Latest version **1.2.2** (published 2019-04-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install image-decode
pnpm add image-decode
yarn add image-decode
bun add image-decode
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2019-04-06 |
| First published | 2018-11-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 9.1 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 24 |
| Author | dy |
| Maintainers | dy |
| Keywords | image, image-decode, get-pixels, image-pixels, pixels |

## Links

- npm: https://www.npmjs.com/package/image-decode
- Repository: https://github.com/dy/image-decode
- Homepage: https://github.com/dy/image-decode#readme
- Issues: https://github.com/dy/image-decode/issues
- npm.io page: https://npm.io/package/image-decode

## Dependencies (8)

- [utif](https://npm.io/package/utif.md) ^2.0.1
- [pngjs](https://npm.io/package/pngjs.md) ^3.3.3
- [bmp-js](https://npm.io/package/bmp-js.md) ^0.1.0
- [omggif](https://npm.io/package/omggif.md) ^1.0.9
- [jpeg-js](https://npm.io/package/jpeg-js.md) ^0.3.4
- [image-type](https://npm.io/package/image-type.md) ^3.0.0
- [to-array-buffer](https://npm.io/package/to-array-buffer.md) ^3.0.0
- [buffer-to-uint8array](https://npm.io/package/buffer-to-uint8array.md) ^1.1.0

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 1.2.2 (latest) — 2019-04-06
- 1.2.1 — 2018-11-13
- 1.2.0 — 2018-11-12
- 1.1.0 — 2018-11-11
- 1.0.0 — 2018-11-09

## README

# image-decode [![unstable](https://img.shields.io/badge/stability-unstable-green.svg)](http://github.com/badges/stability-badges) [![Build Status](https://img.shields.io/travis/dy/image-decode.svg)](https://travis-ci.org/dy/image-decode)

Decode image data from raw encoded binary data in any image format: PNG, GIF, BMP, JPEG, TIFF.

## Usage

[![npm install image-decode](https://nodei.co/npm/image-decode.png?mini=true)](https://npmjs.org/package/image-decode/)

```js
let decode = require('image-decode')

let {data, width, height} = decode(fs.readFileSync('./data.png'))
```

## API

### `let {data, width, height} = decode(buffer, mimeType?)`

Takes input `buffer` with encoded image data and decodes its contents, returns pixels `data` array with layout `[r, g, b, a, r, g, b, a, ...]`. `mimeType` can be passed to skip image type detection.

`buffer` can be any binary data container:

* ArrayBuffer
* Buffer
* Uint8Array
* File
* Blob
* base64 string


## See also

* [image-encode](https://ghub.io/image-encode) − encode pixels data to target format.
* [image-equal](https://ghub.io/image-equal) − image data comparing tool.
* [image-pixels](https://ghub.io/image-pixels) − load or save pixel data from/to any source.
* [image-save](https://ghub.io/image-save) − save image pixels data to a target.
* [image-type](https://ghub.io/image-type) − detect input image data type.


## Credits

© 2018 Dmitry Yv. MIT License.

---
_Source: https://npm.io/package/image-decode · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._