index.d.ts 919 B

1234567891011121314151617181920212223242526
  1. import { Feature, LineString, Point } from 'geojson';
  2. import { Units } from '@turf/helpers';
  3. /**
  4. * Takes a {@link LineString} and returns a {@link Point} at a specified distance along the line.
  5. *
  6. * @function
  7. * @param {Feature<LineString>|LineString} line input line
  8. * @param {number} distance distance along the line
  9. * @param {Object} [options] Optional parameters
  10. * @param {Units} [options.units="kilometers"] can be degrees, radians, miles, or kilometers
  11. * @returns {Feature<Point>} Point `distance` `units` along the line
  12. * @example
  13. * var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]]);
  14. * var options = {units: 'miles'};
  15. *
  16. * var along = turf.along(line, 200, options);
  17. *
  18. * //addToMap
  19. * var addToMap = [along, line]
  20. */
  21. declare function along(line: Feature<LineString> | LineString, distance: number, options?: {
  22. units?: Units;
  23. }): Feature<Point>;
  24. export { along, along as default };