@turf/boolean-intersects

booleanIntersects

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

$3

* feature1 ([Geometry][1] | [Feature][2]\) GeoJSON Feature or Geometry
* feature2 ([Geometry][1] | [Feature][2]\) GeoJSON Feature or Geometry
* options [Object][3] Optional parameters (optional, default {})

* options.ignoreSelfIntersections [boolean][4] ignore self-intersections on input features (optional, default true)

$3

``javascript
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

//addToMap
var addToMap = [point1, point2, line];
point1.properties['marker-color'] = '#f00'
point2.properties['marker-color'] = '#0f0'
`

Returns [boolean][4] true if geometries intersect, false otherwise

[1]: https://tools.ietf.org/html/rfc7946#section-3.1

[2]: https://tools.ietf.org/html/rfc7946#section-3.2

[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

---

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

$3

Install this single module individually:

`sh
$ npm install @turf/boolean-intersects
`

Or install the all-encompassing @turf/turf module that includes all modules as functions:

`sh
$ npm install @turf/turf
``