resize-img
Version:
Resize images in memory
68 lines (37 loc) • 1.03 kB
Markdown
# resize-img [](https://travis-ci.org/kevva/resize-img)
> Resize images in memory
## Install
```
$ npm install resize-img
```
## Usage
```js
const fs = require('fs');
const resizeImg = require('resize-img');
(async () => {
const image = await resizeImg(fs.readFileSync('unicorn.png'), {
width: 128,
height: 128
});
fs.writeFileSync('unicorn-128x128.png', image);
})();
```
## API
### resizeImg(buffer, options)
Returns a `Promise<Buffer>` with the resized image.
#### buffer
Type: `Buffer`
An image buffer. Supported formats are `bmp`, `jpg` and `png`.
#### options
Type: `Object`
##### width
Type: `number`
Desired width of the target image.
##### height
Type: `number`
Desired height of the target image.
##### format
Type: `string`
The output file format for the target image. Supported formats are `bmp`, `jpg` and `png`.
## Related
* [resize-img-cli](https://github.com/kevva/resize-img-cli) - CLI for this module.