@bouzuya/compare-images

node-compare-images

A library to compare images for Node.js.

Installation

npm install @bouzuya/compare-images

Usage

import * as assert from 'assert';
import {
  compareImages,
  getDiffImage,
  isSame
} from '@bouzuya/compare-images';

// image1: { data: Buffer; height: number; width: number; }
const image1 = /* ... */;
const image2 = /* ... */;
const result = compareImages(image1, image2);
assert(isSame(result) === false);
// diffImage: { data: Buffer; height: number; width: number; }
const diffImage = getDiffImage(result);

import * as assert from 'assert';
import {
  compareImages,
  getDiffDimension,
  isSameDimension
} from '@bouzuya/compare-images';

// image1: { data: Buffer; height: number; width: number; }
const image1 = /* ... */;
const image2 = /* ... */;
const result = compareImages(image1, image2);
assert(isSameDimension(result) === false);
// diffDimension: {
//   height: number; // image1.height - image2.height
//   width: number; // image1.width - image2.width
// }
const diffDimension = getDiffDimension(result);

Badges

License

MIT

Author

bouzuya <[e-mail]> (http://bouzuya.net)