@turf/centroid 5.0.4 → 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](http://geojson.org/geojson-spec.html#geojson-objects)** 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](http://geojson.org/geojson-spec.html#feature-objects)'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](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** 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

@@ -1,13 +1,15 @@
-import { coordEach } from '@turf/meta';
-import { point } from '@turf/helpers';
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var meta_1 = require("@turf/meta");
+var helpers_1 = require("@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
+ * @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]]]);
@@ -17,16 +19,16 @@ import { point } from '@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;
-    coordEach(geojson, function (coord) {
+    meta_1.coordEach(geojson, function (coord) {
         xSum += coord[0];
         ySum += coord[1];
         len++;
-    }, true);
-    return point([xSum / len, ySum / len], properties);
+    });
+    return helpers_1.point([xSum / len, ySum / len], options.properties);
 }
-
-export default centroid;
+exports.default = centroid;

package/package.json

@@ -1,20 +1,19 @@
 {
   "name": "@turf/centroid",
-  "version": "5.0.4",
+  "version": "6.0.2",
   "description": "turf centroid module",
-  "main": "main",
-  "module": "index",
-  "jsnext:main": "index",
+  "main": "index",
   "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.d.ts",
-    "main.js"
+    "index.d.ts"
   ],
   "scripts": {
-    "pretest": "rollup -c ../../rollup.config.js",
-    "test": "node -r @std/esm test.js",
-    "bench": "node -r @std/esm bench.js"
+    "prepare": "tsc",
+    "pretest": "tsc",
+    "test": "node test.js",
+    "bench": "node bench.js",
+    "docs": "node ../../scripts/generate-readmes"
   },
   "repository": {
     "type": "git",
@@ -33,21 +32,18 @@
   },
   "homepage": "https://github.com/Turfjs/turf",
   "devDependencies": {
-    "@std/esm": "*",
     "benchmark": "*",
     "geojson-fixtures": "*",
     "glob": "*",
     "load-json-file": "*",
-    "rollup": "*",
+    "typescript": "*",
     "tape": "*",
-    "write-json-file": "*"
+    "write-json-file": "*",
+    "tslint": "*",
+    "@types/tape": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^5.0.4",
-    "@turf/meta": "^5.0.4"
-  },
-  "@std/esm": {
-    "esm": "js",
-    "cjs": true
+    "@turf/helpers": "6.x",
+    "@turf/meta": "6.x"
   }
 }

package/index.d.ts

@@ -1,9 +0,0 @@
-import { AllGeoJSON, Feature, Point, Properties } from '@turf/helpers';
-
-/**
- * http://turfjs.org/docs/#centroid
- */
-export default function (
-    features: AllGeoJSON,
-    properties?: Properties
-): Feature<Point>;

package/main.js

@@ -1,35 +0,0 @@
-'use strict';
-
-var meta = require('@turf/meta');
-var helpers = require('@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, properties) {
-    var xSum = 0;
-    var ySum = 0;
-    var len = 0;
-    meta.coordEach(geojson, function (coord) {
-        xSum += coord[0];
-        ySum += coord[1];
-        len++;
-    }, true);
-    return helpers.point([xSum / len, ySum / len], properties);
-}
-
-module.exports = centroid;
-module.exports.default = centroid;