index.d.ts 1.3 KB

12345678910111213141516171819202122232425262728293031
  1. import { Coord, Feature, Point, Properties, Units } from "@turf/helpers";
  2. /**
  3. * Takes a {@link Point} and calculates the location of a destination point given a distance in
  4. * degrees, radians, miles, or kilometers; and bearing in degrees.
  5. * This uses the [Haversine formula](http://en.wikipedia.org/wiki/Haversine_formula) to account for global curvature.
  6. *
  7. * @name destination
  8. * @param {Coord} origin starting point
  9. * @param {number} distance distance from the origin point
  10. * @param {number} bearing ranging from -180 to 180
  11. * @param {Object} [options={}] Optional parameters
  12. * @param {string} [options.units='kilometers'] miles, kilometers, degrees, or radians
  13. * @param {Object} [options.properties={}] Translate properties to Point
  14. * @returns {Feature<Point>} destination point
  15. * @example
  16. * var point = turf.point([-75.343, 39.984]);
  17. * var distance = 50;
  18. * var bearing = 90;
  19. * var options = {units: 'miles'};
  20. *
  21. * var destination = turf.destination(point, distance, bearing, options);
  22. *
  23. * //addToMap
  24. * var addToMap = [point, destination]
  25. * destination.properties['marker-color'] = '#f00';
  26. * point.properties['marker-color'] = '#0f0';
  27. */
  28. export default function destination<P = Properties>(origin: Coord, distance: number, bearing: number, options?: {
  29. units?: Units;
  30. properties?: P;
  31. }): Feature<Point, P>;