@turf/circle 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -6,16 +6,17 @@
 
 Takes a [Point][1] and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; and steps for precision.
 
-**Parameters**
+### Parameters
 
--   `center` **([Feature][2]<[Point][3]> | [Array][4]<[number][5]>)** center point
--   `radius` **[number][5]** radius of the circle
--   `options` **[Object][6]** Optional parameters (optional, default `{}`)
-    -   `options.steps` **[number][5]** number of steps (optional, default `64`)
-    -   `options.units` **[string][7]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`)
-    -   `options.properties` **[Object][6]** properties (optional, default `{}`)
+*   `center` **([Feature][2]<[Point][3]> | [Array][4]<[number][5]>)** center point
+*   `radius` **[number][5]** radius of the circle
+*   `options` **[Object][6]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.steps` **[number][5]** number of steps (optional, default `64`)
+    *   `options.units` **[string][7]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`)
+    *   `options.properties` **[Object][6]** properties (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var center = [-75.343, 39.984];
@@ -27,7 +28,7 @@ var circle = turf.circle(center, radius, options);
 var addToMap = [turf.point(center), circle]
 ```
 
-Returns **[Feature][2]&lt;[Polygon][8]>** circle polygon
+Returns **[Feature][2]<[Polygon][8]>** circle polygon
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 

package/dist/es/index.js

@@ -1,5 +1,5 @@
 import destination from "@turf/destination";
-import { polygon, } from "@turf/helpers";
+import { polygon } from "@turf/helpers";
 /**
  * Takes a {@link Point} and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; and steps for precision.
  *
@@ -20,18 +20,17 @@ import { polygon, } from "@turf/helpers";
  * //addToMap
  * var addToMap = [turf.point(center), circle]
  */
-function circle(center, radius, options) {
-    if (options === void 0) { options = {}; }
+function circle(center, radius, options = {}) {
     // default params
-    var steps = options.steps || 64;
-    var properties = options.properties
+    const steps = options.steps || 64;
+    const properties = options.properties
         ? options.properties
         : !Array.isArray(center) && center.type === "Feature" && center.properties
             ? center.properties
             : {};
     // main
-    var coordinates = [];
-    for (var i = 0; i < steps; i++) {
+    const coordinates = [];
+    for (let i = 0; i < steps; i++) {
         coordinates.push(destination(center, radius, (i * -360) / steps, options).geometry
             .coordinates);
     }

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { Units, Point, Properties, Feature, Polygon } from "@turf/helpers";
+import { GeoJsonProperties, Feature, Point, Polygon } from "geojson";
+import { Units } from "@turf/helpers";
 /**
  * Takes a {@link Point} and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; and steps for precision.
  *
@@ -19,7 +20,7 @@ import { Units, Point, Properties, Feature, Polygon } from "@turf/helpers";
  * //addToMap
  * var addToMap = [turf.point(center), circle]
  */
-declare function circle<P = Properties>(center: number[] | Point | Feature<Point, P>, radius: number, options?: {
+declare function circle<P = GeoJsonProperties>(center: number[] | Point | Feature<Point, P>, radius: number, options?: {
     steps?: number;
     units?: Units;
     properties?: P;

package/dist/js/index.js

@@ -1,10 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var destination_1 = __importDefault(require("@turf/destination"));
-var helpers_1 = require("@turf/helpers");
+const tslib_1 = require("tslib");
+const destination_1 = tslib_1.__importDefault(require("@turf/destination"));
+const helpers_1 = require("@turf/helpers");
 /**
  * Takes a {@link Point} and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; and steps for precision.
  *
@@ -25,18 +23,17 @@ var helpers_1 = require("@turf/helpers");
  * //addToMap
  * var addToMap = [turf.point(center), circle]
  */
-function circle(center, radius, options) {
-    if (options === void 0) { options = {}; }
+function circle(center, radius, options = {}) {
     // default params
-    var steps = options.steps || 64;
-    var properties = options.properties
+    const steps = options.steps || 64;
+    const properties = options.properties
         ? options.properties
         : !Array.isArray(center) && center.type === "Feature" && center.properties
             ? center.properties
             : {};
     // main
-    var coordinates = [];
-    for (var i = 0; i < steps; i++) {
+    const coordinates = [];
+    for (let i = 0; i < steps; i++) {
         coordinates.push(destination_1.default(center, radius, (i * -360) / steps, options).geometry
             .coordinates);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/circle",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf circle module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -45,11 +46,11 @@
     "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": {
     "@mapbox/geojsonhint": "*",
-    "@turf/truncate": "^6.4.0",
+    "@turf/truncate": "^7.0.0-alpha.0",
     "@types/tape": "*",
     "benchmark": "*",
     "load-json-file": "*",
@@ -61,8 +62,9 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/destination": "^6.4.0",
-    "@turf/helpers": "^6.4.0"
+    "@turf/destination": "^7.0.0-alpha.0",
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }