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:

Prerequisite: icojs relies on node-canvas, and you must have installed cairo. Please see node-canvas wiki for installation instructions.

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

Parse ICO and return some PNGs.

Parameters

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

Returns

• Array.<Object> - Array of parsed ICO.
  • width Number - Image width.
  • height Number - Image height.
  • bit Number - Image bit depth.
  • buffer ArrayBuffer - Image buffer.

ICO.isICO

Check the ArrayBuffer is valid ICO.

Parameters

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

Returns

• Boolean - True if arg is ICO.

ICO.noConflict

No conflict.

Returns

• ICO - ICO Object.

License

MIT license