icojs

icojs

A JavaScript library to use ICO.

Work on both Node.js and Browser.

var fs = require('fs');
var ICO = require('icojs');

var arrayBuffer = new Uint8Array(fs.readFileSync('favicon.ico')).buffer;
var images = ICO.parse(arrayBuffer);

Install

Node.js:

npm install icojs

Browser:

bower install icojs

And add to HTML:

<script type="text/javascript" src="/path/to/ico.js"></script>

To fully use this library, browsers must support JavaScript typed arrays and Canvas API.

Google Chrome, Internet Explorer 11, Mozilla Firefox and Safari 7.1 support these functions.

Demo

http://egy186.github.io/icojs/#demo

Documentation

ICO.parse(buffer)

Parse ICO and return some PNG(s).

Parameters

• buffer ArrayBuffer The ArrayBuffer object contain the TypedArray of a ICO file.

Returns

• images Object[] Array of PNG images.
• images[].width Number Image width.
• images[].height Number Image height.
• images[].bit Number Image bit depth.
• images[].buffer ArrayBuffer Image buffer.

ICO.isICO(buffer)

Check the ArrayBuffer is valid ICO.

Parameters

• buffer ArrayBuffer The ArrayBuffer object contain the TypedArray of a ICO file.

Returns

• isICO Boolean True if arg is ICO.

License

MIT license