png-compare

Compare png files natively using node.js

Usage no npm install needed!

<script type="module">
  import pngCompare from 'https://cdn.skypack.dev/png-compare';
</script>

README

PNG-COMPARE

Build Status

Description

This module uses imagemagick's compare command to compare two identically sized png images.

(baseline, comparator, options*) ⇒ variance

Kind: function

Parameters

Param Type Description
baseline String the location of the baseline png you want to compare against
comparator String the location of the comparator png you want to compare to the baseline

Returns

Name Type Description
variance Number the percentage of pixels that are different on the comparator png when compared to the baseline

Installation

npm install png-compare

Pre-requisites

Node

This module is tested on Node versions 4.x, 5.x, 6.x and 7.x via Travis-CI. The status of these tests can be seen on the module's travis page.

Imagemagick

MacOS
  • brew install imagemagick
Ubuntu
  • sudo apt-get install imagemagick