# ico-endec

> ICO encoder and decoder library

Latest version **0.1.6** (published 2020-05-12) · MPL-2.0 license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2020-05-12 |
| First published | 2020-04-01 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 25.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Ketchetwahmeegwun T. Southall |
| Maintainers | kettek |

## Links

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

## Recent versions

- 0.1.6 (latest) — 2020-05-12
- 0.1.5 — 2020-05-12
- 0.1.4 — 2020-04-02
- 0.1.3 — 2020-04-02
- 0.1.2 — 2020-04-01
- 0.1.1 — 2020-04-01
- 0.1.0 — 2020-04-01

## README

# ICO encoder & decoder
This JavaScript library provides an encoder and decoder for ICO and CUR files. Although this library can encode and decode both BMP and PNG images, BMP endec does not provide bitmasking support, and as such, will not work with some icons. However, PNG support is widespread and has become a more defacto standard for application icons, so this problem is largely moot -- but it still would be nice to have.

## Encoding
### icoEndec.encode([Buffer||ArrayBuffer])
The encode function takes an array of ArrayBuffers or Buffers that contain BMP or PNG data. It returns a Buffer containing the binary data of the ICO file.

#### Example
```
const icoEndec   = require('ico-endec')
const fsPromises = require('fs').Promises

(async () => {
  let icoBuffer = icoEndec.encode([
    await fsPromises.readFile('myIcon-16x16.png'),
    await fsPromises.readFile('myIcon-32x32.png'),
    await fsPromises.readFile('myIcon-64x64.png')
  ])
  
  await fsPromises.writeFile('myIcon.ico', icoBuffer)
})()
```

## Decoding
### icoEndec.decode(Buffer)
The decode function takes a Buffer or an ArrayBuffer that holds the binary data of an ICO file. It returns an array of [IconEntries](#iconentry).
#### Example
```
const icoEndec   = require('ico-endec')
const fsPromises = require('fs').Promises

(async () => {
  let icons = icoEndec.decode(await fsPromises.readFile('myIcon.ico'))
  
  icons.forEach((icon, index) => {
    fsPromises.writeFile(`myIcon-${icon.width}x${icon.height}.${icon.imageType}`, icon.imageData)
  })
})()
```

## IconEntry
The IconEntry class stores various information about the given icon entry.

| Accessor              | Type | Description |
|-|-|-|
| width                 | Number | width of the image, maximum of 256
| height                | Number | height of the image, maximum of 256
| colors                | Number | number of colors
| colorPlanes           | Number | color planes of an ICO image
| bitsPerPixel          | Number | bits per pixel of an ICO image
| horizontalHotspot     | Number | horizontal hotspot of a CUR image
| verticalHotspot       | Number | vertical hotspot of a CUR image
| imageSize             | Number | (interal) size of imageData's buffer
| imageOffset           | Number | (interal) offset start of the image data
| imageType             | String | 'png' or 'bmp'
| imageData             | [Buffer](https://nodejs.org/api/buffer.html) | image data of the icon

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