booleanWithin

Description

booleanWithin 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 geometry a must not intersect the exterior of geometry b.

booleanWithin(a, b) is equivalent to booleanContains(b, a)

Parameters

Name	Type	Description
feature1	Geometry | Feature<any>	GeoJSON Feature or Geometry
feature2	Geometry | Feature<any>	GeoJSON Feature or Geometry

Returns

boolean true/false

Examples

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

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

Installation

$ npm install @turf/boolean-within

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

$ npm install @turf/turf

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