@turf/boolean-equal 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -4,36 +4,49 @@
 
 ## booleanEqual
 
-Determine whether two geometries of the same type have identical X,Y coordinate values.
-See [https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/spatial-relationships.htm][1]
+Determines whether two geometries or features of the same type have identical X,Y coordinate values and properties.
+See [http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm][1]
 
-**Parameters**
+### Parameters
 
--   `feature1` **([Geometry][2] \| [Feature][3])** GeoJSON input
--   `feature2` **([Geometry][2] \| [Feature][3])** GeoJSON input
+*   `feature1` **([Geometry][2] | [Feature][3])** GeoJSON input
+*   `feature2` **([Geometry][2] | [Feature][3])** GeoJSON input
+*   `options` **[Object][4]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.precision` **[number][5]** decimal precision to use when comparing coordinates (optional, default `6`)
+
+### Examples
 
 ```javascript
 var pt1 = turf.point([0, 0]);
 var pt2 = turf.point([0, 0]);
 var pt3 = turf.point([1, 1]);
+var pt4 = turf.point([0, 0], {prop: 'A'});
+var pt5 = turf.point([0, 0], {prop: 'B'});
 
 turf.booleanEqual(pt1, pt2);
 //= true
 turf.booleanEqual(pt2, pt3);
 //= false
+turf.booleanEqual(pt4, pt5);
+//= false
+turf.booleanEqual(pt4.geometry, pt5.geometry);
+//= true
 ```
 
-Returns **[boolean][4]** true if the objects are equal, false otherwise
+Returns **[boolean][6]** true if the objects are equal, false otherwise
 
-[1]: https://desktop.arcgis.com/en/arcmap/latest/manage-data/using-sql-with-gdbs/spatial-relationships.htm
+[1]: http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm
 
 [2]: https://tools.ietf.org/html/rfc7946#section-3.1
 
 [3]: https://tools.ietf.org/html/rfc7946#section-3.2
 
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
 <!-- This file is automatically generated. Please don't edit it directly:
 if you find an error, edit the source file (likely index.js), and re-run

package/dist/es/index.js

@@ -8,6 +8,8 @@ import { getGeom } from "@turf/invariant";
  * @name booleanEqual
  * @param {Geometry|Feature} feature1 GeoJSON input
  * @param {Geometry|Feature} feature2 GeoJSON input
+ * @param {Object} [options={}] Optional parameters
+ * @param {number} [options.precision=6] decimal precision to use when comparing coordinates
  * @returns {boolean} true if the objects are equal, false otherwise
  * @example
  * var pt1 = turf.point([0, 0]);
@@ -19,12 +21,20 @@ import { getGeom } from "@turf/invariant";
  * turf.booleanEqual(pt2, pt3);
  * //= false
  */
-function booleanEqual(feature1, feature2) {
-    var type1 = getGeom(feature1).type;
-    var type2 = getGeom(feature2).type;
+function booleanEqual(feature1, feature2, options = {}) {
+    let precision = options.precision;
+    precision =
+        precision === undefined || precision === null || isNaN(precision)
+            ? 6
+            : precision;
+    if (typeof precision !== "number" || !(precision >= 0)) {
+        throw new Error("precision must be a positive number");
+    }
+    const type1 = getGeom(feature1).type;
+    const type2 = getGeom(feature2).type;
     if (type1 !== type2)
         return false;
-    var equality = new GeojsonEquality({ precision: 6 });
+    const equality = new GeojsonEquality({ precision: precision });
     return equality.compare(cleanCoords(feature1), cleanCoords(feature2));
 }
 export default booleanEqual;

package/dist/js/index.d.ts

@@ -1,4 +1,4 @@
-import { Feature, Geometry } from "@turf/helpers";
+import { Feature, Geometry } from "geojson";
 /**
  * Determine whether two geometries of the same type have identical X,Y coordinate values.
  * See http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm
@@ -6,6 +6,8 @@ import { Feature, Geometry } from "@turf/helpers";
  * @name booleanEqual
  * @param {Geometry|Feature} feature1 GeoJSON input
  * @param {Geometry|Feature} feature2 GeoJSON input
+ * @param {Object} [options={}] Optional parameters
+ * @param {number} [options.precision=6] decimal precision to use when comparing coordinates
  * @returns {boolean} true if the objects are equal, false otherwise
  * @example
  * var pt1 = turf.point([0, 0]);
@@ -17,5 +19,7 @@ import { Feature, Geometry } from "@turf/helpers";
  * turf.booleanEqual(pt2, pt3);
  * //= false
  */
-declare function booleanEqual(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry): boolean;
+declare function booleanEqual(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry, options?: {
+    precision?: number;
+}): boolean;
 export default booleanEqual;

package/dist/js/index.js

@@ -1,11 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var geojson_equality_1 = __importDefault(require("geojson-equality"));
-var clean_coords_1 = __importDefault(require("@turf/clean-coords"));
-var invariant_1 = require("@turf/invariant");
+const tslib_1 = require("tslib");
+const geojson_equality_1 = tslib_1.__importDefault(require("geojson-equality"));
+const clean_coords_1 = tslib_1.__importDefault(require("@turf/clean-coords"));
+const invariant_1 = require("@turf/invariant");
 /**
  * Determine whether two geometries of the same type have identical X,Y coordinate values.
  * See http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm
@@ -13,6 +11,8 @@ var invariant_1 = require("@turf/invariant");
  * @name booleanEqual
  * @param {Geometry|Feature} feature1 GeoJSON input
  * @param {Geometry|Feature} feature2 GeoJSON input
+ * @param {Object} [options={}] Optional parameters
+ * @param {number} [options.precision=6] decimal precision to use when comparing coordinates
  * @returns {boolean} true if the objects are equal, false otherwise
  * @example
  * var pt1 = turf.point([0, 0]);
@@ -24,12 +24,20 @@ var invariant_1 = require("@turf/invariant");
  * turf.booleanEqual(pt2, pt3);
  * //= false
  */
-function booleanEqual(feature1, feature2) {
-    var type1 = invariant_1.getGeom(feature1).type;
-    var type2 = invariant_1.getGeom(feature2).type;
+function booleanEqual(feature1, feature2, options = {}) {
+    let precision = options.precision;
+    precision =
+        precision === undefined || precision === null || isNaN(precision)
+            ? 6
+            : precision;
+    if (typeof precision !== "number" || !(precision >= 0)) {
+        throw new Error("precision must be a positive number");
+    }
+    const type1 = invariant_1.getGeom(feature1).type;
+    const type2 = invariant_1.getGeom(feature2).type;
     if (type1 !== type2)
         return false;
-    var equality = new geojson_equality_1.default({ precision: 6 });
+    const equality = new geojson_equality_1.default({ precision: precision });
     return equality.compare(clean_coords_1.default(feature1), clean_coords_1.default(feature2));
 }
 exports.default = booleanEqual;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/boolean-equal",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf boolean-equal module",
   "author": "Turf Authors",
   "contributors": [
@@ -34,6 +34,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -44,13 +45,13 @@
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
+    "bench": "tsx bench.js",
     "build": "npm-run-all build:*",
     "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
     "build:js": "tsc",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js"
+    "test:tape": "tsx test.js"
   },
   "devDependencies": {
     "@types/geojson-equality": "^0.2.0",
@@ -61,15 +62,16 @@
     "load-json-file": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*"
   },
   "dependencies": {
-    "@turf/clean-coords": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0",
-    "geojson-equality": "0.1.6"
+    "@turf/clean-coords": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1",
+    "geojson-equality": "0.1.6",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }