line-segment: Simplify implementation and add GeometryCollection test fixture #727
Conversation
It was intended that Point & MultiPoints are simply ignored since they don't have lines, but if one would have a FeatureCollection of random stuff (Points, Lines, Polygon) and wanted to retrieve line segments from it then it would break if one point would exist in the dataset. Currently it's not harmful to have the If there's a scenario that's worth throwing an error for Points in |
|
|
||
| /** | ||
| * Creates a {@link FeatureCollection} of 2-vertex {@link LineString} segments from a {@link LineString|(Multi)LineString} or {@link Polygon|(Multi)Polygon}. | ||
| * | ||
| * @name lineSegment | ||
| * @param {Geometry|FeatureCollection|Feature<LineString|MultiLineString|MultiPolygon|Polygon>} geojson GeoJSON Polygon or LineString | ||
| * @param {GeometryCollection|Geometry|FeatureCollection|Feature<LineString|MultiLineString|MultiPolygon|Polygon>} geojson GeoJSON Polygon or LineString |
There was a problem hiding this comment.
These JSDocs are becoming so long!... 😮
I wonder if we could shorthand the Multi Geometries
To me GeometryCollection is Geometry (it was just never supported correctly in the past).
/**
* @param {Geometry|FeatureCollection|Feature<(Multi)LineString|(Multi)Polygon>}| default: | ||
| lineSegment(geojson, results); | ||
| } | ||
| flattenEach(geojson, function (feature) { |
| } | ||
| geomEach(flatten(geojson), function (geometry) { |
There was a problem hiding this comment.
Love it! 🏅 Removing LOCs is the best
Originally planned on adding Geometry support per #726 for
line-segmentuntil I realized that @DenisCarriere beat me to the punch. So, insteadflattenEachQuestion regarding current implementation. Is it intended for the method to silently ignore input geometries that are not lines or polygons?
I can see how that would be helpful for a user with a large feature collection that only wants the lines and polygons processed without having to create a new layer. But since Turf does a lot of input validation elsewhere, I wasn't sure if this was the intended design.
Please fill in this template.
npm testat the sub modules where changes have occurred.npm run lintto ensure code style at the turf module level.