JSPM

  • Created
  • Published
  • Downloads 142199
  • Score
    100M100P100Q163813F
  • License MIT

Pure node.js library for comparing PNG-images, taking into account human color perception.

Package Exports

  • looks-same

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 (looks-same) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

LooksSame

Build Status

Pure node.js library for comparing PNG-images, taking into account human color perception. It is created specially for the needs of visual regression testing for gemini utility, but can be used for other purposes.

Comparing images

var looksSame = require('looks-same');

looksSame('image1.png', 'image2.png', function(error, equal) {
    //equal will be true, if images looks the same
});

Parameters can be paths to files or buffer with compressed png image.

By default, it will detect only noticeable differences. If you wish to detect any difference, use strict options:

looksSame('image1.png', 'image2.png', {strict: true}, function(error, equal) {
    ...
});

For visual regression tasks it may be useful to ignore text caret in text input elements. You can do it with ignoreCaret option.

looksSame('image1.png', 'image2.png', {ignoreCaret: true}, function(error, equal) {
    ...
});

Both strict and ignoreCaret can be set independently of one another.

Building diff image

looksSame.createDiff({
    reference: '/path/to/reference/image.png',
    current: '/path/to/reference/image.png',
    diff: '/path/to/save/diff/to.png',
    highlightColor: '#ff00ff' //color to highlight the differences
    strict: true //strict comparsion
}, function(error) {
});