# extract-file-icon

> Get associated file icon

Latest version **0.3.2** (published 2019-11-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install extract-file-icon
pnpm add extract-file-icon
yarn add extract-file-icon
bun add extract-file-icon
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2019-11-18 |
| First published | 2019-02-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 13.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | sentialx |
| Maintainers | sential |
| Keywords | file, icon, windows, extract |

## Links

- npm: https://www.npmjs.com/package/extract-file-icon
- Repository: https://github.com/sentialx/extract-file-icon
- Issues: https://github.com/sentialx/extract-file-icon/issues
- npm.io page: https://npm.io/package/extract-file-icon

## Dependencies (1)

- [node-addon-api](https://npm.io/package/node-addon-api.md) 1.7.1

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 0.3.2 (latest) — 2019-11-18
- 0.3.1 — 2019-06-25
- 0.3.0 — 2019-06-16
- 0.2.0 — 2019-06-16
- 0.1.4 — 2019-04-18
- 0.1.3 — 2019-04-11
- 0.1.2 — 2019-04-11
- 0.1.1 — 2019-02-23
- 0.1.0 — 2019-02-23

## 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.

---
_Source: https://npm.io/package/extract-file-icon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._