JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 118
  • Score
    100M100P100Q50048F
  • License ISC

A simple library for circular cropping of images. This package can create several versions of the same image and upload them to S3

Package Exports

  • circle-image

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (circle-image) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Circle-Image

Github

Pull request and issues tracked here: https://github.com/eenewbsauce/circle-image

NPM

Official home on NPM: https://www.npmjs.com/package/circle-image

Install Dependencies

circle-image is based on ImageMagick. You can install it one of the following ways:

On Ubuntu

$ apt-get install ImageMagick

On Mac OS X

$ brew install ImageMagick

On CentOS

$ yum install ImageMagick

Installation

npm install circle-image --save

Usage

Make sure you have a folder called "uploads" in the root of your node application (ie: app.js). The image (imagepath) dimensions need to be larger than the biggest size specified in imageSizes below.

var images = require('circle-image');
var imageSizes = [125, 100, 30];
//uniqueId param is used to identify a user
//so use the primary key or something guaranteed to be unique
images.execute('imagepath', uniqueId, imageSizes).then(function (paths) {
  //array of circularized image paths
  console.log(paths[0]); //circle_user_{uniqueId}_125.png
})