icojs

icojs

A JavaScript library to use ICO. Works on both Node.js and the browser.

Install

npm install icojs

Node.js:

const ICO = require('icojs');

Browser:

const ICO = require('icojs/browser')

or

<script type="text/javascript" src="node_modules/icojs/dist/ico.js"></script>

To fully use this library, browsers must support JavaScript typed arrays, Canvas API and Promise. Chrome, Edge 12, Firefox and Safari 9 support these functions.

Example

Node.js:

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

const buffer = fs.readFileSync('favicon.ico');
ICO.parse(buffer, 'image/png').then(images => {
  // save as png files
  images.forEach(image => {
    const file = `${image.width}x${image.height}-${image.bit}bit.png`;
    const data = Buffer.from(image.buffer);
    fs.writeFileSync(file, data);
  });
});

Browser:

<input type="file" id="input-file" />
<script>
  document.getElementById('input-file').addEventListener('change', function (evt) {
    // use FileReader for converting File object to ArrayBuffer object
    var reader = new FileReader();
    reader.onload = function (e) {
      ICO.parse(e.target.result).then(function (images) {
        // logs images
        console.dir(images);
      })
    };
    reader.readAsArrayBuffer(evt.target.files[0]);
  }, false);
</script>

Demo

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

API (Node.js)

ICO

• ICO
  • isICO(buffer) ⇒ Boolean ⏏
  • parse(buffer, [mime]) ⇒ Promise.<Array.<ParsedImage>> ⏏

isICO(buffer) ⇒ Boolean ⏏

Check the ArrayBuffer is valid ICO.

Kind: global method of ICO
Returns: Boolean - True if arg is ICO.

Param	Type	Description
buffer	ArrayBuffer | Buffer	ICO file data.

parse(buffer, [mime]) ⇒ Promise.<Array.<ParsedImage>> ⏏

Parse ICO and return some images.

Kind: global method of ICO
Returns: Promise.<Array.<ParsedImage>> - Resolves to an array of ParsedImage.

Param	Type	Default	Description
buffer	ArrayBuffer | Buffer		ICO file data.
[mime]	String	image/png	MIME type for output.

API (browser)

ICO

Kind: global class

• ICO
  • .parse(arrayBuffer, [mime]) ⇒ Promise.<Array.<ParsedImage>>
  • .noConflict() ⇒ ICO
  • .isICO(arrayBuffer) ⇒ Boolean

ICO.parse(arrayBuffer, [mime]) ⇒ Promise.<Array.<ParsedImage>>

Parse ICO and return some images.

Kind: static method of ICO
Returns: Promise.<Array.<ParsedImage>> - Resolves to an array of ParsedImage.

Param	Type	Default	Description
arrayBuffer	ArrayBuffer		ICO file data.
[mime]	String	image/png	MIME type for output.

ICO.noConflict() ⇒ ICO

No conflict.

Kind: static method of ICO
Returns: ICO - ICO Object.

ICO.isICO(arrayBuffer) ⇒ Boolean

Check the ArrayBuffer is valid ICO.

Kind: static method of ICO
Returns: Boolean - True if arg is ICO.

Param	Type	Description
arrayBuffer	ArrayBuffer	ICO file data.

Typedefs

ParsedImage : Object

Kind: global typedef
Properties

Name	Type	Description
width	Number	Image width.
height	Number	Image height.
bit	Number	Image bit depth.
buffer	ArrayBuffer	Image buffer.

License

MIT license