@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 spatial relations.

Parameters

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

Examples

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

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

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

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

$ npm install @turf/turf

Changelog

4.5.0

🚀 New Modules

• @turf/clusters Takes a set of points and partition them into clusters using the k-means clustering algorithm. (PR https://github.com/Turfjs/turf/pull/787 - Author @stebogit )

• @turf/boolean-disjoint Boolean-disjoint returns (TRUE) if the intersection of the two geometries is an empty set. (PR https://github.com/Turfjs/turf/pull/805 - Author @rowanwins)

• @turf/boolean-contains Boolean-contains 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 secondary (geometry b) must not intersect the exterior of the primary (geometry a). Boolean-contains returns the exact opposite result of the @turf/boolean-within. (PR https://github.com/Turfjs/turf/pull/797 - Author @rowanwins)

• @turf/boolean-crosses Boolean-Crosses returns True if the intersection results in a geometry whose dimension is one less than the maximum dimension of the two source geometries and the intersection set is interior to both source geometries. Boolean-Crosses returns t (TRUE) for only multipoint/polygon, multipoint/linestring, linestring/linestring, linestring/polygon, and linestring/multipolygon comparisons. (PR https://github.com/Turfjs/turf/pull/796 - Author @rowanwins)

• @turf/boolean-clockwise Takes a ring and return true or false whether or not the ring is clockwise or counter-clockwise. (PR https://github.com/Turfjs/turf/pull/789 - Authors @morganherlocker @stebogit)

• @turf/clone Prevents GeoJSON coordinates from being mutated, similar to JSON.parse(JSON.stringify(geojson)). Only cloning the coordinates can be 3x-20x faster than the parse + stringify approach. (PR https://github.com/Turfjs/turf/pull/824 - Author @DenisCarriere)

🏅 New Features/Enhancements

• convertArea Converts a area to the requested unit. (PR https://github.com/Turfjs/turf/pull/821 - Author @wnordmann)
• Adds mask option to @turf/point-grid (PR https://github.com/Turfjs/turf/pull/791)
• New @turf/isolines based on MarchingSquares.js (PR https://github.com/Turfjs/turf/pull/781)
• Use ES6 modules / Add module.js to @turf/turf (PR https://github.com/Turfjs/turf/pull/793)
• Create-new-module script (PR https://github.com/Turfjs/turf/pull/823)

🐛 Bug Fixes

• Buffer - Drop circle buffer operation (PR https://github.com/Turfjs/turf/pull/786)
• Fixes @turf/idw bad property name #774 (PR https://github.com/Turfjs/turf/pull/800)
• Fix for @turf/polygon-tangents - Resolves #785 (PR https://github.com/Turfjs/turf/pull/792)