mirror of
https://github.com/Turfjs/turf.git
synced 2025-12-08 20:26:16 +00:00
Add TypeScript declaration to @turf/clean-coords (#1608)
This commit is contained in:
parent
3620b83017
commit
ebbdf83962
26
packages/turf-clean-coords/index.d.ts
vendored
Normal file
26
packages/turf-clean-coords/index.d.ts
vendored
Normal file
@ -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;
|
||||
Loading…
x
Reference in New Issue
Block a user