index.d.ts 1.3 KB

123456789101112131415161718192021222324252627282930
  1. import { Coord, Feature, Point, Properties, Units } from "@turf/helpers";
  2. /**
  3. * Returns the destination {@link Point} having travelled the given distance along a Rhumb line from the
  4. * origin Point with the (varant) given bearing.
  5. *
  6. * @name rhumbDestination
  7. * @param {Coord} origin starting point
  8. * @param {number} distance distance from the starting point
  9. * @param {number} bearing varant bearing angle ranging from -180 to 180 degrees from north
  10. * @param {Object} [options={}] Optional parameters
  11. * @param {string} [options.units='kilometers'] can be degrees, radians, miles, or kilometers
  12. * @param {Object} [options.properties={}] translate properties to destination point
  13. * @returns {Feature<Point>} Destination point.
  14. * @example
  15. * var pt = turf.point([-75.343, 39.984], {"marker-color": "F00"});
  16. * var distance = 50;
  17. * var bearing = 90;
  18. * var options = {units: 'miles'};
  19. *
  20. * var destination = turf.rhumbDestination(pt, distance, bearing, options);
  21. *
  22. * //addToMap
  23. * var addToMap = [pt, destination]
  24. * destination.properties['marker-color'] = '#00F';
  25. */
  26. declare function rhumbDestination<P = Properties>(origin: Coord, distance: number, bearing: number, options?: {
  27. units?: Units;
  28. properties?: P;
  29. }): Feature<Point, P>;
  30. export default rhumbDestination;