# @igor-arkhipov/ico-convert-fork

> Convert Image to ICO file format (fork)

Latest version **0.0.15** (published 2021-07-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @igor-arkhipov/ico-convert-fork
pnpm add @igor-arkhipov/ico-convert-fork
yarn add @igor-arkhipov/ico-convert-fork
bun add @igor-arkhipov/ico-convert-fork
```

Provides the command `ico-convert`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.15 |
| Published | 2021-07-30 |
| First published | 2021-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 3 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | igor-arkhipov |
| Maintainers | igor-arkhipov |
| Keywords | converter, ico |

## Links

- npm: https://www.npmjs.com/package/@igor-arkhipov/ico-convert-fork
- Repository: https://github.com/igor-arkhipov/ico-convert
- Issues: https://github.com/igor-arkhipov/ico-convert/issues
- npm.io page: https://npm.io/package/@igor-arkhipov/ico-convert-fork

## Dependencies (3)

- [meow](https://npm.io/package/meow.md) ^9.0.0
- [sharp](https://npm.io/package/sharp.md) ^0.27.1
- [@igor-arkhipov/ico-fork](https://npm.io/package/@igor-arkhipov/ico-fork.md) ^0.0.5

## 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
- [stockfish](https://npm.io/package/stockfish.md) — 27.0K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads

## Recent versions

- 0.0.15 (latest) — 2021-07-30
- 0.0.14 — 2021-07-30
- 0.0.13 — 2021-07-30
- 0.0.12 — 2021-07-30

## README

# ico-convert

![badge](https://github.com/igor-arkhipov/ico-convert/workflows/Node.js%20Package/badge.svg)

> Convert Image to [ICO file format](<https://en.wikipedia.org/wiki/ICO_(file_format)>).

## Installation

```bash
npm install @igor-arkhipov/ico-convert
```

## Usage

```js
import fs from 'fs'
import { convert } from '@igor-arkhipov/ico-convert'

const buf = fs.readFileSync('input.png') // image must be squre, 256x256 pixels or larger
convert(buf).then((data) => {
  fs.writeFileSync('output.ico', data)
})
```

### Specify image for each size

```js
const bufs = [
  fs.readFileSync('16x16.png'),
  fs.readFileSync('24x24.png'),
  fs.readFileSync('32x32.png'),
  fs.readFileSync('48x48.png'),
  fs.readFileSync('64x64.png'),
  fs.readFileSync('128x128.png'),
  fs.readFileSync('256x256.png'),
]
convert(bufs).then((data) => {
  fs.writeFileSync('output.ico', data)
})
```

## CLI

```bash
npm install -g @igor-arkhipov/ico-convert
ico-convert icon.png
```

or use via npx

```bash
npx @igor-arkhipov/ico-convert icon.png
```

---
_Source: https://npm.io/package/@igor-arkhipov/ico-convert-fork · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
