feat: Added equal property to the return value when the diff path option is specified.

index.js

@@ -102,9 +102,12 @@ const buildDiffImage = async (img1, img2, options) => {
         buf[pixelInd + 2] = B;
     };
 
+    let isExactMatch = true;
+
     await iterateRect(width, height, (x, y) => {
         if (x >= minWidth || y >= minHeight) {
             setPixel(resultBuffer, x, y, highlightColor);
+            isExactMatch = false;
             return;
         }
 
@@ -113,12 +116,15 @@ const buildDiffImage = async (img1, img2, options) => {
 
         if (!options.comparator({color1, color2, img1, img2, x, y, width, height, minWidth, minHeight})) {
             setPixel(resultBuffer, x, y, highlightColor);
+            isExactMatch = false;
         } else {
             setPixel(resultBuffer, x, y, color1);
         }
     });
 
-    return img.fromBuffer(resultBuffer, {raw: {width, height, channels: 3}});
+    const imgFromBuffer = await img.fromBuffer(resultBuffer, {raw: {width, height, channels: 3}});
+
+    return {diffImage: imgFromBuffer, isExactMatch: isExactMatch};
 };
 
 const getToleranceFromOpts = (opts) => {
@@ -224,14 +230,19 @@ exports.createDiff = async function saveDiff(opts) {
 
     const [image1, image2] = utils.formatImages(opts.reference, opts.current);
     const {first, second} = await utils.readPair(image1, image2);
-    const diffImage = await buildDiffImage(first, second, {
+    const {diffImage, isExactMatch} = await buildDiffImage(first, second, {
         highlightColor: utils.parseColorString(opts.highlightColor),
         comparator: createComparator(first, second, opts)
     });
 
-    return opts.diff === undefined
-        ? diffImage.createBuffer(opts.extension)
-        : diffImage.save(opts.diff);
+    if (opts.diff === undefined) {
+        return diffImage.createBuffer(opts.extension);
+    }
+
+    const resultSaveDiff = await diffImage.save(opts.diff);
+    resultSaveDiff.equal = isExactMatch;
+
+    return resultSaveDiff;
 };
 
 exports.colors = (color1, color2, opts) => {

test/test.js

@@ -525,6 +525,24 @@ describe('createDiff', () => {
         expect(equal).to.be.equal(true);
     });
 
+    it('should return an equal property if the diff path option is specified', async () => {
+        const equalResponse = await looksSame.createDiff({
+            reference: srcPath('ref.png'),
+            current: srcPath('same.png'),
+            diff: this.tempName,
+            highlightColor: '#ff00ff'
+        });
+        const notEqualResponse = await looksSame.createDiff({
+            reference: srcPath('ref.png'),
+            current: srcPath('different.png'),
+            diff: this.tempName,
+            highlightColor: '#ff00ff'
+        });
+
+        expect(equalResponse).to.have.property('equal', true);
+        expect(notEqualResponse).to.have.property('equal', false);
+    });
+
     describe('with comparing by areas', () => {
         it('should create diff image equal to reference', async () => {
             await looksSame.createDiff({