@turf/boolean-equal

What is @turf/boolean-equal?

@turf/boolean-equal is a module from the Turf.js library that provides functionality to determine if two geometries of the same type have equivalent coordinate values.

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

Check if two geometries are equal

This feature allows you to check if two geometries are equal by comparing their coordinate values. In this example, two points with the same coordinates are compared, and the result is true.

const turf = require('@turf/turf');

const point1 = turf.point([0, 0]);
const point2 = turf.point([0, 0]);
const isEqual = turf.booleanEqual(point1, point2);
console.log(isEqual); // true

Other packages similar to @turf/boolean-equal

geolib

Geolib is a library for geospatial calculations. It provides a variety of functions for distance calculations, area calculations, and more. While it does not have a direct equivalent to @turf/boolean-equal, it offers a wide range of geospatial utilities that can be used in conjunction with other libraries to achieve similar functionality.

jsts

JSTS (JavaScript Topology Suite) is a library for performing operations on geometries. It includes functions for spatial analysis, such as intersection, union, and difference. JSTS can be used to compare geometries, but it is more complex and offers a broader range of spatial operations compared to @turf/boolean-equal.

README

@turf/boolean-equal

booleanEqual

Determine whether two geometries of the same type have identical X,Y coordinate values. See http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm

Parameters

• feature1 (Geometry | Feature) GeoJSON input

• feature2 (Geometry | Feature) GeoJSON input

• options Object Optional parameters (optional, default {})

  • options.precision number decimal precision to use when comparing coordinates (optional, default 6)

Examples

var pt1 = turf.point([0, 0]);
var pt2 = turf.point([0, 0]);
var pt3 = turf.point([1, 1]);

turf.booleanEqual(pt1, pt2);
//= true
turf.booleanEqual(pt2, pt3);
//= false

Returns boolean true if the objects are equal, false otherwise

---

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-equal

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

$ npm install @turf/turf

Diagrams