squarifier

1.1.3 • Public • Published

GitHub license npm package npm package Build Status

squarifier

Description

Transforms images in a directory to perfect squares.

Installation

npm i squarifier

Usage

If you want to squarify all of the images in a given directory with a max size of 1200 pixels and fill the margin with a black background color, you can do the following:

Solution 1: code example

let squarifier = require('squarifier');

squarifier('path/to/img/folder', 1200, 0x000000FF)
  .catch(err => {
    console.log(err);
  }).then((counter) => {
    console.log(`Done. Changed ${counter} files.`);
  });

Solution 2: CLI

node path/to/squarifier/index.js -d path/to/img/folder -s 1200 -c 0x000000FF

For more examples, see examples.

CLI options

-d, --directory [path] target directory (required)

-s --size [integer] output canvas size (default is 1000)

-c --color [0xrrggbbaa] background color (default is 0xffffffff)

-h, --help output usage information

Supported image formats

  • bmp
  • gif
  • jpeg
  • png
  • tiff

Other formats will be ignored.

Requirements

  • Node version 7.6.0 and above

Author

  • Christoffer Ekblom

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.1.3
    1
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 1.1.3
    1
  • 1.1.2
    0
  • 1.1.1
    0
  • 1.1.0
    1

Package Sidebar

Install

npm i squarifier

Weekly Downloads

2

Version

1.1.3

License

ISC

Unpacked Size

422 kB

Total Files

19

Last publish

Collaborators

  • christoffer-ekblom