index.d.ts 854 B

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