@turf/boolean-equal 7.0.0-alpha.2 → 7.1.0-alpha.7

package/README.md

@@ -4,7 +4,7 @@
 
 ## booleanEqual
 
-Determines whether two geometries or features of the same type have identical X,Y coordinate values and properties.
+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][1]
 
 ### Parameters
@@ -21,17 +21,11 @@ See [http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relatio
 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][6]** true if the objects are equal, false otherwise
@@ -48,26 +42,21 @@ Returns **[boolean][6]** true if the objects are equal, false otherwise
 
 [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
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/boolean-equal
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf
@@ -76,4 +65,4 @@ $ npm install @turf/turf
 
 ### Diagrams
 
-![esri-equals](diagrams/esri-equals.gif)
+![esri-equals](diagrams/esri-equals.gif)

package/dist/cjs/index.cjs

@@ -0,0 +1,24 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// index.ts
+var _geojsonequalityts = require('geojson-equality-ts');
+var _cleancoords = require('@turf/clean-coords');
+var _invariant = require('@turf/invariant');
+function booleanEqual(feature1, feature2, options = {}) {
+  let precision = options.precision;
+  precision = precision === void 0 || precision === null || isNaN(precision) ? 6 : precision;
+  if (typeof precision !== "number" || !(precision >= 0)) {
+    throw new Error("precision must be a positive number");
+  }
+  const type1 = _invariant.getGeom.call(void 0, feature1).type;
+  const type2 = _invariant.getGeom.call(void 0, feature2).type;
+  if (type1 !== type2)
+    return false;
+  return _geojsonequalityts.geojsonEquality.call(void 0, _cleancoords.cleanCoords.call(void 0, feature1), _cleancoords.cleanCoords.call(void 0, feature2), {
+    precision
+  });
+}
+var turf_boolean_equal_default = booleanEqual;
+
+
+
+exports.booleanEqual = booleanEqual; exports.default = turf_boolean_equal_default;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";AACA,SAAS,uBAAuB;AAChC,SAAS,mBAAmB;AAC5B,SAAS,eAAe;AAsBxB,SAAS,aACP,UACA,UACA,UAEI,CAAC,GACI;AACT,MAAI,YAAY,QAAQ;AAExB,cACE,cAAc,UAAa,cAAc,QAAQ,MAAM,SAAS,IAC5D,IACA;AAEN,MAAI,OAAO,cAAc,YAAY,EAAE,aAAa,IAAI;AACtD,UAAM,IAAI,MAAM,qCAAqC;AAAA,EACvD;AAEA,QAAM,QAAQ,QAAQ,QAAQ,EAAE;AAChC,QAAM,QAAQ,QAAQ,QAAQ,EAAE;AAChC,MAAI,UAAU;AAAO,WAAO;AAE5B,SAAO,gBAAgB,YAAY,QAAQ,GAAG,YAAY,QAAQ,GAAG;AAAA,IACnE;AAAA,EACF,CAAC;AACH;AAGA,IAAO,6BAAQ","sourcesContent":["import { Feature, Geometry } from \"geojson\";\nimport { geojsonEquality } from \"geojson-equality-ts\";\nimport { cleanCoords } from \"@turf/clean-coords\";\nimport { getGeom } from \"@turf/invariant\";\n\n/**\n * Determine whether two geometries of the same type have identical X,Y coordinate values.\n * See http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm\n *\n * @name booleanEqual\n * @param {Geometry|Feature} feature1 GeoJSON input\n * @param {Geometry|Feature} feature2 GeoJSON input\n * @param {Object} [options={}] Optional parameters\n * @param {number} [options.precision=6] decimal precision to use when comparing coordinates\n * @returns {boolean} true if the objects are equal, false otherwise\n * @example\n * var pt1 = turf.point([0, 0]);\n * var pt2 = turf.point([0, 0]);\n * var pt3 = turf.point([1, 1]);\n *\n * turf.booleanEqual(pt1, pt2);\n * //= true\n * turf.booleanEqual(pt2, pt3);\n * //= false\n */\nfunction booleanEqual(\n  feature1: Feature<any> | Geometry,\n  feature2: Feature<any> | Geometry,\n  options: {\n    precision?: number;\n  } = {}\n): boolean {\n  let precision = options.precision;\n\n  precision =\n    precision === undefined || precision === null || isNaN(precision)\n      ? 6\n      : precision;\n\n  if (typeof precision !== \"number\" || !(precision >= 0)) {\n    throw new Error(\"precision must be a positive number\");\n  }\n\n  const type1 = getGeom(feature1).type;\n  const type2 = getGeom(feature2).type;\n  if (type1 !== type2) return false;\n\n  return geojsonEquality(cleanCoords(feature1), cleanCoords(feature2), {\n    precision,\n  });\n}\n\nexport { booleanEqual };\nexport default booleanEqual;\n"]}

package/dist/cjs/index.d.cts

@@ -0,0 +1,27 @@
+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
+ *
+ * @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]);
+ * var pt2 = turf.point([0, 0]);
+ * var pt3 = turf.point([1, 1]);
+ *
+ * turf.booleanEqual(pt1, pt2);
+ * //= true
+ * turf.booleanEqual(pt2, pt3);
+ * //= false
+ */
+declare function booleanEqual(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry, options?: {
+    precision?: number;
+}): boolean;
+
+export { booleanEqual, booleanEqual as default };

package/dist/{js → esm}/index.d.ts

@@ -1,4 +1,5 @@
-import { Feature, Geometry } from "geojson";
+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
@@ -22,4 +23,5 @@ import { Feature, Geometry } from "geojson";
 declare function booleanEqual(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry, options?: {
     precision?: number;
 }): boolean;
-export default booleanEqual;
+
+export { booleanEqual, booleanEqual as default };

package/dist/esm/index.js

@@ -0,0 +1,24 @@
+// index.ts
+import { geojsonEquality } from "geojson-equality-ts";
+import { cleanCoords } from "@turf/clean-coords";
+import { getGeom } from "@turf/invariant";
+function booleanEqual(feature1, feature2, options = {}) {
+  let precision = options.precision;
+  precision = precision === void 0 || 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;
+  return geojsonEquality(cleanCoords(feature1), cleanCoords(feature2), {
+    precision
+  });
+}
+var turf_boolean_equal_default = booleanEqual;
+export {
+  booleanEqual,
+  turf_boolean_equal_default as default
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, Geometry } from \"geojson\";\nimport { geojsonEquality } from \"geojson-equality-ts\";\nimport { cleanCoords } from \"@turf/clean-coords\";\nimport { getGeom } from \"@turf/invariant\";\n\n/**\n * Determine whether two geometries of the same type have identical X,Y coordinate values.\n * See http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm\n *\n * @name booleanEqual\n * @param {Geometry|Feature} feature1 GeoJSON input\n * @param {Geometry|Feature} feature2 GeoJSON input\n * @param {Object} [options={}] Optional parameters\n * @param {number} [options.precision=6] decimal precision to use when comparing coordinates\n * @returns {boolean} true if the objects are equal, false otherwise\n * @example\n * var pt1 = turf.point([0, 0]);\n * var pt2 = turf.point([0, 0]);\n * var pt3 = turf.point([1, 1]);\n *\n * turf.booleanEqual(pt1, pt2);\n * //= true\n * turf.booleanEqual(pt2, pt3);\n * //= false\n */\nfunction booleanEqual(\n  feature1: Feature<any> | Geometry,\n  feature2: Feature<any> | Geometry,\n  options: {\n    precision?: number;\n  } = {}\n): boolean {\n  let precision = options.precision;\n\n  precision =\n    precision === undefined || precision === null || isNaN(precision)\n      ? 6\n      : precision;\n\n  if (typeof precision !== \"number\" || !(precision >= 0)) {\n    throw new Error(\"precision must be a positive number\");\n  }\n\n  const type1 = getGeom(feature1).type;\n  const type2 = getGeom(feature2).type;\n  if (type1 !== type2) return false;\n\n  return geojsonEquality(cleanCoords(feature1), cleanCoords(feature2), {\n    precision,\n  });\n}\n\nexport { booleanEqual };\nexport default booleanEqual;\n"],"mappings":";AACA,SAAS,uBAAuB;AAChC,SAAS,mBAAmB;AAC5B,SAAS,eAAe;AAsBxB,SAAS,aACP,UACA,UACA,UAEI,CAAC,GACI;AACT,MAAI,YAAY,QAAQ;AAExB,cACE,cAAc,UAAa,cAAc,QAAQ,MAAM,SAAS,IAC5D,IACA;AAEN,MAAI,OAAO,cAAc,YAAY,EAAE,aAAa,IAAI;AACtD,UAAM,IAAI,MAAM,qCAAqC;AAAA,EACvD;AAEA,QAAM,QAAQ,QAAQ,QAAQ,EAAE;AAChC,QAAM,QAAQ,QAAQ,QAAQ,EAAE;AAChC,MAAI,UAAU;AAAO,WAAO;AAE5B,SAAO,gBAAgB,YAAY,QAAQ,GAAG,YAAY,QAAQ,GAAG;AAAA,IACnE;AAAA,EACF,CAAC;AACH;AAGA,IAAO,6BAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/boolean-equal",
-  "version": "7.0.0-alpha.2",
+  "version": "7.1.0-alpha.7+0ce6ecca0",
   "description": "turf boolean-equal module",
   "author": "Turf Authors",
   "contributors": [
@@ -29,49 +29,53 @@
     "equal",
     "boolean-equal"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/js/index.d.ts",
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "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": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx test.js"
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts"
   },
   "devDependencies": {
-    "@types/geojson-equality": "^0.2.0",
-    "@types/tape": "*",
-    "benchmark": "*",
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
     "boolean-shapely": "*",
-    "glob": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*"
+    "glob": "^10.3.10",
+    "load-json-file": "^7.0.1",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@turf/clean-coords": "^7.0.0-alpha.2",
-    "@turf/helpers": "^7.0.0-alpha.2",
-    "@turf/invariant": "^7.0.0-alpha.2",
-    "geojson-equality": "0.1.6",
-    "tslib": "^2.3.0"
+    "@turf/clean-coords": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/helpers": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/invariant": "^7.1.0-alpha.7+0ce6ecca0",
+    "geojson-equality-ts": "^1.0.2",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "0ce6ecca05829690270fec6d6bed2003495fe0ea"
 }

package/dist/es/index.js

@@ -1,40 +0,0 @@
-import GeojsonEquality from "geojson-equality";
-import cleanCoords from "@turf/clean-coords";
-import { getGeom } from "@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
- *
- * @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]);
- * var pt2 = turf.point([0, 0]);
- * var pt3 = turf.point([1, 1]);
- *
- * turf.booleanEqual(pt1, pt2);
- * //= true
- * turf.booleanEqual(pt2, pt3);
- * //= false
- */
-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;
-    const equality = new GeojsonEquality({ precision: precision });
-    return equality.compare(cleanCoords(feature1), cleanCoords(feature2));
-}
-export default booleanEqual;

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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
- *
- * @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]);
- * var pt2 = turf.point([0, 0]);
- * var pt3 = turf.point([1, 1]);
- *
- * turf.booleanEqual(pt1, pt2);
- * //= true
- * turf.booleanEqual(pt2, pt3);
- * //= false
- */
-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;
-    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;