Skip to content

Commit 6f73145

Browse files
author
Robert Czobor
committed
docs: add multigeometries to input type
1 parent 3c31d5e commit 6f73145

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

packages/turf-combine/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44

55
## combine
66

7-
Combines a [FeatureCollection][1] of [Point][2], [LineString][3], or [Polygon][4] features
8-
into [MultiPoint][5], [MultiLineString][6], or [MultiPolygon][7] features.
7+
Combines a [FeatureCollection][1] of [Point][2], [MultiPoint][3], [LineString][4],
8+
[MultiLineString][5], [Polygon][6], or [MultiPolygon][7] features
9+
into [MultiPoint][3], [MultiLineString][5], or [MultiPolygon][7] features.
910

1011
### Parameters
1112

12-
* `fc` **[FeatureCollection][1]<([Point][2] | [LineString][3] | [Polygon][4])>** a FeatureCollection of any type
13+
* `fc` **[FeatureCollection][1]<([Point][2] | [MultiPoint][3] | [LineString][4] | [MultiLineString][5] | [Polygon][6] | [MultiPolygon][7])>** a FeatureCollection of Points, MultiPoints, LineStrings, MultiLineStrings, Polygons, or MultiPolygons
1314

1415
### Examples
1516

@@ -25,19 +26,19 @@ var combined = turf.combine(fc);
2526
var addToMap = [combined]
2627
```
2728

28-
Returns **[FeatureCollection][1]<([MultiPoint][5] | [MultiLineString][6] | [MultiPolygon][7])>** a FeatureCollection of corresponding type to input
29+
Returns **[FeatureCollection][1]<([MultiPoint][3] | [MultiLineString][5] | [MultiPolygon][7])>** a FeatureCollection of corresponding type to input
2930

3031
[1]: https://tools.ietf.org/html/rfc7946#section-3.3
3132

3233
[2]: https://tools.ietf.org/html/rfc7946#section-3.1.2
3334

34-
[3]: https://tools.ietf.org/html/rfc7946#section-3.1.4
35+
[3]: https://tools.ietf.org/html/rfc7946#section-3.1.3
3536

36-
[4]: https://tools.ietf.org/html/rfc7946#section-3.1.6
37+
[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4
3738

38-
[5]: https://tools.ietf.org/html/rfc7946#section-3.1.3
39+
[5]: https://tools.ietf.org/html/rfc7946#section-3.1.5
3940

40-
[6]: https://tools.ietf.org/html/rfc7946#section-3.1.5
41+
[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6
4142

4243
[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7
4344

packages/turf-combine/index.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ import { feature, featureCollection } from "@turf/helpers";
1212
import { featureEach } from "@turf/meta";
1313

1414
/**
15-
* Combines a {@link FeatureCollection} of {@link Point}, {@link LineString}, or {@link Polygon} features
15+
* Combines a {@link FeatureCollection} of {@link Point}, {@link MultiPoint}, {@link LineString},
16+
* {@link MultiLineString}, {@link Polygon}, or {@link MultiPolygon} features
1617
* into {@link MultiPoint}, {@link MultiLineString}, or {@link MultiPolygon} features.
1718
*
1819
* @function
19-
* @param {FeatureCollection<Point|LineString|Polygon>} fc a FeatureCollection of any type
20+
* @param {FeatureCollection<Point|MultiPoint|LineString|MultiLineString|Polygon|MultiPolygon>} fc a FeatureCollection of Points, MultiPoints, LineStrings, MultiLineStrings, Polygons, or MultiPolygons
2021
* @returns {FeatureCollection<MultiPoint|MultiLineString|MultiPolygon>} a FeatureCollection of corresponding type to input
2122
* @example
2223
* var fc = turf.featureCollection([

0 commit comments

Comments
 (0)