Skip to content

Commit

Permalink
updates doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hadbn committed Dec 17, 2024
1 parent 3642e4e commit 1f9ef05
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions packages/turf-transform-translate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ on the provided direction angle.
* `options.units` **Units** in which `distance` will be express; miles, kilometers, degrees, or radians (optional, default `'kilometers'`)
* `options.zTranslation` **[number][3]** length of the vertical motion, same unit of distance (optional, default `0`)
* `options.mutate` **[boolean][5]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`)
* `options.aroundCenter` **[boolean][5]** when set to true, for each feature the center is translated and the geometry reconstructed around it. Otherwise, points are independently translated. (optional, default `false`)

### Examples

Expand Down
4 changes: 2 additions & 2 deletions packages/turf-transform-translate/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ function transformTranslate<T extends GeoJSON | GeometryCollection>(
*
* @private
* @param {GeoJSON|GeometryCollection} feature feature or geometry collection to translate
* @param {number} distance of translation greater than 0
* @param {number} direction of translation
* @param {number} distanceTranslation of translation greater than 0
* @param {number} directionTranslation of translation
* @param {number} zTranslation
* @param {Units} units in which the distance is expressed
* @returns {GeoJSON|GeometryCollection} translated GeoJSON Feature/Geometry
Expand Down

0 comments on commit 1f9ef05

Please sign in to comment.