index.d.ts 779 B

123456789101112131415161718192021
  1. import { Feature, Geometry } from "@turf/helpers";
  2. /**
  3. * Determine whether two geometries of the same type have identical X,Y coordinate values.
  4. * See http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm
  5. *
  6. * @name booleanEqual
  7. * @param {Geometry|Feature} feature1 GeoJSON input
  8. * @param {Geometry|Feature} feature2 GeoJSON input
  9. * @returns {boolean} true if the objects are equal, false otherwise
  10. * @example
  11. * var pt1 = turf.point([0, 0]);
  12. * var pt2 = turf.point([0, 0]);
  13. * var pt3 = turf.point([1, 1]);
  14. *
  15. * turf.booleanEqual(pt1, pt2);
  16. * //= true
  17. * turf.booleanEqual(pt2, pt3);
  18. * //= false
  19. */
  20. declare function booleanEqual(feature1: Feature<any> | Geometry, feature2: Feature<any> | Geometry): boolean;
  21. export default booleanEqual;