@turf/centroid 6.0.0 → 6.0.2

package/README.md

@@ -9,8 +9,9 @@ This lessens the effect of small islands and artifacts when calculating the cent
 
 **Parameters**
 
--   `geojson` **[GeoJSON](https://tools.ietf.org/html/rfc7946#section-3)** GeoJSON to be centered
--   `properties` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** an Object that is used as the [Feature](https://tools.ietf.org/html/rfc7946#section-3.2)'s properties (optional, default `{}`)
+-   `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 `{}`)
 
 **Examples**
 
@@ -23,7 +24,17 @@ var centroid = turf.centroid(polygon);
 var addToMap = [polygon, centroid]
 ```
 
-Returns **[Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<[Point](https://tools.ietf.org/html/rfc7946#section-3.1.2)>** the centroid of the input features
+Returns **[Feature][4]<[Point][5]>** the centroid of the input features
+
+[1]: https://tools.ietf.org/html/rfc7946#section-3
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[3]: https://tools.ietf.org/html/rfc7946#section-3.2
+
+[4]: https://tools.ietf.org/html/rfc7946#section-3.2
+
+[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
 <!-- This file is automatically generated. Please don't edit it directly:
 if you find an error, edit the source file (likely index.js), and re-run

package/index.js

@@ -8,7 +8,8 @@ var helpers_1 = require("@turf/helpers");
  *
  * @name centroid
  * @param {GeoJSON} geojson GeoJSON to be centered
- * @param {Object} [properties={}] an Object that is used as the {@link Feature}'s properties
+ * @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
  * @example
  * var polygon = turf.polygon([[[-81, 41], [-88, 36], [-84, 31], [-80, 33], [-77, 39], [-81, 41]]]);
@@ -18,7 +19,8 @@ var helpers_1 = require("@turf/helpers");
  * //addToMap
  * var addToMap = [polygon, centroid]
  */
-function centroid(geojson, properties) {
+function centroid(geojson, options) {
+    if (options === void 0) { options = {}; }
     var xSum = 0;
     var ySum = 0;
     var len = 0;
@@ -27,6 +29,6 @@ function centroid(geojson, properties) {
         ySum += coord[1];
         len++;
     });
-    return helpers_1.point([xSum / len, ySum / len], properties);
+    return helpers_1.point([xSum / len, ySum / len], options.properties);
 }
 exports.default = centroid;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@turf/centroid",
-  "version": "6.0.0",
+  "version": "6.0.2",
   "description": "turf centroid module",
   "main": "index",
+  "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.ts"
+    "index.d.ts"
   ],
   "scripts": {
     "prepare": "tsc",
@@ -37,7 +38,9 @@
     "load-json-file": "*",
     "typescript": "*",
     "tape": "*",
-    "write-json-file": "*"
+    "write-json-file": "*",
+    "tslint": "*",
+    "@types/tape": "*"
   },
   "dependencies": {
     "@turf/helpers": "6.x",

package/index.ts

@@ -1,32 +0,0 @@
-import { coordEach } from '@turf/meta';
-import { point, AllGeoJSON, Feature, Point, Properties } 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.
- *
- * @name centroid
- * @param {GeoJSON} geojson GeoJSON to be centered
- * @param {Object} [properties={}] an Object that is used as the {@link Feature}'s properties
- * @returns {Feature<Point>} the centroid of the input features
- * @example
- * var polygon = turf.polygon([[[-81, 41], [-88, 36], [-84, 31], [-80, 33], [-77, 39], [-81, 41]]]);
- *
- * var centroid = turf.centroid(polygon);
- *
- * //addToMap
- * var addToMap = [polygon, centroid]
- */
-function centroid(geojson: AllGeoJSON, properties?: Properties) {
-    let xSum = 0;
-    let ySum = 0;
-    let len = 0;
-    coordEach(geojson, function (coord) {
-        xSum += coord[0];
-        ySum += coord[1];
-        len++;
-    });
-    return point([xSum / len, ySum / len], properties);
-}
-
-export default centroid;