@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)

Parameters

• feature1 (Geometry | Feature<any>) GeoJSON Feature or Geometry
• feature2 (Geometry | Feature<any>) GeoJSON Feature or Geometry

Examples

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 true/false

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.

Installation

Install this single module individually:

$ npm install @turf/boolean-within

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

$ npm install @turf/turf

Diagrams