shell-image-win

Get the associated shell image for a given path on Windows, as a PNG buffer.

The shell image is the icon or thumbnail that Windows Explorer would display for the item, as extracted by IShellItemImageFactory::GetImage.

Requires Windows Vista or higher.

Installation

npm install JosephusPaye/shell-image-win --save

Usage

const { writeFileSync } = require('fs');
const { getImageForPath, flags } = require('shell-image-win');

getImageForPath('C:\\', { width: 256, height: 256, flags: flags.ResizeToFit | flags.IconBackground }, (err, imageBuffer) => {
    if (err) {
        console.error(err);
        return;
    }

    writeFileSync('image.png', imageBuffer);
});

API

getImageForPath(path, options, callback)

Get the associated shell image for a given path.

path: String

An absolute file system path or special shell: path. See this article for a list of special shell paths.

options: Object

Configuration options.

options.width: Number

The width of the image. Default is 256.

options.height: Number

The height of the image. Default is 256.

options.flags: Number

One or more of the following flags. Combine more than one flag with |, the bitwise OR operator.

• ResizeToFit
• BiggerSizeOk
• MemoryOnly
• IconOnly
• ThumbnailOnly
• InCacheOnly
• CropToSquare
• WideThumbnails
• IconBackground
• ScaleUp

The flag constants are available on the module at .flags.

callback(error, imageBuffer): Function

The function to call when the image is retrieved. callback is called with the following arguments:

• error: an error message if the function failed, null otherwise
• imageBuffer: a PNG buffer of the image retrieved

Credits

A lot of the code here was adapted from node-system-icon by @mtojo.

Related

• file-icon (macOS only)
• node-system-icon (Windows and macOS)

Licence

MIT, © 2018 Josephus Paye II