@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.6.0

🚀 New Modules

• @turf/clean-coords Removes redundant coordinates from any GeoJSON Geometry. (PR https://github.com/Turfjs/turf/pull/875 - Author @stebogit)
• @turf/interpolate Takes a set of points and estimates their 'property' values on a grid using the Inverse Distance Weighting (IDW) method.. (PR https://github.com/Turfjs/turf/pull/832 - Author @stebogit)
• @turf/clusters-dbscan Takes a set of Points and partition them into clusters according to DBSCAN's data clustering algorithm. (PR https://github.com/Turfjs/turf/pull/812 and https://github.com/Turfjs/turf/pull/851 - Author @DenisCarriere)

  special mention to this incredibly instructive and fun interactive map by @DenisCarriere 😎👏

• @turf/clusters Provides getCluster, clusterEach, and clusterReduce functions. (PR https://github.com/Turfjs/turf/pull/847 - Author @DenisCarriere)
• @turf/boolean-point-on-line Returns true if a point is on a line. Accepts a optional parameter to ignore the start and end vertices of the linestring. (PR https://github.com/Turfjs/turf/pull/858 - Author @rowanwins)
• @turf/boolean-overlap Takes two features and returns true or false whether or not they overlap, i.e. whether any pair of edges on the two polygons intersect. If there are any edge intersections, the polygons overlap. (PR https://github.com/Turfjs/turf/pull/856 and https://github.com/Turfjs/turf/pull/868 - Author @stebogit @tcql)
• @turf/boolean-equal Determine whether two geometries of the same type have identical X,Y coordinate values. (PR https://github.com/Turfjs/turf/pull/869 - Author @stebogit @tcql)

🏅 New Features/Enhancements

• Sets centered param default to true in @turf/point-grid (PR https://github.com/Turfjs/turf/pull/836 - Contributor @stebogit)
• Adds MultiLineString support for @turf/point-on-line (PR https://github.com/Turfjs/turf/pull/838 - Contributor @stebogit)
• Renames @turf/clusters => @turf/clusters-kmeans, plus adds deprecated warning message to @turf/clusters@4.5.2 (See Issue https://github.com/Turfjs/turf/issues/845)
• Changes output type of @turf/clusters-kmeans (See Issue https://github.com/Turfjs/turf/issues/850 - Contributor @DenisCarriere)
• Adds segmentEach and segmentReduce functions to @turf/meta (See Issue https://github.com/Turfjs/turf/issues/850 - Contributor @DenisCarriere)
• Adds tests and linting on JSDoc in TurfJS core from turf-www; see Issue https://github.com/Turfjs/turf/issues/859 (PR https://github.com/Turfjs/turf/issues/857 + https://github.com/Turfjs/turf/issues/864 + https://github.com/Turfjs/turf/issues/870 - Contributor @DenisCarriere @stebogit)
• Introduces null Geometry support across TurfJS modules (See Issue https://github.com/Turfjs/turf/issues/853) (PR https://github.com/Turfjs/turf/issues/866 - Contributor @DenisCarriere)
• Includes feature(Sub)Index in coordEach/coordReduce (@turf/meta) 🎉 (PR https://github.com/Turfjs/turf/issues/872 - Contributor @DenisCarriere)
• Adds bbox and id params plus geometry method to @turf/helpers (PR https://github.com/Turfjs/turf/issues/877 - Contributor @DenisCarriere)

🐛 Bug Fixes

• Applies @turf/truncate to @turf/line-split splitter input to avoid approximation errors. Fixed #852 (PR https://github.com/Turfjs/turf/pull/855)
• Fixes @turf-mask error (See Issue https://github.com/Turfjs/turf/issues/837) (PR https://github.com/Turfjs/turf/pull/865 - Contributor @thiagoxvo)
• Fixes create-new-module script error on LICENSE file creation (See Issue https://github.com/Turfjs/turf/issues/861) (commit df6986e)
• Fixes @turf/isobands error on commonProperties (See Issue https://github.com/Turfjs/turf/issues/831) (commit 1663f07)