From a0b245bfe1a9063bc93061bbe271449d464fc914 Mon Sep 17 00:00:00 2001
From: Slamakans <slamakanss@gmail.com>
Date: Sun, 4 Dec 2016 03:34:26 +0100
Subject: [PATCH] equals function added (#948)

Adds an equals function that checks for differing size and differing
key-value pairs, and takes into account the edge case for when there's
an entry for the key, but the value is undefined.
---
 src/util/Collection.js | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/util/Collection.js b/src/util/Collection.js
index abda090c9..55e2f8dcb 100644
--- a/src/util/Collection.js
+++ b/src/util/Collection.js
@@ -329,6 +329,22 @@ class Collection extends Map {
     }
     return returns;
   }
+
+  /**
+   * Returns true if the collections have identical key-value pairings.
+   * This is different to checking for equality using equal-signs, because
+   * the collections may be different objects, but functionally identical.
+   * @param {Collection} collection Collection to compare with.
+   * @returns {boolean}
+   */
+  equals(collection) {
+    if (this === collection) return true;
+    if (this.size !== collection.size) return false;
+    return !this.find((value, key) => {
+      const testVal = collection.get(key);
+      return testVal !== value || (testVal === undefined && !collection.has(key));
+    });
+  }
 }
 
 module.exports = Collection;