@turf/boolean-touches

What is @turf/boolean-touches?

@turf/boolean-touches is a module from the Turf.js library that provides geospatial analysis tools. This specific package is used to determine if two geometries touch each other, meaning they have at least one boundary point in common but do not overlap.

What are @turf/boolean-touches's main functionalities?

Check if two geometries touch

This feature allows you to check if two geometries touch each other. In the code sample, a point and a line are defined, and the function checks if the point touches the line. The result is true because the point is on the line's boundary.

const turf = require('@turf/boolean-touches');
const point = turf.point([1, 1]);
const line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
const touches = turf(point, line);
console.log(touches); // true

Other packages similar to @turf/boolean-touches

jsts

JSTS is a JavaScript library of spatial predicates and functions for processing geometry. It is similar to @turf/boolean-touches in that it can determine spatial relationships between geometries, including whether they touch. JSTS is more comprehensive, offering a wider range of geometric operations and predicates.

geolib

Geolib is a library for geospatial operations in JavaScript. While it focuses more on distance and area calculations, it also provides some basic spatial relationship checks. Compared to @turf/boolean-touches, Geolib is less specialized in topological relationships but can be used for simpler geospatial tasks.

README

@turf/boolean-touches

booleanTouches

Boolean-touches true if none of the points common to both geometries intersect the interiors of both geometries.

Parameters

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

Examples

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

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 single module individually:

$ npm install @turf/boolean-touches

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf