21 lines
919 B
TypeScript
Executable File
21 lines
919 B
TypeScript
Executable File
import { Feature, Geometry } from "@turf/helpers";
|
|
/**
|
|
* Boolean-within returns true if the first geometry is completely within the second geometry.
|
|
* The interiors of both geometries must intersect and, the interior and boundary of the primary (geometry a)
|
|
* must not intersect the exterior of the secondary (geometry b).
|
|
* Boolean-within returns the exact opposite result of the `@turf/boolean-contains`.
|
|
*
|
|
* @name booleanWithin
|
|
* @param {Geometry|Feature<any>} feature1 GeoJSON Feature or Geometry
|
|
* @param {Geometry|Feature<any>} feature2 GeoJSON Feature or Geometry
|
|
* @returns {boolean} true/false
|
|
* @example
|
|
* var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
|
|
* var point = turf.point([1, 2]);
|
|
*
|
|
* turf.booleanWithin(point, line);
|
|
* //=true
|
|
*/
|
|
declare function booleanWithin(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry): boolean;
|
|
export default booleanWithin;
|