booleanIntersects

Description

Boolean-intersects returns (TRUE) if the intersection of the two geometries is NOT an empty set.

Parameters

Name	Type	Description
feature1	Geometry | Feature<any>	GeoJSON Feature or Geometry
feature2	Geometry | Feature<any>	GeoJSON Feature or Geometry
options?	Object	Optional parameters (default {})
options.ignoreSelfIntersections?	boolean	ignores self-intersections on input features (default false)

Returns

boolean true if geometries intersect, false otherwise

Examples

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, point2);
//=true

Installation

$ npm install @turf/boolean-intersects

import { booleanIntersects } from "@turf/boolean-intersects";
const result = booleanIntersects(...);

$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.booleanIntersects(...);