@turf/boolean-touches

turf boolean-touches module

Usage no npm install needed!

<script type="module">
  import turfBooleanTouches from 'https://cdn.skypack.dev/@turf/boolean-touches';
</script>

README

@turf/boolean-touches

booleanTouches

Boolean-touches 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).

Parameters

Examples

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

turf.booleanTouches(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-touches

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

$ npm install @turf/turf