@turf/polygon-to-linestring - npm Package Compare versions

Comparing version 4.1.0 to 4.2.0

index.d.ts

 /// <reference types="geojson" />
 
-type Polygon = GeoJSON.Feature<GeoJSON.Polygon | GeoJSON.MultiPolygon>;
-type Lines = GeoJSON.FeatureCollection<GeoJSON.LineString | GeoJSON.MultiLineString>;
+type Polygon = GeoJSON.Feature<GeoJSON.Polygon> | GeoJSON.Polygon;
+type MultiPolygon = GeoJSON.Feature<GeoJSON.MultiPolygon> | GeoJSON.MultiPolygon;
+type Feature = GeoJSON.Feature<GeoJSON.LineString | GeoJSON.MultiLineString>;
+type FeatureCollection = GeoJSON.FeatureCollection<GeoJSON.LineString | GeoJSON.MultiLineString>;
 
-declare function polygonToLineString(polygon: Polygon): Lines;
-declare namespace polygonToLineString {}
+interface PolygonToLineString {
+  /**
+   * http://turfjs.org/docs/#polygontolinestring
+   */
+  (polygon: Polygon): Feature;
+  (polygon: MultiPolygon): FeatureCollection;
+}
+
+declare const polygonToLineString: PolygonToLineString
 export = polygonToLineString;

index.js

@@ -8,24 +8,27 @@ var getCoords = require('@turf/invariant').getCoords;
 /**
- * Converts a {@link Polygon} or {@link MultiPolygon} to a {@link FeatureCollection} of {@link LineString} or {@link MultiLineString}.
+ * Converts a {@link Polygon} to {@link LineString|(Multi)LineString} or {@link MultiPolygon} to a {@link FeatureCollection} of {@link LineString|(Multi)LineString}.
  *
  * @name polygonToLineString
  * @param {Feature<Polygon|MultiPolygon>} polygon Feature to convert
- * @returns {FeatureCollection<LineString|MultiLinestring>} converted Feature to Lines
+ * @param {Object} [properties] translates GeoJSON properties to Feature
+ * @returns {FeatureCollection|Feature<LineString|MultiLinestring>} converted (Multi)Polygon to (Multi)LineString
  * @example
  * var poly = {
- *   'type': 'Feature',
- *   'properties': {},
- *   'geometry': {
- *     'type': 'Polygon',
- *     'coordinates': [[[125, -30], [145, -30], [145, -20], [125, -20], [125, -30]]]
+ *   "type": "Feature",
+ *   "properties": {},
+ *   "geometry": {
+ *     "type": "Polygon",
+ *     "coordinates": [[[125, -30], [145, -30], [145, -20], [125, -20], [125, -30]]]
  *   }
  * }
- * var lines = turf.polygonToLineString(poly);
+ * var line = turf.polygonToLineString(poly);
+ *
  * //addToMap
- * var addToMap = [lines]
+ * var addToMap = [line];
  */
-module.exports = function (polygon) {
+module.exports = function (polygon, properties) {
     var geom = getGeomType(polygon);
     var coords = getCoords(polygon);
-    var properties = polygon.properties;
+    properties = properties || polygon.properties || {};
+
     if (!coords.length) throw new Error('polygon must contain coordinates');
@@ -35,3 +38,3 @@
     case 'Polygon':
-        return featureCollection([coordsToLine(coords, properties)]);
+        return coordsToLine(coords, properties);
     case 'MultiPolygon':
@@ -38,0 +41,0 @@ var lines = [];

package.json

 {
   "name": "@turf/polygon-to-linestring",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "turf polygon-to-linestring module",
@@ -36,5 +36,5 @@ "main": "index.js",
   "dependencies": {
-    "@turf/helpers": "^4.1.0",
-    "@turf/invariant": "^4.1.0"
+    "@turf/helpers": "^4.2.0",
+    "@turf/invariant": "^4.2.0"
   }
 }

README.md

@@ -5,3 +5,3 @@ # @turf/polygon-to-linestring
 
-Converts a [Polygon](http://geojson.org/geojson-spec.html#polygon) or [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon) to a [FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects) of [LineString](http://geojson.org/geojson-spec.html#linestring) or [MultiLineString](http://geojson.org/geojson-spec.html#multilinestring).
+Converts a [Polygon](http://geojson.org/geojson-spec.html#polygon) to [(Multi)LineString](http://geojson.org/geojson-spec.html#linestring) or [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon) to a [FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects) of [(Multi)LineString](http://geojson.org/geojson-spec.html#linestring).
 
@@ -11,2 +11,3 @@ **Parameters**
 -   `polygon` **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<([Polygon](http://geojson.org/geojson-spec.html#polygon) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon))>** Feature to convert
+-   `properties` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** translates GeoJSON properties to Feature
 
@@ -17,15 +18,16 @@ **Examples**
 var poly = {
-  'type': 'Feature',
-  'properties': {},
-  'geometry': {
-    'type': 'Polygon',
-    'coordinates': [[[125, -30], [145, -30], [145, -20], [125, -20], [125, -30]]]
+  "type": "Feature",
+  "properties": {},
+  "geometry": {
+    "type": "Polygon",
+    "coordinates": [[[125, -30], [145, -30], [145, -20], [125, -20], [125, -30]]]
   }
 }
-var lines = turf.polygonToLineString(poly);
+var line = turf.polygonToLineString(poly);
+
 //addToMap
-var addToMap = [lines]
+var addToMap = [line];
 ```
 
-Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<([LineString](http://geojson.org/geojson-spec.html#linestring) | MultiLinestring)>** converted Feature to Lines
+Returns **([FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<([LineString](http://geojson.org/geojson-spec.html#linestring) | MultiLinestring)>)** converted (Multi)Polygon to (Multi)LineString
 
@@ -32,0 +34,0 @@ <!-- This file is automatically generated. Please don't edit it directly:

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6500

increased by11.82%

Lines of code

65

increased by18.18%

Number of lines in readme file

55

increased by3.77%

Dependency changes

• Updated@turf/helpers@^4.2.0

• Updated@turf/invariant@^4.2.0