https://github.com/sentialx/extract-file-icon

Get associated file icon
https://github.com/sentialx/extract-file-icon

file icon library native node typescript windows

Last synced: 3 months ago
JSON representation

Get associated file icon

• Host: GitHub
• URL: https://github.com/sentialx/extract-file-icon
• Owner: sentialx
• License: mit
• Archived: true
• Created: 2019-02-23T16:25:48.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T14:17:05.000Z (almost 2 years ago)
• Last Synced: 2024-05-29T18:33:35.544Z (5 months ago)
• Topics: file, icon, library, native, node, typescript, windows
• Language: C++
• Size: 103 KB
• Stars: 23
• Watchers: 3
• Forks: 5
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - extract-file-icon

README

        
# extract-file-icon

Get associated file icon for Node.js.

# Installation

To install this package, just run

```bash

$ npm install extract-file-icon

```

# Quick start

The following example shows how to get the currently focused window's title and hide it.

```javascript

const fileIcon = require("extract-file-icon");

const icon = fileIcon('path', 32); // Returns PNG buffer of 32x32 file icon at given path. 

```

# Documentation

## Default exported method `getFileIcon(path: string, size: number)`

- `path` string

- `size` number - by default its value is 64. On Windows it can be only 16, 32, 64 or 256.