@turf/standard-deviational-ellipse 6.5.0 → 7.0.0-alpha.1

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/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.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf standard-deviational-ellipse module",
   "author": "Turf Authors",
   "contributors": [
@@ -30,6 +30,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -41,30 +42,31 @@
     "index.d.ts"
   ],
   "scripts": {
-    "bench": "node -r esm bench.js",
+    "bench": "tsx bench.js",
     "build": "rollup -c ../../rollup.config.js && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "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": {
-    "@turf/random": "^6.5.0",
-    "@turf/truncate": "^6.5.0",
+    "@turf/random": "^7.0.0-alpha.1",
+    "@turf/truncate": "^7.0.0-alpha.1",
     "benchmark": "*",
     "load-json-file": "*",
     "npm-run-all": "*",
     "rollup": "*",
     "tape": "*",
+    "tsx": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/center-mean": "^6.5.0",
-    "@turf/ellipse": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0",
-    "@turf/meta": "^6.5.0",
-    "@turf/points-within-polygon": "^6.5.0"
+    "@turf/center-mean": "^7.0.0-alpha.1",
+    "@turf/ellipse": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1",
+    "@turf/meta": "^7.0.0-alpha.1",
+    "@turf/points-within-polygon": "^7.0.0-alpha.1"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }