image-editor v0.2.0

Image editor

A image editor library

Example

const ie = require('image-editor');

ie.readFile('./input.png')
    .then(buffer => ie.edit(buffer, 'image/png', 'square', 'Hello'))
    .then(buffer => ie.writeFile(buffer, './output.png'))
    .then(() => console.log('Done'));

Dependencies

Like gm library, you need install GraphicsMagick on your computer.

API Reference

ImageEditor

• ImageEditor
  • ImageEditor#edit(buffer, mimetype, type, text, color, fontSize, filter, customWidth, customHeight) => Promise
  • ImageEditor#readFile(path) => Promise
  • ImageEditor#writeFile(buffer, path) => Promise
  • ImageEditor#applyType(buffer, mimetype, type, customWidth, customHeight) => Promise
  • ImageEditor#applyFilter(buffer, mimetype, filter) => Promise
  • ImageEditor#size(buffer) => Promise
  • ImageEditor#write(buffer, text, width, height, position, color, fontSize) => Promise
  • ImageEditor#resize(buffer, width, height, option) => Promise
  • ImageEditor#crop(buffer, width, height, gravity, x, y) => Promise
  • ImageEditor#blur(buffer, radius, sigma) => Promise
  • ImageEditor#mono(buffer) => Promise
  • ImageEditor#sepia(buffer) => Promise
  • ImageEditor#mosaic(buffer) => Promise
  • ImageEditor#negative(buffer) => Promise
  • ImageEditor#paint(buffer, radius`) => Promise
  • ImageEditor#pixelate(buffer, mimetype, size) => Promise

ImageEditor#edit(buffer, mimetype, type, text, color, fontSize, filter, customWidth, customHeight)=> Promise

Edit an image

Kind: Exported function

ImageEditor#readFile(path) => Promise

Read file and return buffer

Kind: Exported function

ImageEditor#writeFile(buffer, path) => Promise

Write file from buffer to path

Kind: Exported function

ImageEditor#applyType(buffer, mimetype, type, customWidth, customHeight) => Promise

Apply type

Kind: Exported function

ImageEditor#applyFilter(buffer, mimetype, filter) => Promise

Apply filters

Kind: Exported function

ImageEditor#size(buffer) => Promise

Get size of picture

Kind: Exported function

ImageEditor#write(buffer, text, width, height, position, color, fontSize) => Promise

Write something on picture

Kind: Exported function

ImageEditor#resize(buffer, width, height, option) => Promise

Resize picture

Kind: Exported function

ImageEditor#crop(buffer, width, height, gravity, x, y) => Promise

Crop picture

Kind: Exported function

ImageEditor#blur(buffer, radius, sigma) => Promise

Blur image

Kind: Exported function

ImageEditor#mono(buffer) => Promise

Mono

Kind: Exported function

ImageEditor#sepia(buffer) => Promise

Sepia

Kind: Exported function

ImageEditor#mosaic(buffer) => Promise

Mosaic

Kind: Exported function

ImageEditor#negative(buffer) => Promise

Negative

Kind: Exported function

ImageEditor#paint(buffer, radius`) => Promise

Paint

Kind: Exported function

ImageEditor#pixelate(buffer, mimetype, size) => Promise

Pixelate

Kind: Exported function