index.d.ts 732 B

1234567891011121314151617
  1. import { Feature, LineString } from "@turf/helpers";
  2. /**
  3. * Boolean-Parallel returns True if each segment of `line1` is parallel to the correspondent segment of `line2`
  4. *
  5. * @name booleanParallel
  6. * @param {Geometry|Feature<LineString>} line1 GeoJSON Feature or Geometry
  7. * @param {Geometry|Feature<LineString>} line2 GeoJSON Feature or Geometry
  8. * @returns {boolean} true/false if the lines are parallel
  9. * @example
  10. * var line1 = turf.lineString([[0, 0], [0, 1]]);
  11. * var line2 = turf.lineString([[1, 0], [1, 1]]);
  12. *
  13. * turf.booleanParallel(line1, line2);
  14. * //=true
  15. */
  16. declare function booleanParallel(line1: Feature<LineString> | LineString, line2: Feature<LineString> | LineString): boolean;
  17. export default booleanParallel;