@turf/boolean-intersects 7.1.0-alpha.7 → 7.1.0

package/README.md

@@ -4,30 +4,44 @@
 
 ## booleanIntersects
 
-Boolean-intersects returns (TRUE) two geometries intersect.
+Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set.
 
 ### Parameters
 
 *   `feature1` **([Geometry][1] | [Feature][2]\<any>)** GeoJSON Feature or Geometry
 *   `feature2` **([Geometry][1] | [Feature][2]\<any>)** GeoJSON Feature or Geometry
+*   `options` **[Object][3]** Optional parameters (optional, default `{}`)
+
+    *   `options.ignoreSelfIntersections` **[boolean][4]** ignores self-intersections on input features (optional, default `false`)
 
 ### Examples
 
 ```javascript
-var point = turf.point([2, 2]);
-var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
+var point1 = turf.point([2, 2]);
+var point2 = turf.point([1, 2]);
+var line = turf.lineString([[1, 1], [1, 3], [1, 4]]);
+
+turf.booleanIntersects(line, point1);
+//=false
 
-turf.booleanIntersects(line, point);
+turf.booleanIntersects(line, point2);
 //=true
+
+//addToMap
+var addToMap = [point1, point2, line];
+point1.properties['marker-color'] = '#f00'
+point2.properties['marker-color'] = '#0f0'
 ```
 
-Returns **[boolean][3]** true/false
+Returns **[boolean][4]** true if geometries intersect, false otherwise
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1
 
 [2]: https://tools.ietf.org/html/rfc7946#section-3.2
 
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[4]: 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 of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 

package/dist/cjs/index.cjs

@@ -1,14 +1,18 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});// index.ts
 var _booleandisjoint = require('@turf/boolean-disjoint');
 var _meta = require('@turf/meta');
-function booleanIntersects(feature1, feature2) {
+function booleanIntersects(feature1, feature2, options = {}) {
+  var _a;
+  const ignoreSelfIntersections = (_a = options.ignoreSelfIntersections) != null ? _a : false;
   let bool = false;
   _meta.flattenEach.call(void 0, feature1, (flatten1) => {
     _meta.flattenEach.call(void 0, feature2, (flatten2) => {
       if (bool === true) {
         return true;
       }
-      bool = !_booleandisjoint.booleanDisjoint.call(void 0, flatten1.geometry, flatten2.geometry);
+      bool = !_booleandisjoint.booleanDisjoint.call(void 0, flatten1.geometry, flatten2.geometry, {
+        ignoreSelfIntersections
+      });
     });
   });
   return bool;

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";AACA,SAAS,uBAAuB;AAChC,SAAS,mBAAmB;AAgB5B,SAAS,kBACP,UACA,UACA;AACA,MAAI,OAAO;AACX,cAAY,UAAU,CAAC,aAAa;AAClC,gBAAY,UAAU,CAAC,aAAa;AAClC,UAAI,SAAS,MAAM;AACjB,eAAO;AAAA,MACT;AACA,aAAO,CAAC,gBAAgB,SAAS,UAAU,SAAS,QAAQ;AAAA,IAC9D,CAAC;AAAA,EACH,CAAC;AACD,SAAO;AACT;AAGA,IAAO,kCAAQ","sourcesContent":["import { Feature, Geometry } from \"geojson\";\nimport { booleanDisjoint } from \"@turf/boolean-disjoint\";\nimport { flattenEach } from \"@turf/meta\";\n\n/**\n * Boolean-intersects returns (TRUE) two geometries intersect.\n *\n * @name booleanIntersects\n * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry\n * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry\n * @returns {boolean} true/false\n * @example\n * var point = turf.point([2, 2]);\n * var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);\n *\n * turf.booleanIntersects(line, point);\n * //=true\n */\nfunction booleanIntersects(\n  feature1: Feature<any> | Geometry,\n  feature2: Feature<any> | Geometry\n) {\n  let bool = false;\n  flattenEach(feature1, (flatten1) => {\n    flattenEach(feature2, (flatten2) => {\n      if (bool === true) {\n        return true;\n      }\n      bool = !booleanDisjoint(flatten1.geometry, flatten2.geometry);\n    });\n  });\n  return bool;\n}\n\nexport { booleanIntersects };\nexport default booleanIntersects;\n"]}
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";AACA,SAAS,uBAAuB;AAChC,SAAS,mBAAmB;AA2B5B,SAAS,kBACP,UACA,UACA,UAEI,CAAC,GACL;AAnCF;AAoCE,QAAM,2BACJ,aAAQ,4BAAR,YAAmC;AAErC,MAAI,OAAO;AACX,cAAY,UAAU,CAAC,aAAa;AAClC,gBAAY,UAAU,CAAC,aAAa;AAClC,UAAI,SAAS,MAAM;AACjB,eAAO;AAAA,MACT;AACA,aAAO,CAAC,gBAAgB,SAAS,UAAU,SAAS,UAAU;AAAA,QAC5D;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH,CAAC;AACD,SAAO;AACT;AAGA,IAAO,kCAAQ","sourcesContent":["import { Feature, Geometry } from \"geojson\";\nimport { booleanDisjoint } from \"@turf/boolean-disjoint\";\nimport { flattenEach } from \"@turf/meta\";\n\n/**\n * Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set.\n *\n * @name booleanIntersects\n * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry\n * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry\n * @param {Object} [options={}] Optional parameters\n * @param {boolean} [options.ignoreSelfIntersections=false] ignores self-intersections on input features\n * @returns {boolean} true if geometries intersect, false otherwise\n * @example\n * var point1 = turf.point([2, 2]);\n * var point2 = turf.point([1, 2]);\n * var line = turf.lineString([[1, 1], [1, 3], [1, 4]]);\n *\n * turf.booleanIntersects(line, point1);\n * //=false\n *\n * turf.booleanIntersects(line, point2);\n * //=true\n *\n * //addToMap\n * var addToMap = [point1, point2, line];\n * point1.properties['marker-color'] = '#f00'\n * point2.properties['marker-color'] = '#0f0'\n */\nfunction booleanIntersects(\n  feature1: Feature<any> | Geometry,\n  feature2: Feature<any> | Geometry,\n  options: {\n    ignoreSelfIntersections?: boolean;\n  } = {}\n) {\n  const ignoreSelfIntersections: boolean =\n    options.ignoreSelfIntersections ?? false;\n\n  let bool = false;\n  flattenEach(feature1, (flatten1) => {\n    flattenEach(feature2, (flatten2) => {\n      if (bool === true) {\n        return true;\n      }\n      bool = !booleanDisjoint(flatten1.geometry, flatten2.geometry, {\n        ignoreSelfIntersections,\n      });\n    });\n  });\n  return bool;\n}\n\nexport { booleanIntersects };\nexport default booleanIntersects;\n"]}

package/dist/cjs/index.d.cts

@@ -1,19 +1,32 @@
 import { Feature, Geometry } from 'geojson';
 
 /**
- * Boolean-intersects returns (TRUE) two geometries intersect.
+ * Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set.
  *
  * @name booleanIntersects
  * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry
  * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry
- * @returns {boolean} true/false
+ * @param {Object} [options={}] Optional parameters
+ * @param {boolean} [options.ignoreSelfIntersections=false] ignores self-intersections on input features
+ * @returns {boolean} true if geometries intersect, false otherwise
  * @example
- * var point = turf.point([2, 2]);
- * var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
+ * var point1 = turf.point([2, 2]);
+ * var point2 = turf.point([1, 2]);
+ * var line = turf.lineString([[1, 1], [1, 3], [1, 4]]);
  *
- * turf.booleanIntersects(line, point);
+ * turf.booleanIntersects(line, point1);
+ * //=false
+ *
+ * turf.booleanIntersects(line, point2);
  * //=true
+ *
+ * //addToMap
+ * var addToMap = [point1, point2, line];
+ * point1.properties['marker-color'] = '#f00'
+ * point2.properties['marker-color'] = '#0f0'
  */
-declare function booleanIntersects(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry): boolean;
+declare function booleanIntersects(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry, options?: {
+    ignoreSelfIntersections?: boolean;
+}): boolean;
 
 export { booleanIntersects, booleanIntersects as default };

package/dist/esm/index.d.ts

@@ -1,19 +1,32 @@
 import { Feature, Geometry } from 'geojson';
 
 /**
- * Boolean-intersects returns (TRUE) two geometries intersect.
+ * Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set.
  *
  * @name booleanIntersects
  * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry
  * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry
- * @returns {boolean} true/false
+ * @param {Object} [options={}] Optional parameters
+ * @param {boolean} [options.ignoreSelfIntersections=false] ignores self-intersections on input features
+ * @returns {boolean} true if geometries intersect, false otherwise
  * @example
- * var point = turf.point([2, 2]);
- * var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
+ * var point1 = turf.point([2, 2]);
+ * var point2 = turf.point([1, 2]);
+ * var line = turf.lineString([[1, 1], [1, 3], [1, 4]]);
  *
- * turf.booleanIntersects(line, point);
+ * turf.booleanIntersects(line, point1);
+ * //=false
+ *
+ * turf.booleanIntersects(line, point2);
  * //=true
+ *
+ * //addToMap
+ * var addToMap = [point1, point2, line];
+ * point1.properties['marker-color'] = '#f00'
+ * point2.properties['marker-color'] = '#0f0'
  */
-declare function booleanIntersects(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry): boolean;
+declare function booleanIntersects(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry, options?: {
+    ignoreSelfIntersections?: boolean;
+}): boolean;
 
 export { booleanIntersects, booleanIntersects as default };

package/dist/esm/index.js

@@ -1,14 +1,18 @@
 // index.ts
 import { booleanDisjoint } from "@turf/boolean-disjoint";
 import { flattenEach } from "@turf/meta";
-function booleanIntersects(feature1, feature2) {
+function booleanIntersects(feature1, feature2, options = {}) {
+  var _a;
+  const ignoreSelfIntersections = (_a = options.ignoreSelfIntersections) != null ? _a : false;
   let bool = false;
   flattenEach(feature1, (flatten1) => {
     flattenEach(feature2, (flatten2) => {
       if (bool === true) {
         return true;
       }
-      bool = !booleanDisjoint(flatten1.geometry, flatten2.geometry);
+      bool = !booleanDisjoint(flatten1.geometry, flatten2.geometry, {
+        ignoreSelfIntersections
+      });
     });
   });
   return bool;

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, Geometry } from \"geojson\";\nimport { booleanDisjoint } from \"@turf/boolean-disjoint\";\nimport { flattenEach } from \"@turf/meta\";\n\n/**\n * Boolean-intersects returns (TRUE) two geometries intersect.\n *\n * @name booleanIntersects\n * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry\n * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry\n * @returns {boolean} true/false\n * @example\n * var point = turf.point([2, 2]);\n * var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);\n *\n * turf.booleanIntersects(line, point);\n * //=true\n */\nfunction booleanIntersects(\n  feature1: Feature<any> | Geometry,\n  feature2: Feature<any> | Geometry\n) {\n  let bool = false;\n  flattenEach(feature1, (flatten1) => {\n    flattenEach(feature2, (flatten2) => {\n      if (bool === true) {\n        return true;\n      }\n      bool = !booleanDisjoint(flatten1.geometry, flatten2.geometry);\n    });\n  });\n  return bool;\n}\n\nexport { booleanIntersects };\nexport default booleanIntersects;\n"],"mappings":";AACA,SAAS,uBAAuB;AAChC,SAAS,mBAAmB;AAgB5B,SAAS,kBACP,UACA,UACA;AACA,MAAI,OAAO;AACX,cAAY,UAAU,CAAC,aAAa;AAClC,gBAAY,UAAU,CAAC,aAAa;AAClC,UAAI,SAAS,MAAM;AACjB,eAAO;AAAA,MACT;AACA,aAAO,CAAC,gBAAgB,SAAS,UAAU,SAAS,QAAQ;AAAA,IAC9D,CAAC;AAAA,EACH,CAAC;AACD,SAAO;AACT;AAGA,IAAO,kCAAQ;","names":[]}
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, Geometry } from \"geojson\";\nimport { booleanDisjoint } from \"@turf/boolean-disjoint\";\nimport { flattenEach } from \"@turf/meta\";\n\n/**\n * Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set.\n *\n * @name booleanIntersects\n * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry\n * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry\n * @param {Object} [options={}] Optional parameters\n * @param {boolean} [options.ignoreSelfIntersections=false] ignores self-intersections on input features\n * @returns {boolean} true if geometries intersect, false otherwise\n * @example\n * var point1 = turf.point([2, 2]);\n * var point2 = turf.point([1, 2]);\n * var line = turf.lineString([[1, 1], [1, 3], [1, 4]]);\n *\n * turf.booleanIntersects(line, point1);\n * //=false\n *\n * turf.booleanIntersects(line, point2);\n * //=true\n *\n * //addToMap\n * var addToMap = [point1, point2, line];\n * point1.properties['marker-color'] = '#f00'\n * point2.properties['marker-color'] = '#0f0'\n */\nfunction booleanIntersects(\n  feature1: Feature<any> | Geometry,\n  feature2: Feature<any> | Geometry,\n  options: {\n    ignoreSelfIntersections?: boolean;\n  } = {}\n) {\n  const ignoreSelfIntersections: boolean =\n    options.ignoreSelfIntersections ?? false;\n\n  let bool = false;\n  flattenEach(feature1, (flatten1) => {\n    flattenEach(feature2, (flatten2) => {\n      if (bool === true) {\n        return true;\n      }\n      bool = !booleanDisjoint(flatten1.geometry, flatten2.geometry, {\n        ignoreSelfIntersections,\n      });\n    });\n  });\n  return bool;\n}\n\nexport { booleanIntersects };\nexport default booleanIntersects;\n"],"mappings":";AACA,SAAS,uBAAuB;AAChC,SAAS,mBAAmB;AA2B5B,SAAS,kBACP,UACA,UACA,UAEI,CAAC,GACL;AAnCF;AAoCE,QAAM,2BACJ,aAAQ,4BAAR,YAAmC;AAErC,MAAI,OAAO;AACX,cAAY,UAAU,CAAC,aAAa;AAClC,gBAAY,UAAU,CAAC,aAAa;AAClC,UAAI,SAAS,MAAM;AACjB,eAAO;AAAA,MACT;AACA,aAAO,CAAC,gBAAgB,SAAS,UAAU,SAAS,UAAU;AAAA,QAC5D;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH,CAAC;AACD,SAAO;AACT;AAGA,IAAO,kCAAQ;","names":[]}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@turf/boolean-intersects",
-  "version": "7.1.0-alpha.7+0ce6ecca0",
+  "version": "7.1.0",
   "description": "turf boolean-intersects module",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>",
-    "Denis Carriere <@DenisCarriere>"
+    "Denis Carriere <@DenisCarriere>",
+    "David Whittingham <@01100100>"
   ],
   "license": "MIT",
   "bugs": {
@@ -67,10 +68,11 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@turf/boolean-disjoint": "^7.1.0-alpha.7+0ce6ecca0",
-    "@turf/helpers": "^7.1.0-alpha.7+0ce6ecca0",
-    "@turf/meta": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/boolean-disjoint": "^7.1.0",
+    "@turf/helpers": "^7.1.0",
+    "@turf/meta": "^7.1.0",
+    "@types/geojson": "^7946.0.10",
     "tslib": "^2.6.2"
   },
-  "gitHead": "0ce6ecca05829690270fec6d6bed2003495fe0ea"
+  "gitHead": "68915eeebc9278bb40dec3f1034499698a0561ef"
 }