Adding isEqual to the public API (#140)

Author: schmidt-sebastian

package.json

@@ -53,6 +53,7 @@
     "@google-cloud/common": "^0.16.0",
     "@google-cloud/common-grpc": "^0.5.3",
     "bun": "^0.0.12",
+    "deep-equal": "^1.0.1",
     "extend": "^3.0.1",
     "functional-red-black-tree": "^1.0.1",
     "google-gax": "^0.14.3",

src/document.js

@@ -17,6 +17,7 @@
 'use strict';
 
 const assert = require('assert');
+const deepEqual = require('deep-equal');
 const is = require('is');
 
 const path = require('./path');
@@ -132,6 +133,21 @@ class GeoPoint {
     } }`;
   }
 
+  /**
+   * Returns true if this `GeoPoint` is equal to the provided value.
+   *
+   * @param {*} other The value to compare against.
+   * @return {boolean} true if this `GeoPoint` is equal to the provided value.
+   */
+  isEqual(other) {
+    return (
+      this === other ||
+      (is.instanceof(other, GeoPoint) &&
+        this.latitude === other.latitude &&
+        this.longitude === other.longitude)
+    );
+  }
+
   /**
    * Converts the GeoPoint to a google.type.LatLng proto.
    * @private
@@ -600,6 +616,23 @@ class DocumentSnapshot {
     };
   }
 
+  /**
+   * Returns true if the document's data and path in this `DocumentSnapshot` is
+   * equal to the provided value.
+   *
+   * @param {*} other The value to compare against.
+   * @return {boolean} true if this `DocumentSnapshot` is equal to the provided
+   * value.
+   */
+  isEqual(other) {
+    return (
+      this === other ||
+      (is.instance(other, DocumentSnapshot) &&
+        this._ref.isEqual(other._ref) &&
+        deepEqual(this._fieldsProto, other._fieldsProto, {strict: true}))
+    );
+  }
+
   /**
    * Converts a Google Protobuf timestamp to an ISO 8601 string.
    *

src/field-value.js

@@ -80,6 +80,16 @@ class FieldValue {
   static serverTimestamp() {
     return SERVER_TIMESTAMP_SENTINEL;
   }
+
+  /**
+   * Returns true if this `FieldValue` is equal to the provided value.
+   *
+   * @param {*} other The value to compare against.
+   * @return {boolean} true if this `FieldValue` is equal to the provided value.
+   */
+  isEqual(other) {
+    return this === other;
+  }
 }
 
 DELETE_SENTINEL = new FieldValue();

src/path.js

@@ -194,6 +194,20 @@ class Path {
   toArray() {
     return this.segments.slice();
   }
+
+  /**
+   * Returns true if this `Path` is equal to the provided value.
+   *
+   * @private
+   * @param {*} other The value to compare against.
+   * @return {boolean} true if this `Path` is equal to the provided value.
+   */
+  isEqual(other) {
+    return (
+      this === other ||
+      (is.instanceof(other, this.constructor) && this.compareTo(other) === 0)
+    );
+  }
 }
 
 /**
@@ -562,6 +576,16 @@ class FieldPath extends Path {
   construct(segments) {
     return new FieldPath(segments);
   }
+
+  /**
+   * Returns true if this `FieldPath` is equal to the provided value.
+   *
+   * @param {*} other The value to compare against.
+   * @return {boolean} true if this `FieldPath` is equal to the provided value.
+   */
+  isEqual(other) {
+    return super.isEqual(other);
+  }
 }
 
 /**