index.d.cts 722 B

1234567891011121314151617181920
  1. import { Feature, LineString, Position } from 'geojson';
  2. /**
  3. * Takes a ring and return true or false whether or not the ring is clockwise or counter-clockwise.
  4. *
  5. * @function
  6. * @param {Feature<LineString>|LineString|Array<Array<number>>} line to be evaluated
  7. * @returns {boolean} true/false
  8. * @example
  9. * var clockwiseRing = turf.lineString([[0,0],[1,1],[1,0],[0,0]]);
  10. * var counterClockwiseRing = turf.lineString([[0,0],[1,0],[1,1],[0,0]]);
  11. *
  12. * turf.booleanClockwise(clockwiseRing)
  13. * //=true
  14. * turf.booleanClockwise(counterClockwiseRing)
  15. * //=false
  16. */
  17. declare function booleanClockwise(line: Feature<LineString> | LineString | Position[]): boolean;
  18. export { booleanClockwise, booleanClockwise as default };