JSPM

  • Created
  • Published
  • Downloads 905084
  • Score
    100M100P100Q200405F
  • License MIT

Determine whether two geometries of the same type have identical X,Y coordinate values

Package Exports

  • @turf/boolean-equal
  • @turf/boolean-equal/package.json

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

esri-equals