booleanContains

Description

booleanContains returns True if the second geometry is completely contained by the first geometry. The interiors of both geometries must intersect, and the interior and boundary of the second geometry must not intersect the exterior of the first geometry.

booleanContains(a, b) is equivalent to booleanWithin(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.booleanContains(line, point);
//=true

Installation

$ npm install @turf/boolean-contains

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

$ npm install @turf/turf

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