# jimp-compact

> Compact version of Jimp

Latest version **0.16.1-2** (published 2021-09-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install jimp-compact
pnpm add jimp-compact
yarn add jimp-compact
bun add jimp-compact
```

## 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.16.1-2 |
| Published | 2021-09-20 |
| First published | 2019-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 123 |
| Maintainers | pi0, nuxt.bot |

## Links

- npm: https://www.npmjs.com/package/jimp-compact
- Repository: https://github.com/unjs/jimp-compact
- Homepage: https://github.com/unjs/jimp-compact#readme
- Issues: https://github.com/unjs/jimp-compact/issues
- npm.io page: https://npm.io/package/jimp-compact

## Recent versions

- 0.16.1-2 (latest) — 2021-09-20
- 0.16.2 — 2021-09-20
- 0.16.1-1 — 2021-09-20
- 0.16.1 — 2020-08-28
- 0.12.1 — 2020-05-19
- 0.12.0 — 2020-05-17
- 0.10.3 — 2020-05-03
- 0.10.1 — 2020-04-05
- 0.9.8 — 2020-03-28
- 0.9.7 — 2020-03-27
- 0.9.6 — 2020-03-18
- 0.9.3 — 2019-11-26
- 0.9.1 — 2019-11-26
- 0.9.0 — 2019-11-26
- 0.8.5 — 2019-10-18
- … 8 more at https://npm.io/package/jimp-compact/versions

## README

# ✏️ Jimp Compact

<!-- [![automated](https://flat.badgen.net/badge/publish/automated/green)](#) -->
<!-- [![circle ci](https://flat.badgen.net/circleci/github/unjs/jimp-compact)](https://circleci.com/gh/unjs/jimp-compact) -->
[![npm version](https://flat.badgen.net/npm/v/jimp-compact)](https://www.npmjs.com/package/jimp-compact)
[![npm downloads](https://flat.badgen.net/npm/dm/jimp-compact)](https://www.npmjs.com/package/jimp-compact)
[![install size](https://flat.badgen.net/packagephobia/install/jimp-compact)](https://packagephobia.now.sh/result?p=jimp-compact)

> Lightweight version of [Jimp](https://github.com/oliver-moran/jimp) compiled with [vercel/ncc](https://github.com/vercel/ncc)

## Why?

This package has **27x** smaller install size with **all** features of original jimp (Jimp install size is [~33.8MB](https://packagephobia.now.sh/result?p=jimp)) by bundling all `node_modules` and removing extra files.

## Usage

Install and import/require `jimp-compact` instead of `jimp` npm package.

```sh
# npm
npm i jimp-compact

# yarn
yarn add jimp-compact
```

```js
// ESM
import Jimp from 'jimp-compact'

// CJS
const Jimp = require('jimp-compact')
```

See [jimp docs](https://github.com/oliver-moran/jimp/tree/master/packages/jimp) for full usage.

## Known Issues

In order to make typescript working, you need to (also) install `jimp` in `devDependencies`!
Track issue via [#39](https://github.com/unjs/jimp-compact/issues/39) and [#42](https://github.com/unjs/jimp-compact/issues/52).

## License

MIT - Based on [Jimp](https://github.com/oliver-moran/jimp/blob/master/LICENSE)

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