@turf/ellipse 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -6,19 +6,20 @@
 
 Takes a [Point][1] and calculates the ellipse polygon given two semi-axes expressed in variable units and steps for precision.
 
-**Parameters**
+### Parameters
 
--   `center` **[Coord][2]** center point
--   `xSemiAxis` **[number][3]** semi (major) axis of the ellipse along the x-axis
--   `ySemiAxis` **[number][3]** semi (minor) axis of the ellipse along the y-axis
--   `options` **[Object][4]** Optional parameters (optional, default `{}`)
-    -   `options.angle` **[number][3]** angle of rotation (along the vertical axis), from North in decimal degrees, negative clockwise (optional, default `0`)
-    -   `options.pivot` **[Coord][2]** point around which the rotation will be performed (optional, default `'origin'`)
-    -   `options.steps` **[number][3]** number of steps (optional, default `64`)
-    -   `options.units` **[string][5]** unit of measurement for axes (optional, default `'kilometers'`)
-    -   `options.properties` **[Object][4]** properties (optional, default `{}`)
+*   `center` **[Coord][2]** center point
+*   `xSemiAxis` **[number][3]** semi (major) axis of the ellipse along the x-axis
+*   `ySemiAxis` **[number][3]** semi (minor) axis of the ellipse along the y-axis
+*   `options` **[Object][4]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.angle` **[number][3]** angle of rotation in decimal degrees, positive clockwise (optional, default `0`)
+    *   `options.pivot` **[Coord][2]** point around which the rotation will be performed (optional, default `'origin'`)
+    *   `options.steps` **[number][3]** number of steps (optional, default `64`)
+    *   `options.units` **[string][5]** unit of measurement for axes (optional, default `'kilometers'`)
+    *   `options.properties` **[Object][4]** properties (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var center = [-75, 40];
@@ -30,7 +31,7 @@ var ellipse = turf.ellipse(center, xSemiAxis, ySemiAxis);
 var addToMap = [turf.point(center), ellipse]
 ```
 
-Returns **[Feature][6]<[Polygon][7]>** ellipse polygon
+Returns **[Feature][6]<[Polygon][7]>** ellipse polygon
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 

package/dist/es/index.js

@@ -1,4 +1,4 @@
-import { degreesToRadians, polygon, isObject, isNumber } from '@turf/helpers';
+import { isObject, isNumber, degreesToRadians, polygon } from '@turf/helpers';
 import rhumbDestination from '@turf/rhumb-destination';
 import transformRotate from '@turf/transform-rotate';
 import { getCoord } from '@turf/invariant';

package/dist/js/index.js

@@ -1,12 +1,15 @@
 'use strict';
 
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
 var helpers = require('@turf/helpers');
-var rhumbDestination = _interopDefault(require('@turf/rhumb-destination'));
-var transformRotate = _interopDefault(require('@turf/transform-rotate'));
+var rhumbDestination = require('@turf/rhumb-destination');
+var transformRotate = require('@turf/transform-rotate');
 var invariant = require('@turf/invariant');
 
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var rhumbDestination__default = /*#__PURE__*/_interopDefaultLegacy(rhumbDestination);
+var transformRotate__default = /*#__PURE__*/_interopDefaultLegacy(transformRotate);
+
 /**
  * Takes a {@link Point} and calculates the ellipse polygon given two semi-axes expressed in variable units and steps for precision.
  *
@@ -50,8 +53,8 @@ function ellipse(center, xSemiAxis, ySemiAxis, options) {
   if (units === "degrees") {
     var angleRad = helpers.degreesToRadians(angle);
   } else {
-    xSemiAxis = rhumbDestination(center, xSemiAxis, 90, { units: units });
-    ySemiAxis = rhumbDestination(center, ySemiAxis, 0, { units: units });
+    xSemiAxis = rhumbDestination__default['default'](center, xSemiAxis, 90, { units: units });
+    ySemiAxis = rhumbDestination__default['default'](center, ySemiAxis, 0, { units: units });
     xSemiAxis = invariant.getCoord(xSemiAxis)[0] - centerCoords[0];
     ySemiAxis = invariant.getCoord(ySemiAxis)[1] - centerCoords[1];
   }
@@ -87,7 +90,7 @@ function ellipse(center, xSemiAxis, ySemiAxis, options) {
   if (units === "degrees") {
     return helpers.polygon([coordinates], properties);
   } else {
-    return transformRotate(helpers.polygon([coordinates], properties), angle, {
+    return transformRotate__default['default'](helpers.polygon([coordinates], properties), angle, {
       pivot: pivot,
     });
   }
@@ -106,3 +109,4 @@ function getTanDeg(deg) {
 }
 
 module.exports = ellipse;
+module.exports.default = ellipse;

package/index.d.ts

@@ -1,4 +1,5 @@
-import { Feature, Coord, Polygon, Units, Properties } from "@turf/helpers";
+import { Feature, Polygon, GeoJsonProperties } from "geojson";
+import { Coord, Units } from "@turf/helpers";
 
 /**
  * http://turfjs.org/docs/#ellipse
@@ -8,8 +9,21 @@ export default function (
   xSemiAxis: number,
   ySemiAxis: number,
   options?: {
+    /** default 64 */
     steps?: number;
+    /** default kilometers */
     units?: Units;
-    properties?: Properties;
+    properties?: GeoJsonProperties;
+    /**
+     * Angle of rotation in decimal degrees, positive clockwise
+     * default 0
+     */
+    angle?: number;
+
+    /**
+     * point around which the rotation will be performed
+     * default is the point specified by center
+     */
+    pivot?: Coord;
   }
 ): Feature<Polygon>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/ellipse",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf 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"
   },
@@ -46,10 +47,10 @@
   },
   "devDependencies": {
     "@mapbox/geojsonhint": "*",
-    "@turf/bbox-polygon": "^6.4.0",
-    "@turf/circle": "^6.4.0",
-    "@turf/destination": "^6.4.0",
-    "@turf/truncate": "^6.4.0",
+    "@turf/bbox-polygon": "^7.0.0-alpha.0",
+    "@turf/circle": "^7.0.0-alpha.0",
+    "@turf/destination": "^7.0.0-alpha.0",
+    "@turf/truncate": "^7.0.0-alpha.0",
     "benchmark": "*",
     "glob": "*",
     "load-json-file": "*",
@@ -59,10 +60,10 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.4.0",
-    "@turf/invariant": "^6.4.0",
-    "@turf/rhumb-destination": "^6.4.0",
-    "@turf/transform-rotate": "^6.4.0"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/invariant": "^7.0.0-alpha.0",
+    "@turf/rhumb-destination": "^7.0.0-alpha.0",
+    "@turf/transform-rotate": "^7.0.0-alpha.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }