Skip to content
Permalink
Browse files

Add TypeScript declaration to @turf/clean-coords (#1608)

  • Loading branch information
oliverroick authored and morganherlocker committed Mar 6, 2019
1 parent 3620b83 commit ebbdf83962b5f88b15f46b8cd4a0379e4d2a1a81
Showing with 26 additions and 0 deletions.
  1. +26 −0 packages/turf-clean-coords/index.d.ts
@@ -0,0 +1,26 @@
import { Geometry, Feature } from "@turf/helpers";

/**
* Removes redundant coordinates from any GeoJSON Geometry.
*
* @name cleanCoords
* @param {Geometry|Feature} geojson Feature or Geometry
* @param {Object} [options={}] Optional parameters
* @param {boolean} [options.mutate=false] allows GeoJSON input to be mutated
* @returns {Geometry|Feature} the cleaned input Feature/Geometry
* @example
* var line = turf.lineString([[0, 0], [0, 2], [0, 5], [0, 8], [0, 8], [0, 10]]);
* var multiPoint = turf.multiPoint([[0, 0], [0, 0], [2, 2]]);
*
* turf.cleanCoords(line).geometry.coordinates;
* //= [[0, 0], [0, 10]]
*
* turf.cleanCoords(multiPoint).geometry.coordinates;
* //= [[0, 0], [2, 2]]
*/
export default function cleanCoords<T extends Geometry | Feature>(
geojson: T,
options?: {
mutate?: boolean
}
): T;

0 comments on commit ebbdf83

Please sign in to comment.
You can’t perform that action at this time.