1.0.5 • Published 3 years ago

lnk-icon-extractor v1.0.5

Weekly downloads
4
License
MIT
Repository
github
Last release
3 years ago

lnk-icon-extractor

A fork of file-icon-extractor which gets the icon of the target of the lnk

Installation

$ npm i file-icon-extractor

Usage

const icon = require('file-icon-extractor');

icon.extract(filePath, destinationPath, format);

parameterexplanation
filePathA valid file path (string) or array of file paths for the file(s) you wish to fetch icon(s) from.
destinationPathWhere you want to save the output image (directory).
format (optional)Output image format. (png, jpeg, gif, etc.) Default is png.

Quick Start

const icon = require('file-icon-extractor');

// Extract singluar icon
icon.extract("C:\\Users\\USERNAME\\AppData\\Local\\slack\\slack.exe", "C:\\Users\\USERNAME\\Documents");
const icon = require('file-icon-extractor');

var programs = [
    "C:\\Users\\USERNAME\\AppData\\Local\\Programs\\Microsoft VS Code\\Code.exe",
    "C:\\Users\\USERNAME\\AppData\\Local\\slack\\slack.exe"
]

// Extract mutiple icons (as jpeg)
icon.extract(programs, "C:\\Users\\USERNAME\\Documents", "jpeg");

Support

PlatformDetails
Windows:Support has been tested and confirmed on Windows as of v1.0.4 for any filetype with an icon association in explorer, this includes .exe files.
Linux:Theoretically support should exist; however, as of v1.0.4 this has not yet been thoroughly tested.
Mac OS:Theoretically support should exist; however, as of v1.0.4 this has not yet been thoroughly tested.

Issues

Please submit any issues through the issues tab on GitHub.