index.d.ts 950 B

1234567891011121314151617181920212223
  1. import { Feature, Geometry } from 'geojson';
  2. /**
  3. * Boolean-disjoint returns (TRUE) if the intersection of the two geometries is an empty set.
  4. *
  5. * @function
  6. * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry
  7. * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry
  8. * @param {Object} [options={}] Optional parameters
  9. * @param {boolean} [options.ignoreSelfIntersections=true] ignore self-intersections on input features
  10. * @returns {boolean} true if the intersection is an empty set, false otherwise
  11. * @example
  12. * var point = turf.point([2, 2]);
  13. * var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
  14. *
  15. * turf.booleanDisjoint(line, point);
  16. * //=true
  17. */
  18. declare function booleanDisjoint(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry, { ignoreSelfIntersections, }?: {
  19. ignoreSelfIntersections?: boolean;
  20. }): boolean;
  21. export { booleanDisjoint, booleanDisjoint as default };