# decode-ico

> Decode `.ico` icons

Latest version **0.4.1** (published 2022-11-15) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2022-11-15 |
| First published | 2017-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.6 |
| Dependencies | 3 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Maintainers | linusu |

## Links

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

## Dependencies (3)

- [decode-bmp](https://npm.io/package/decode-bmp.md) ^0.2.0
- [to-data-view](https://npm.io/package/to-data-view.md) ^1.1.0
- [@canvas/image-data](https://npm.io/package/@canvas/image-data.md) ^1.0.0

## Recent versions

- 0.4.1 (latest) — 2022-11-15
- 0.4.0 — 2019-11-16
- 0.3.1 — 2018-11-06
- 0.3.0 — 2018-11-06
- 0.2.1 — 2018-01-29
- 0.2.0 — 2018-01-27
- 0.1.6 — 2018-01-27
- 0.1.4 — 2018-01-27
- 0.1.3 — 2018-01-27
- 0.1.2 — 2017-08-17
- 0.1.1 — 2017-08-16
- 0.1.0 — 2017-08-15

## README

# Decode ICO

Decode `.ico` icons

## Installation

```sh
npm install --save decode-ico
```

## Usage

```js
const decodeIco = require('decode-ico')
const fs = require('fs')

const source = fs.readFileSync('favicon.ico')
const images = decodeIco(source)

console.log(images[0])
//=> { width: 16, height: 16, type: 'bmp', data: Uint8Array(...), bpp: 32, hotspot: null }

console.log(images[1])
//=> { width: 32, height: 32, type: 'bmp', data: Uint8Array(...), bpp: 32, hotspot: null }
```

## API

### `decodeIco(source: ArrayBuffer | Buffer) => Image[]`

Decodes the `.ico` file in the given buffer, and returns an array of images.

Each image has the following properties:

- `width: Number` - The width of the image, in pixels
- `height: Number` - The height of the image, in pixels
- `type: String` - The type of image, will be one of `bmp` or `png`
- `bpp: Number` - The color depth of the image as the number of bits used per pixel
- `data: Uint8Array` - The data of the image, format depends on `type`, see below
- `hotspot: null | Hotspot` - If the image is a cursor (`.cur`), this is the hotspot

The format of the `data` parameter depends on the type of image. When the image is of type `bmp`, the `data` array will hold raw pixel data in the RGBA order, with integer values between 0 and 255 (included). When the type is `png`, the array will be png data.

The `hotspot` property will either be `null`, or an object with an `x` and `y` property.

💡 The `png` data can be written to a file with the `.png` extension directly, or be decoded by [node-lodepng](https://github.com/LinusU/node-lodepng) which will give you the same raw format as the `bmp` type.

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