0.1.4 • Published 10 years ago

cuttingboard v0.1.4

Weekly downloads
3
License
ISC
Repository
github
Last release
10 years ago

cuttingboard

An image processing library with multiple storage support. Inspired by papercut.

Getting Started

First, download and install GraphicsMagick or ImageMagick.

Installation

$ npm install cuttingboard

Usage

var Cuttingboard = require("cuttingboard");
var board = new Cuttingboard();

board.style("thumb", { size: "50x50", method: "crop", format: "png" })
     .style("small", { size: "80x80", method: "resize" });

board.process({ src: "/path/to/image" }, function(err, images) {
  //-- images:
  // {
  //   original: "image-original.jpg",
  //   thumb: "image-thumb.png",
  //   small: "image-small.jpg"
  // }
});

//-- save files to a folder using a custom file name
var board = new Cuttingboard({
  folder: "/tmp/my-folder",
  name: "my-image"
});

//-- upload to s3
var board = new Cuttingboard({
  storage: "s3",
  bucket: "my-bucket",
  key: "AWS_ACCESS_KEY",
  secret: "AWS_SECRET_KEY"
});

//-- set the default image format
var board = new Cuttingboard({
  format: "jpg"
});

//-- override the default image format
board.style("thumb", { size: "50x50", method: "crop", format: "png" })
     .style("small", { size: "80x80", method: "resize" });

board.process({ src: "/path/to/image", format: "gif" }, function(err, images) {
  //-- images:
  // {
  //   original: "image-original.gif",
  //   thumb: "image-thumb.png",
  //   small: "image-small.gif"
  // }
});

//-- using baseUrl
var board = new Cuttingboard({
  folder: "./my-folder",
  baseUrl: "http://assets.localhost/images"
});

board.process({ src: "/path/to/image",  }, function(err, images) {
  //-- images:
  // {
  //   original: "http://assets.localhost/images/my-folder/image-original.jpg"
  // }
});

var board = new Cuttingboard({
  folder: "my-folder",
  baseUrl: "http://assets.localhost/images"
});

board.process({ src: "/path/to/image",  }, function(err, images) {
  //-- images:
  // {
  //   original: "http://assets.localhost/images/image-original.jpg"
  // }
});

//-- with src option
var board = new Cuttingboard({
  src: "/path/to/image"
});

board.process(function(err, images) {
  //-- images:
  // {
  //   original: "image-original.jpg"
  // }
});

board.process({}, function(err, images) {
  //-- images:
  // {
  //   original: "image-original.jpg"
  // }
});