@turf/great-circle 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -10,12 +10,13 @@ be split into a `MultiLineString`.
 
 ### Parameters
 
--   `start` **[Coord][3]** source point feature
--   `end` **[Coord][3]** destination point feature
--   `options` **[Object][4]** Optional parameters (optional, default `{}`)
-    -   `options.properties` **[Object][4]** line feature properties (optional, default `{}`)
-    -   `options.npoints` **[number][5]** number of points (optional, default `100`)
-    -   `options.offset` **[number][5]** offset controls the likelyhood that lines will
+*   `start` **[Coord][3]** source point feature
+*   `end` **[Coord][3]** destination point feature
+*   `options` **[Object][4]** Optional parameters (optional, default `{}`)
+
+    *   `options.properties` **[Object][4]** line feature properties (optional, default `{}`)
+    *   `options.npoints` **[number][5]** number of points (optional, default `100`)
+    *   `options.offset` **[number][5]** offset controls the likelyhood that lines will
         be split which cross the dateline. The higher the number the more likely. (optional, default `10`)
 
 ### Examples
@@ -30,7 +31,7 @@ var greatCircle = turf.greatCircle(start, end, {properties: {name: 'Seattle to D
 var addToMap = [start, end, greatCircle]
 ```
 
-Returns **[Feature][6]<([LineString][7] \| [MultiLineString][8])>** great circle line feature
+Returns **[Feature][6]<([LineString][7] | [MultiLineString][8])>** great circle line feature
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4
 

package/dist/es/index.js

@@ -1,5 +1,31 @@
 import { getCoord } from '@turf/invariant';
 
+/*!
+ * Copyright (c) 2019, Dane Springmeyer
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
 var D2R = Math.PI / 180;
 var R2D = 180 / Math.PI;
 

package/dist/js/index.js

@@ -2,6 +2,32 @@
 
 var invariant = require('@turf/invariant');
 
+/*!
+ * Copyright (c) 2019, Dane Springmeyer
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
 var D2R = Math.PI / 180;
 var R2D = 180 / Math.PI;
 

package/index.d.ts

@@ -2,9 +2,9 @@ import {
   LineString,
   MultiLineString,
   Feature,
-  Coord,
-  Properties,
-} from "@turf/helpers";
+  GeoJsonProperties,
+} from "geojson";
+import { Coord } from "@turf/helpers";
 
 /**
  * http://turfjs.org/docs/#greatcircle
@@ -13,7 +13,7 @@ export default function greatCircle(
   start: Coord,
   end: Coord,
   options?: {
-    properties?: Properties;
+    properties?: GeoJsonProperties;
     npoints?: number;
     offset?: number;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/great-circle",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf great-circle module",
   "author": "Turf Authors",
   "contributors": [
@@ -33,6 +33,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -44,25 +45,26 @@
     "index.d.ts"
   ],
   "scripts": {
-    "bench": "node -r esm bench.js",
+    "bench": "tsx bench.js",
     "build": "rollup -c ../../rollup.config.js && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:tape": "tsx test.js",
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
-    "@turf/truncate": "^6.5.0",
+    "@turf/truncate": "^7.0.0-alpha.1",
     "benchmark": "*",
     "load-json-file": "*",
     "npm-run-all": "*",
     "rollup": "*",
     "tape": "*",
+    "tsx": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0"
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }