@turf/line-to-polygon 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -6,15 +6,17 @@
 
 Converts (Multi)LineString(s) to Polygon(s).
 
-**Parameters**
+### Parameters
 
--   `lines` **([FeatureCollection][1] \| [Feature][2]<([LineString][3] \| [MultiLineString][4])>)** Features to convert
--   `options` **[Object][5]** Optional parameters (optional, default `{}`)
-    -   `options.properties` **[Object][5]** translates GeoJSON properties to Feature (optional, default `{}`)
-    -   `options.autoComplete` **[boolean][6]** auto complete linestrings (matches first & last coordinates) (optional, default `true`)
-    -   `options.orderCoords` **[boolean][6]** sorts linestrings to place outer ring at the first position of the coordinates (optional, default `true`)
+*   `lines` **([FeatureCollection][1] | [Feature][2]<([LineString][3] | [MultiLineString][4])>)** Features to convert
+*   `options` **[Object][5]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.properties` **[Object][5]** translates GeoJSON properties to Feature (optional, default `{}`)
+    *   `options.autoComplete` **[boolean][6]** auto complete linestrings (matches first & last coordinates) (optional, default `true`)
+    *   `options.orderCoords` **[boolean][6]** sorts linestrings to place outer ring at the first position of the coordinates (optional, default `true`)
+    *   `options.mutate` **[boolean][6]** mutate the original linestring using autoComplete (matches first & last coordinates) (optional, default `false`)
+
+### Examples
 
 ```javascript
 var line = turf.lineString([[125, -30], [145, -30], [145, -20], [125, -20], [125, -30]]);
@@ -25,7 +27,7 @@ var polygon = turf.lineToPolygon(line);
 var addToMap = [polygon];
 ```
 
-Returns **[Feature][2]&lt;([Polygon][7] \| [MultiPolygon][8])>** converted to Polygons
+Returns **[Feature][2]<([Polygon][7] | [MultiPolygon][8])>** converted to Polygons
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.3
 

package/dist/es/index.js

@@ -1,6 +1,6 @@
 import turfBBox from "@turf/bbox";
 import { getCoords, getGeom } from "@turf/invariant";
-import { polygon, multiPolygon, lineString, } from "@turf/helpers";
+import { polygon, multiPolygon, lineString } from "@turf/helpers";
 import clone from "@turf/clone";
 /**
  * Converts (Multi)LineString(s) to Polygon(s).
@@ -21,8 +21,7 @@ import clone from "@turf/clone";
  * //addToMap
  * var addToMap = [polygon];
  */
-function lineToPolygon(lines, options) {
-    if (options === void 0) { options = {}; }
+function lineToPolygon(lines, options = {}) {
     var _a, _b, _c;
     // Optional parameters
     var properties = options.properties;

package/dist/js/index.d.ts

@@ -1,4 +1,4 @@
-import { Feature, FeatureCollection, MultiLineString, LineString, Properties } from "@turf/helpers";
+import { Feature, FeatureCollection, MultiLineString, LineString, GeoJsonProperties } from "geojson";
 /**
  * Converts (Multi)LineString(s) to Polygon(s).
  *
@@ -19,9 +19,9 @@ import { Feature, FeatureCollection, MultiLineString, LineString, Properties } f
  * var addToMap = [polygon];
  */
 declare function lineToPolygon<G extends LineString | MultiLineString>(lines: Feature<G> | FeatureCollection<G> | G, options?: {
-    properties?: Properties;
+    properties?: GeoJsonProperties;
     autoComplete?: boolean;
     orderCoords?: boolean;
     mutate?: boolean;
-}): Feature<import("@turf/helpers").MultiPolygon, Properties> | Feature<import("@turf/helpers").Polygon, Properties>;
+}): Feature<import("geojson").MultiPolygon, GeoJsonProperties> | Feature<import("geojson").Polygon, GeoJsonProperties>;
 export default lineToPolygon;

package/dist/js/index.js

@@ -1,12 +1,10 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var bbox_1 = __importDefault(require("@turf/bbox"));
-var invariant_1 = require("@turf/invariant");
-var helpers_1 = require("@turf/helpers");
-var clone_1 = __importDefault(require("@turf/clone"));
+const tslib_1 = require("tslib");
+const bbox_1 = tslib_1.__importDefault(require("@turf/bbox"));
+const invariant_1 = require("@turf/invariant");
+const helpers_1 = require("@turf/helpers");
+const clone_1 = tslib_1.__importDefault(require("@turf/clone"));
 /**
  * Converts (Multi)LineString(s) to Polygon(s).
  *
@@ -26,8 +24,7 @@ var clone_1 = __importDefault(require("@turf/clone"));
  * //addToMap
  * var addToMap = [polygon];
  */
-function lineToPolygon(lines, options) {
-    if (options === void 0) { options = {}; }
+function lineToPolygon(lines, options = {}) {
     var _a, _b, _c;
     // Optional parameters
     var properties = options.properties;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/line-to-polygon",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf line-to-polygon module",
   "author": "Turf Authors",
   "contributors": [
@@ -31,6 +31,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -41,14 +42,14 @@
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
+    "bench": "tsx bench.js",
     "build": "npm-run-all build:*",
     "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
     "build:js": "tsc",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:tape": "tsx test.js",
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
     "@types/tape": "*",
@@ -56,16 +57,17 @@
     "load-json-file": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/bbox": "^6.5.0",
-    "@turf/clone": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0"
+    "@turf/bbox": "^7.0.0-alpha.1",
+    "@turf/clone": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }