Skip to content

Latest commit

 

History

History
92 lines (67 loc) · 2.69 KB

README.md

File metadata and controls

92 lines (67 loc) · 2.69 KB

💜If you like my projects, you can support me.

Coin/Symbol Network Adress
Bitcoin (BTC) BTC 1LU7DtLiKkWe3aAXbhRhNAMUFdrapWuAHW
Tether (USDT) TRC20 TK7f7TXozWVbkHxdArAJd2rELu725q1Ac5
Tether (USDT) TON UQDI4e7xm_B7O_REaYd5CoyEz1Ki08t0EPlUim022_K9B2xa

macIconForFile npm version

Get the native macOS icon for a specific file extension as a PNG image buffer.

Inspired and based on:

Retrieves icon, exactly the same way as Finder does it, including QuickLook preview generation in case if it's possible, just check out the example at the end of this page. My motivation to write this module was impossiblity to obtain file system's entry icon in Electron, there is simply no method to do that.

Installation

npm install mac-file-icon

Usage

var getIconForFile = require('mac-file-icon');
getIconForFile('/Users/', function(buffer) {
  console.info(buffer);
});

You can always convert Buffer into it's base64 representation:

var getIconForFile = require('mac-file-icon');
getIconForFile('/Users/', function(buffer) {
  console.info(buffer.toString('base64'));
});

In case if callback is ommited, Buffer will be returned in synchronous way:

var getIconForFile = require('mac-file-icon');
console.info(getIconForFile('/Users/'));

By default, icon size is set to 32x32, you can adjust it by passing additional argument:

var getIconForFile = require('mac-file-icon');
// icon size 64x64
getIconForFile('/Users/', function(buffer) {
  console.info(buffer);
}, 64);

Works same way in synchronous calls:

var getIconForFile = require('mac-file-icon');
// icon size 64x64
console.info(getIconForFile('/Users/', 64));

Build it yourself

cd macIconForFile
npm install
node-gyp configure
node-gyp build

However I'm not sure if last two statements are required...

Example

You can try out an example included into the package, that uses Express, Histone and macIconForFile to generate file listing in the browser.

npm install mac-file-icon
cd node_modules/mac-file-icon/example
npm install
node index.js

Then open your web browser and navigate to http://localhost:8080/ (in case if this port number is taken, edit index.js and set another one), you will see something like this:

Show case of how it looks like