Atlaslog
Atlaslog / Turf.js / API / booleanContains
Turf.js · API reference

booleanContains

Quick answer

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

Last verified 2026-11-03 · Turf.js 7.x · Cite this page
Runnable examplesChinese noteAll API topics

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​

NameTypeDescription
feature1Geometry | Feature<any>GeoJSON Feature or Geometry
feature2Geometry | 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(...);
TutorialsAPI index
English reference text adapted from the official Turf.js documentation, © Turf.js contributors, licensed under MIT.
Original page: https://turfjs.org/docs/api/booleanContains · Chinese note: /turf/api/boolean-contains.html
Cite this page

Atlaslog (2026). booleanContains. https://www.jingweizhi.com/en/turf/api/boolean-contains.html (accessed 2026-11-03).