Optimized node-resemble.js

Fork of node-resemble.js with async await.

Analyse and compare images with Javascript. This project does not need canvas or any other binary dependencies. It is a modification of Resemble.js

Installation

npm install @wowkster/resemble

Example

Retrieve basic analysis on image.

// Callback

const api = resemble(fileData).onComplete(function (data) {
    console.log(data)
    /*
      {
        red: 255,
        green: 255,
        blue: 255,
        brightness: 255
      }
   */
})

// Async/Await

const data = await resemble(fileData).async()
console.log(data)
/*
  {
    red: 255,
    green: 255,
    blue: 255,
    brightness: 255
  }
*/

Use resemble to compare two images.

// Callback

const diff = resemble(file)
    .compareTo(file2)
    .ignoreColors()
    .onComplete(data => {
        console.log(data)
        /*
          {
            misMatchPercentage : 100, // %
            isSameDimensions: true, // or false
            dimensionDifference: { width: 0, height: -1 }, // defined if dimensions are not the same
            getImageDataUrl: function(){}
          }
        */
    })

// Async/Await

const data = await resemble(file).compareTo(file2).ignoreColors().async()
console.log(data)

/*
 {
   misMatchPercentage : 100, // %
   isSameDimensions: true, // or false
   dimensionDifference: { width: 0, height: -1 }, // defined if dimensions are not the same
   getImageDataUrl: function(){}
 }
*/

You can also change the comparison method after the first analysis.

// diff.ignoreNothing();
// diff.ignoreColors();
diff.ignoreAntialiasing()

And change the output display style.

resemble.outputSettings({
    errorColor: {
        red: 255,
        green: 0,
        blue: 255,
    },
    errorType: 'movement',
    transparency: 0.3,
})
// resembleControl.repaint();

Credits:

• Created by James Cryer and the Huddle development team.
• Lukas Svoboda - modification for node.js
• Mirza Zeyrek - jpeg support
• LarryG - dependency updates
• Wowkster - updated for async/await