@turf/convex 6.5.0 → 7.0.0-alpha.0

package/README.md

@@ -7,17 +7,18 @@
 Takes a [Feature][1] or a [FeatureCollection][2] and returns a convex hull [Polygon][3].
 
 Internally this uses
-the [convex-hull][4] module that
-implements a [monotone chain hull][5].
+the [convex-hull][4] module that implements a
+[monotone chain hull][5].
 
-**Parameters**
+### Parameters
 
--   `geojson` **[GeoJSON][6]** input Feature or FeatureCollection
--   `options` **[Object][7]** Optional parameters (optional, default `{}`)
-    -   `options.concavity` **[number][8]** 1 - thin shape. Infinity - convex hull. (optional, default `Infinity`)
-    -   `options.properties` **[Object][7]** Translate Properties to Feature (optional, default `{}`)
+*   `geojson` **[GeoJSON][6]** input Feature or FeatureCollection
+*   `options` **[Object][7]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.concavity` **[number][8]** 1 - thin shape. Infinity - convex hull. (optional, default `Infinity`)
+    *   `options.properties` **[Object][7]** Translate Properties to Feature (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var points = turf.featureCollection([
@@ -35,7 +36,7 @@ var hull = turf.convex(points);
 var addToMap = [points, hull]
 ```
 
-Returns **[Feature][9]<[Polygon][10]>** a convex hull
+Returns **[Feature][9]<[Polygon][10]>** a convex hull
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.2
 

package/dist/es/index.js

@@ -1,4 +1,4 @@
-import { polygon, } from "@turf/helpers";
+import { polygon } from "@turf/helpers";
 import { coordEach } from "@turf/meta";
 import concaveman from "concaveman";
 /**
@@ -29,20 +29,19 @@ import concaveman from "concaveman";
  * //addToMap
  * var addToMap = [points, hull]
  */
-export default function convex(geojson, options) {
-    if (options === void 0) { options = {}; }
+export default function convex(geojson, options = {}) {
     // Default parameters
     options.concavity = options.concavity || Infinity;
     // Container
-    var points = [];
+    const points = [];
     // Convert all points to flat 2D coordinate Array
-    coordEach(geojson, function (coord) {
+    coordEach(geojson, (coord) => {
         points.push([coord[0], coord[1]]);
     });
     if (!points.length) {
         return null;
     }
-    var convexHull = concaveman(points, options.concavity);
+    const convexHull = concaveman(points, options.concavity);
     // Convex hull should have at least 3 different vertices in order to create a valid polygon
     if (convexHull.length > 3) {
         return polygon([convexHull]);

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { AllGeoJSON, Feature, Polygon, Properties } from "@turf/helpers";
+import { Feature, GeoJsonProperties, Polygon } from "geojson";
+import { AllGeoJSON } from "@turf/helpers";
 /**
  * Takes a {@link Feature} or a {@link FeatureCollection} and returns a convex hull {@link Polygon}.
  *
@@ -27,7 +28,7 @@ import { AllGeoJSON, Feature, Polygon, Properties } from "@turf/helpers";
  * //addToMap
  * var addToMap = [points, hull]
  */
-export default function convex<P = Properties>(geojson: AllGeoJSON, options?: {
+export default function convex<P = GeoJsonProperties>(geojson: AllGeoJSON, options?: {
     concavity?: number;
     properties?: P;
 }): Feature<Polygon, P> | null;

package/dist/js/index.js

@@ -1,11 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var helpers_1 = require("@turf/helpers");
-var meta_1 = require("@turf/meta");
-var concaveman_1 = __importDefault(require("concaveman"));
+const tslib_1 = require("tslib");
+const helpers_1 = require("@turf/helpers");
+const meta_1 = require("@turf/meta");
+const concaveman_1 = tslib_1.__importDefault(require("concaveman"));
 /**
  * Takes a {@link Feature} or a {@link FeatureCollection} and returns a convex hull {@link Polygon}.
  *
@@ -34,20 +32,19 @@ var concaveman_1 = __importDefault(require("concaveman"));
  * //addToMap
  * var addToMap = [points, hull]
  */
-function convex(geojson, options) {
-    if (options === void 0) { options = {}; }
+function convex(geojson, options = {}) {
     // Default parameters
     options.concavity = options.concavity || Infinity;
     // Container
-    var points = [];
+    const points = [];
     // Convert all points to flat 2D coordinate Array
-    meta_1.coordEach(geojson, function (coord) {
+    meta_1.coordEach(geojson, (coord) => {
         points.push([coord[0], coord[1]]);
     });
     if (!points.length) {
         return null;
     }
-    var convexHull = concaveman_1.default(points, options.concavity);
+    const convexHull = concaveman_1.default(points, options.concavity);
     // Convex hull should have at least 3 different vertices in order to create a valid polygon
     if (convexHull.length > 3) {
         return helpers_1.polygon([convexHull]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/convex",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf convex module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -44,7 +44,7 @@
     "test:tape": "ts-node -r esm test.js"
   },
   "devDependencies": {
-    "@types/concaveman": "*",
+    "@types/concaveman": "^1.1.3",
     "@types/tape": "*",
     "benchmark": "*",
     "glob": "*",
@@ -57,9 +57,10 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
-    "@turf/meta": "^6.5.0",
-    "concaveman": "*"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
+    "concaveman": "^1.2.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }