@turf/boolean-within

booleanWithin

Tests whether geometry a is contained by geometry b.
The interiors of both geometries must intersect, and the interior and boundary of geometry a must not intersect the exterior of geometry b.
booleanWithin(a, b) is equivalent to booleanContains(b, a)

$3

* feature1 ([Geometry][1] | [Feature][2]\) GeoJSON Feature or Geometry
* feature2 ([Geometry][1] | [Feature][2]\) GeoJSON Feature or Geometry

$3

``javascript
var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
var point = turf.point([1, 2]);

turf.booleanWithin(point, line);
//=true
`

Returns [boolean][3] true/false

[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/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-within
`

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

`sh
$ npm install @turf/turf
``

$3

!esri-within