index.d.ts 1000 B

123456789101112131415161718192021
  1. import { Feature, Geometry } from "@turf/helpers";
  2. /**
  3. * Boolean-Crosses returns True if the intersection results in a geometry whose dimension is one less than
  4. * the maximum dimension of the two source geometries and the intersection set is interior to
  5. * both source geometries.
  6. *
  7. * Boolean-Crosses returns t (TRUE) for only multipoint/polygon, multipoint/linestring, linestring/linestring, linestring/polygon, and linestring/multipolygon comparisons.
  8. *
  9. * @name booleanCrosses
  10. * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry
  11. * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry
  12. * @returns {boolean} true/false
  13. * @example
  14. * var line1 = turf.lineString([[-2, 2], [4, 2]]);
  15. * var line2 = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
  16. *
  17. * var cross = turf.booleanCrosses(line1, line2);
  18. * //=true
  19. */
  20. declare function booleanCrosses(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry): boolean;
  21. export default booleanCrosses;