Package Exports

@turf/boolean-within

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/boolean-within) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/boolean-within

booleanWith

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.

Parameters

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

Examples

const line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
const 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 module individually:

$ npm install @turf/boolean-within

Or install the Turf module that includes it as a function:

$ npm install @turf/turf