index.d.ts 919 B

1234567891011121314151617181920
  1. import { Feature, Geometry } from "@turf/helpers";
  2. /**
  3. * Boolean-within returns true if the first geometry is completely within the second geometry.
  4. * The interiors of both geometries must intersect and, the interior and boundary of the primary (geometry a)
  5. * must not intersect the exterior of the secondary (geometry b).
  6. * Boolean-within returns the exact opposite result of the `@turf/boolean-contains`.
  7. *
  8. * @name booleanWithin
  9. * @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry
  10. * @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry
  11. * @returns {boolean} true/false
  12. * @example
  13. * var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
  14. * var point = turf.point([1, 2]);
  15. *
  16. * turf.booleanWithin(point, line);
  17. * //=true
  18. */
  19. declare function booleanWithin(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry): boolean;
  20. export default booleanWithin;