@turf/standard-deviational-ellipse 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -16,22 +16,23 @@ in ArcGIS and the [QGIS Standard Deviational Ellipse Plugin][3]
 **Bibliography**
 
 • Robert S. Yuill, “The Standard Deviational Ellipse; An Updated Tool for
-Spatial Description,” _Geografiska Annaler_ 53, no. 1 (1971): 28–39,
-doi:[10.2307/490885][4].
+Spatial Description,” *Geografiska Annaler* 53, no. 1 (1971): 28–39,
+doi:{@link [https://doi.org/10.2307/490885|10.2307/490885}][4].
 
 • Paul Hanly Furfey, “A Note on Lefever’s “Standard Deviational Ellipse,”
-_American Journal of Sociology_ 33, no. 1 (1927): 94—98,
-doi:[10.1086/214336][5].
+*American Journal of Sociology* 33, no. 1 (1927): 94—98,
+doi:{@link [https://doi.org/10.1086/214336|10.1086/214336}][5].
 
-**Parameters**
+### Parameters
 
--   `points` **[FeatureCollection][6]<[Point][7]>** GeoJSON points
--   `options` **[Object][8]** Optional parameters (optional, default `{}`)
-    -   `options.weight` **[string][9]?** the property name used to weight the center
-    -   `options.steps` **[number][10]** number of steps for the polygon (optional, default `64`)
-    -   `options.properties` **[Object][8]** properties to pass to the resulting ellipse (optional, default `{}`)
+*   `points` **[FeatureCollection][6]<[Point][7]>** GeoJSON points
+*   `options` **[Object][8]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.weight` **[string][9]?** the property name used to weight the center
+    *   `options.steps` **[number][10]** number of steps for the polygon (optional, default `64`)
+    *   `options.properties` **[Object][8]** properties to pass to the resulting ellipse (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var bbox = [-74, 40.72, -73.98, 40.74];
@@ -42,7 +43,7 @@ var sdEllipse = turf.standardDeviationalEllipse(points);
 var addToMap = [points, sdEllipse];
 ```
 
-Returns **[Feature][11]&lt;[Polygon][12]>** an elliptical Polygon that includes approximately 1 SD of the dataset within it.
+Returns **[Feature][11]<[Polygon][12]>** an elliptical Polygon that includes approximately 1 SD of the dataset within it.
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.3
 
@@ -50,9 +51,9 @@ Returns **[Feature][11]&lt;[Polygon][12]>** an elliptical Polygon that includes
 
 [3]: http://arken.nmbu.no/~havatv/gis/qgisplugins/SDEllipse/
 
-[4]: https://doi.org/10.2307/490885
+[4]: https://doi.org/10.2307/490885|10.2307/490885}
 
-[5]: https://doi.org/10.1086/214336
+[5]: https://doi.org/10.1086/214336|10.1086/214336}
 
 [6]: https://tools.ietf.org/html/rfc7946#section-3.3
 

package/dist/es/index.js

@@ -1,6 +1,6 @@
 import { coordAll, featureEach } from '@turf/meta';
 import { getCoords } from '@turf/invariant';
-import { featureCollection, isObject, isNumber } from '@turf/helpers';
+import { isObject, isNumber, featureCollection } from '@turf/helpers';
 import centerMean from '@turf/center-mean';
 import pointsWithinPolygon from '@turf/points-within-polygon';
 import ellipse from '@turf/ellipse';

package/dist/js/index.js

@@ -1,13 +1,17 @@
 'use strict';
 
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
 var meta = require('@turf/meta');
 var invariant = require('@turf/invariant');
 var helpers = require('@turf/helpers');
-var centerMean = _interopDefault(require('@turf/center-mean'));
-var pointsWithinPolygon = _interopDefault(require('@turf/points-within-polygon'));
-var ellipse = _interopDefault(require('@turf/ellipse'));
+var centerMean = require('@turf/center-mean');
+var pointsWithinPolygon = require('@turf/points-within-polygon');
+var ellipse = require('@turf/ellipse');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var centerMean__default = /*#__PURE__*/_interopDefaultLegacy(centerMean);
+var pointsWithinPolygon__default = /*#__PURE__*/_interopDefaultLegacy(pointsWithinPolygon);
+var ellipse__default = /*#__PURE__*/_interopDefaultLegacy(ellipse);
 
 /**
  * Takes a {@link FeatureCollection} and returns a standard deviational ellipse,
@@ -61,7 +65,7 @@ function standardDeviationalEllipse(points, options) {
 
   // Calculate mean center & number of features:
   var numberOfFeatures = meta.coordAll(points).length;
-  var meanCenter = centerMean(points, { weight: weightTerm });
+  var meanCenter = centerMean__default['default'](points, { weight: weightTerm });
 
   // Calculate angle of rotation:
   // [X, Y] = mean center of all [x, y].
@@ -113,13 +117,13 @@ function standardDeviationalEllipse(points, options) {
   var sigmaX = Math.sqrt((2 * sigmaXsum) / weightsum);
   var sigmaY = Math.sqrt((2 * sigmaYsum) / weightsum);
 
-  var theEllipse = ellipse(meanCenter, sigmaX, sigmaY, {
+  var theEllipse = ellipse__default['default'](meanCenter, sigmaX, sigmaY, {
     units: "degrees",
     angle: thetaDeg,
     steps: steps,
     properties: properties,
   });
-  var pointsWithinEllipse = pointsWithinPolygon(
+  var pointsWithinEllipse = pointsWithinPolygon__default['default'](
     points,
     helpers.featureCollection([theEllipse])
   );
@@ -153,3 +157,4 @@ function getDeviations(coordinates, center) {
 }
 
 module.exports = standardDeviationalEllipse;
+module.exports.default = standardDeviationalEllipse;

package/index.d.ts

@@ -3,9 +3,9 @@ import {
   Feature,
   Position,
   Polygon,
-  Properties,
+  GeoJsonProperties,
   Point,
-} from "@turf/helpers";
+} from "geojson";
 
 /**
  * http://turfjs.org/docs/#standarddeviational-ellipse
@@ -30,7 +30,7 @@ export interface StandardDeviationalEllipse extends Feature<Polygon> {
 export default function (
   points: FeatureCollection<Point>,
   options?: {
-    properties?: Properties;
+    properties?: GeoJsonProperties;
     weight?: string;
     steps?: number;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/standard-deviational-ellipse",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf standard-deviational-ellipse module",
   "author": "Turf Authors",
   "contributors": [
@@ -15,6 +15,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -45,11 +46,11 @@
     "docs": "node ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
     "test:tape": "node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/random": "^6.4.0",
-    "@turf/truncate": "^6.4.0",
+    "@turf/random": "^7.0.0-alpha.0",
+    "@turf/truncate": "^7.0.0-alpha.0",
     "benchmark": "*",
     "load-json-file": "*",
     "npm-run-all": "*",
@@ -58,12 +59,12 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/center-mean": "^6.4.0",
-    "@turf/ellipse": "^6.4.0",
-    "@turf/helpers": "^6.4.0",
-    "@turf/invariant": "^6.4.0",
-    "@turf/meta": "^6.4.0",
-    "@turf/points-within-polygon": "^6.4.0"
+    "@turf/center-mean": "^7.0.0-alpha.0",
+    "@turf/ellipse": "^7.0.0-alpha.0",
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/invariant": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
+    "@turf/points-within-polygon": "^7.0.0-alpha.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }