# smartcrop-gm

> smartcrop adapter for gm / imagemagick

Latest version **2.0.2** (published 2018-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install smartcrop-gm
pnpm add smartcrop-gm
yarn add smartcrop-gm
bun add smartcrop-gm
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2018-02-11 |
| First published | 2016-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonas Wagner |
| Maintainers | jonas |

## Links

- npm: https://www.npmjs.com/package/smartcrop-gm
- npm.io page: https://npm.io/package/smartcrop-gm

## Dependencies (2)

- [gm](https://npm.io/package/gm.md) ^1.23.1
- [smartcrop](https://npm.io/package/smartcrop.md) ^2.0.2

## Recent versions

- 2.0.2 (latest) — 2018-02-11
- 1.0.2 — 2016-09-16
- 1.0.1 — 2016-06-25
- 1.0.0 — 2016-06-25

## README

# smartcrop-gm

[![Build Status](https://travis-ci.org/jwagner/smartcrop-gm.svg?branch=master)](https://travis-ci.org/jwagner/smartcrop-gm)

This is an adapter module for using [smartcrop.js](https://github.com/jwagner/smartcrop.js)
with node.js using [gm](https://github.com/aheckmann/gm) for image decoding.

Smartcrop-gm requires image magick to be installed and available in `$PATH` to function.

## Installation

```
npm install --save smartcrop-gm
```

## API

## crop(image, options)

**Image:** string (path to file) or buffer

**Options:** options object to be passed to smartcrop

**returns:** A promise for a cropResult

## Example

```javascript
var request = require('request');
var gm = require('gm').subClass({ imageMagick: true });
var smartcrop = require('smartcrop-gm');

function applySmartCrop(src, dest, width, height) {
  request(src, { encoding: null }, function process(error, response, body) {
    if (error) return console.error(error);
    smartcrop.crop(body, { width: width, height: height }).then(function(result) {
      var crop = result.topCrop;
      gm(body)
        .crop(crop.width, crop.height, crop.x, crop.y)
        .resize(width, height)
        .write(dest, function(error) {
          if (error) return console.error(error);
        });
    });
  });
}

var src = 'https://raw.githubusercontent.com/jwagner/smartcrop-gm/master/test/flower.jpg';
applySmartCrop(src, 'flower-square.jpg', 128, 128);
```

## Face Detection

Check out [smartcrop-cli](https://github.com/jwagner/smartcrop-cli/) for a more advanced [example](https://github.com/jwagner/smartcrop-cli/blob/master/smartcrop-cli.js#L100) of how to use smartcrop from node including face detection with opencv.

## Security Considerations

smartcrop-gm is using imagemagick for decoding and resampling images.
A number of [security issues](https://imagetragick.com/) have been found in imagemagick recently.
Make sure that you take the appropriate steps to protect your infrastructure.

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