turf/packages/turf-boolean-equal

@turf/boolean-equal

booleanEqual

Determines whether two geometries or features of the same type have identical X,Y coordinate values and properties. 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]);
var pt4 = turf.point([0, 0], {prop: 'A'});
var pt5 = turf.point([0, 0], {prop: 'B'});

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

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

$ npm install @turf/boolean-equal

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

$ npm install @turf/turf

Diagrams