https://github.com/chenglou/png-crop

Small PNG cropping utility, written in pure JS for Node.
https://github.com/chenglou/png-crop

Last synced: 17 days ago
JSON representation

Small PNG cropping utility, written in pure JS for Node.

• Host: GitHub
• URL: https://github.com/chenglou/png-crop
• Owner: chenglou
• Created: 2014-03-10T02:47:54.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-03-20T23:29:43.000Z (over 6 years ago)
• Last Synced: 2024-10-13T11:15:48.909Z (about 1 month ago)
• Language: JavaScript
• Size: 22.5 KB
• Stars: 22
• Watchers: 5
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md

Awesome Lists containing this project

README

        
# PNG Crop

Small PNG crop utility, written in pure JS for Node.

```bash

npm install png-crop

```

## Usage

(_Check out the example folder._)

Both methods take a image path/stream/buffer as input, and a configuration with the keys `width`, `height` (mandatory, can be arbitrarily large) and `top` and `left` (optional).

### Crop and output to file

```js

var PNGCrop = require('png-crop');

// if you don't know the image's dimension and want to crop for a point all the

// way til bottom right, just pass a big width/height

var config1 = {width: 100, height: 62, top: 95, left: 110};

// pass a path, a buffer or a stream as the input

PNGCrop.crop('1.png', 'expectedCropTopLeftConfig.png', config1, function(err) {

  if (err) throw err;

  console.log('done!');

});

```

### Crop and get the output stream

```js

var PNGCrop = require('png-crop');

// optionally pass top and left to the configurations as the upper left corner

// from which to start cropping

var config2 = {width: 53, height: 114};

var imgBuffer = fs.readFileSync('1.png');

PNGCrop.cropToStream(imgBuffer, config2, function(err, outputStream) {

  if (err) throw err;

  outputStream.pipe(fs.createWriteStream('expectedCrop.png'));

});

```

## License

MIT.