to-ico
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/to-ico package

    1.1.5 • Public • Published

    to-ico Build Status

    Convert PNG to ICO in memory

    Install

    $ npm install --save to-ico
    

    Usage

    const fs = require('fs');
    const toIco = require('to-ico');
     
    const files = [
        fs.readFileSync('unicorn-16x16.png'),
        fs.readFileSync('unicorn-32x32.png')
    ];
     
    toIco(files).then(buf => {
        fs.writeFileSync('favicon.ico', buf);
    });

    API

    toIco(input, [options])

    input

    Type: Array string

    Array of PNG image buffers.

    The images must have a size of 16x16, 24x24, 32x32, 48x48, 64x64, 128x128 or 256x256 and they must have an 8 bit per sample (channel) bit-depth (on Unix you can check this with the file command: RGB(A) is supported, while colormap is not, because it's 8 bits per pixel instead of 8 bits per channel, which is 24 or 32 bits per pixel depending on the presence of the alpha channel). These are limitations in the underlying pngjs library. If you have a colormap PNG you can convert it to an RGB/RGBA PNG with commonly used image editing tools.

    options

    resize

    Type: boolean
    Default: false

    Use the largest image and resize to sizes defined using the sizes option.

    sizes

    Type: Array
    Default: [16, 24, 32, 48, 64, 128, 256]

    Array of sizes to use when resizing.

    Related

    License

    MIT © Kevin Martensson

    Install

    npm i to-ico

    DownloadsWeekly Downloads

    105,267

    Version

    1.1.5

    License

    MIT

    Last publish

    Collaborators

    • avatar