mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-09-25 10:30:25 +00:00
Update JSDocs cheap-ruler
Update based on comments https://github.com/mapbox/cheap-ruler/pull/20 - Removed `{@name}` - Changed {Object} to {CheapRuler}
This commit is contained in:
Vendored
+2
-16
@@ -23,7 +23,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Given two points of the form [longitude, latitude], returns the distance.
|
||||
*
|
||||
* @name distance
|
||||
* @param {Array<number>} a point [longitude, latitude]
|
||||
* @param {Array<number>} b point [longitude, latitude]
|
||||
* @returns {number} distance
|
||||
@@ -36,7 +35,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Returns the bearing between two points in angles.
|
||||
*
|
||||
* @name bearing
|
||||
* @param {Array<number>} a point [longitude, latitude]
|
||||
* @param {Array<number>} b point [longitude, latitude]
|
||||
* @returns {number} bearing
|
||||
@@ -49,7 +47,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Returns a new point given distance and bearing from the starting point.
|
||||
*
|
||||
* @name destination
|
||||
* @param {Array<number>} p point [longitude, latitude]
|
||||
* @param {number} dist distance
|
||||
* @param {number} bearing
|
||||
@@ -63,7 +60,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Given a line (an array of points), returns the total line distance.
|
||||
*
|
||||
* @name lineDistance
|
||||
* @param {Array<Array<number>>} points [longitude, latitude]
|
||||
* @returns {number} total line distance
|
||||
* @example
|
||||
@@ -78,7 +74,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Given a polygon (an array of rings, where each ring is an array of points), returns the area.
|
||||
*
|
||||
* @name area
|
||||
* @param {Array<Array<Array<number>>>} polygon
|
||||
* @returns {number} area value in the specified units (square kilometers by default)
|
||||
* @example
|
||||
@@ -93,7 +88,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Returns the point at a specified distance along the line.
|
||||
*
|
||||
* @name along
|
||||
* @param {Array<Array<number>>} line
|
||||
* @param {number} dist distance
|
||||
* @returns {Array<number>} point [longitude, latitude]
|
||||
@@ -119,7 +113,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Returns a part of the given line between the start and the stop points (or their closest points on the line).
|
||||
*
|
||||
* @name lineSlice
|
||||
* @param {Array<number>} start point [longitude, latitude]
|
||||
* @param {Array<number>} stop point [longitude, latitude]
|
||||
* @param {Array<Array<number>>} line
|
||||
@@ -133,7 +126,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Returns a part of the given line between the start and the stop points indicated by distance along the line.
|
||||
*
|
||||
* @name lineSliceAlong
|
||||
* @param {number} start distance
|
||||
* @param {number} stop distance
|
||||
* @param {Array<Array<number>>} line
|
||||
@@ -147,7 +139,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Given a point, returns a bounding box object ([w, s, e, n]) created from the given point buffered by a given distance.
|
||||
*
|
||||
* @name bufferPoint
|
||||
* @param {Array<number>} p point [longitude, latitude]
|
||||
* @param {number} buffer
|
||||
* @returns {Array<number>} box object ([w, s, e, n])
|
||||
@@ -160,7 +151,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Given a bounding box, returns the box buffered by a given distance.
|
||||
*
|
||||
* @name bufferBBox
|
||||
* @param {Array<number>} box object ([w, s, e, n])
|
||||
* @param {number} buffer
|
||||
* @returns {Array<number>} box object ([w, s, e, n])
|
||||
@@ -173,7 +163,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Returns true if the given point is inside in the given bounding box, otherwise false.
|
||||
*
|
||||
* @name insideBBox
|
||||
* @param {Array<number>} p point [longitude, latitude]
|
||||
* @param {Array<number>} box object ([w, s, e, n])
|
||||
* @returns {boolean}
|
||||
@@ -186,10 +175,9 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* A collection of very fast approximations to common geodesic measurements. Useful for performance-sensitive code that measures things on a city scale.
|
||||
*
|
||||
* @name cheapRuler
|
||||
* @param {number} lat latitude
|
||||
* @param {string} [units='kilometers']
|
||||
* @returns {Object} CheapRuler
|
||||
* @returns {CheapRuler}
|
||||
* @example
|
||||
* var ruler = cheapRuler(35.05, 'miles');
|
||||
* //=ruler
|
||||
@@ -199,7 +187,6 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Multipliers for converting between units.
|
||||
*
|
||||
* @name units
|
||||
* @example
|
||||
* // convert 50 meters to yards
|
||||
* 50 * cheapRuler.units.yards / cheapRuler.units.meters;
|
||||
@@ -209,11 +196,10 @@ declare module "cheap-ruler" {
|
||||
/**
|
||||
* Creates a ruler object from tile coordinates (y and z). Convenient in tile-reduce scripts.
|
||||
*
|
||||
* @name fromTile
|
||||
* @param {number} y
|
||||
* @param {number} z
|
||||
* @param {string} [units='kilometers']
|
||||
* @returns {Object} CheapRuler
|
||||
* @returns {CheapRuler}
|
||||
* @example
|
||||
* var ruler = cheapRuler.fromTile(1567, 12);
|
||||
* //=ruler
|
||||
|
||||
Reference in New Issue
Block a user