index.d.cts 1.0 KB

12345678910111213141516171819202122232425
  1. import { FeatureCollection, Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeoJsonProperties } from 'geojson';
  2. /**
  3. * Combines a {@link FeatureCollection} of {@link Point}, {@link LineString}, or {@link Polygon} features
  4. * into {@link MultiPoint}, {@link MultiLineString}, or {@link MultiPolygon} features.
  5. *
  6. * @function
  7. * @param {FeatureCollection<Point|LineString|Polygon>} fc a FeatureCollection of any type
  8. * @returns {FeatureCollection<MultiPoint|MultiLineString|MultiPolygon>} a FeatureCollection of corresponding type to input
  9. * @example
  10. * var fc = turf.featureCollection([
  11. * turf.point([19.026432, 47.49134]),
  12. * turf.point([19.074497, 47.509548])
  13. * ]);
  14. *
  15. * var combined = turf.combine(fc);
  16. *
  17. * //addToMap
  18. * var addToMap = [combined]
  19. */
  20. declare function combine(fc: FeatureCollection<Point | MultiPoint | LineString | MultiLineString | Polygon | MultiPolygon>): FeatureCollection<MultiPoint | MultiLineString | MultiPolygon, {
  21. collectedProperties: GeoJsonProperties[];
  22. }>;
  23. export { combine, combine as default };