@turf/centroid 6.5.0 → 7.0.0-alpha.0

package/README.md

@@ -4,16 +4,16 @@
 
 ## centroid
 
-Takes one or more features and calculates the centroid using the mean of all vertices.
-This lessens the effect of small islands and artifacts when calculating the centroid of a set of polygons.
+Computes the centroid as the mean of all vertices within the object.
 
-**Parameters**
+### Parameters
 
--   `geojson` **[GeoJSON][1]** GeoJSON to be centered
--   `options` **[Object][2]** Optional Parameters (optional, default `{}`)
-    -   `options.properties` **[Object][2]** an Object that is used as the [Feature][3]'s properties (optional, default `{}`)
+*   `geojson` **[GeoJSON][1]** GeoJSON to be centered
+*   `options` **[Object][2]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.properties` **[Object][2]** an Object that is used as the [Feature][3]'s properties (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var polygon = turf.polygon([[[-81, 41], [-88, 36], [-84, 31], [-80, 33], [-77, 39], [-81, 41]]]);
@@ -24,7 +24,7 @@ var centroid = turf.centroid(polygon);
 var addToMap = [polygon, centroid]
 ```
 
-Returns **[Feature][4]<[Point][5]>** the centroid of the input features
+Returns **[Feature][4]<[Point][5]>** the centroid of the input object
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3
 

package/dist/es/index.js

@@ -1,14 +1,13 @@
-import { coordEach } from "@turf/meta";
 import { point } from "@turf/helpers";
+import { coordEach } from "@turf/meta";
 /**
- * Takes one or more features and calculates the centroid using the mean of all vertices.
- * This lessens the effect of small islands and artifacts when calculating the centroid of a set of polygons.
+ * Computes the centroid as the mean of all vertices within the object.
  *
  * @name centroid
  * @param {GeoJSON} geojson GeoJSON to be centered
  * @param {Object} [options={}] Optional Parameters
  * @param {Object} [options.properties={}] an Object that is used as the {@link Feature}'s properties
- * @returns {Feature<Point>} the centroid of the input features
+ * @returns {Feature<Point>} the centroid of the input object
  * @example
  * var polygon = turf.polygon([[[-81, 41], [-88, 36], [-84, 31], [-80, 33], [-77, 39], [-81, 41]]]);
  *
@@ -17,11 +16,10 @@ import { point } from "@turf/helpers";
  * //addToMap
  * var addToMap = [polygon, centroid]
  */
-function centroid(geojson, options) {
-    if (options === void 0) { options = {}; }
-    var xSum = 0;
-    var ySum = 0;
-    var len = 0;
+function centroid(geojson, options = {}) {
+    let xSum = 0;
+    let ySum = 0;
+    let len = 0;
     coordEach(geojson, function (coord) {
         xSum += coord[0];
         ySum += coord[1];

package/dist/js/index.d.ts

@@ -1,13 +1,13 @@
-import { AllGeoJSON, Feature, Point, Properties } from "@turf/helpers";
+import { Feature, GeoJsonProperties, Point } from "geojson";
+import { AllGeoJSON } from "@turf/helpers";
 /**
- * Takes one or more features and calculates the centroid using the mean of all vertices.
- * This lessens the effect of small islands and artifacts when calculating the centroid of a set of polygons.
+ * Computes the centroid as the mean of all vertices within the object.
  *
  * @name centroid
  * @param {GeoJSON} geojson GeoJSON to be centered
  * @param {Object} [options={}] Optional Parameters
  * @param {Object} [options.properties={}] an Object that is used as the {@link Feature}'s properties
- * @returns {Feature<Point>} the centroid of the input features
+ * @returns {Feature<Point>} the centroid of the input object
  * @example
  * var polygon = turf.polygon([[[-81, 41], [-88, 36], [-84, 31], [-80, 33], [-77, 39], [-81, 41]]]);
  *
@@ -16,7 +16,7 @@ import { AllGeoJSON, Feature, Point, Properties } from "@turf/helpers";
  * //addToMap
  * var addToMap = [polygon, centroid]
  */
-declare function centroid<P = Properties>(geojson: AllGeoJSON, options?: {
+declare function centroid<P = GeoJsonProperties>(geojson: AllGeoJSON, options?: {
     properties?: P;
 }): Feature<Point, P>;
 export default centroid;

package/dist/js/index.js

@@ -1,16 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var meta_1 = require("@turf/meta");
-var helpers_1 = require("@turf/helpers");
+const helpers_1 = require("@turf/helpers");
+const meta_1 = require("@turf/meta");
 /**
- * Takes one or more features and calculates the centroid using the mean of all vertices.
- * This lessens the effect of small islands and artifacts when calculating the centroid of a set of polygons.
+ * Computes the centroid as the mean of all vertices within the object.
  *
  * @name centroid
  * @param {GeoJSON} geojson GeoJSON to be centered
  * @param {Object} [options={}] Optional Parameters
  * @param {Object} [options.properties={}] an Object that is used as the {@link Feature}'s properties
- * @returns {Feature<Point>} the centroid of the input features
+ * @returns {Feature<Point>} the centroid of the input object
  * @example
  * var polygon = turf.polygon([[[-81, 41], [-88, 36], [-84, 31], [-80, 33], [-77, 39], [-81, 41]]]);
  *
@@ -19,11 +18,10 @@ var helpers_1 = require("@turf/helpers");
  * //addToMap
  * var addToMap = [polygon, centroid]
  */
-function centroid(geojson, options) {
-    if (options === void 0) { options = {}; }
-    var xSum = 0;
-    var ySum = 0;
-    var len = 0;
+function centroid(geojson, options = {}) {
+    let xSum = 0;
+    let ySum = 0;
+    let len = 0;
     meta_1.coordEach(geojson, function (coord) {
         xSum += coord[0];
         ySum += coord[1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/centroid",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf centroid module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -44,7 +44,7 @@
     "docs": "node ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
     "test:tape": "ts-node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
     "@types/tape": "*",
@@ -60,8 +60,9 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
-    "@turf/meta": "^6.5.0"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }