@turf/distance - npm Package Compare versions

Comparing version 4.2.0 to 4.3.0

index.d.ts

 /// <reference types="geojson" />
 
-type Point = GeoJSON.Feature<GeoJSON.Point>;
+import {Units} from '@turf/helpers'
 
+type Point = GeoJSON.Feature<GeoJSON.Point> | GeoJSON.Point | number[];
+
 /**
  * http://turfjs.org/docs/#distance
  */
-declare function distance(from: Point, to: Point, units?: string): number;
+declare function distance(from: Point, to: Point, units?: Units): number;
 declare namespace distance { }
 export = distance;

index.js

@@ -13,4 +13,4 @@ var getCoord = require('@turf/invariant').getCoord;
  * @name distance
- * @param {Feature<Point>} from origin point
- * @param {Feature<Point>} to destination point
+ * @param {Geometry|Feature<Point>|Array<number>} from origin point
+ * @param {Geometry|Feature<Point>|Array<number>} to destination point
  * @param {string} [units=kilometers] can be degrees, radians, miles, or kilometers
@@ -17,0 +17,0 @@ * @returns {number} distance between the two points

package.json

 {
   "name": "@turf/distance",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "turf distance module",
@@ -32,11 +32,11 @@ "main": "index.js",
   "devDependencies": {
-    "benchmark": "^1.0.0",
-    "tape": "^3.5.0"
+    "benchmark": "^2.1.4",
+    "tape": "^4.6.3",
+    "load-json-file": "^2.0.0",
+    "write-json-file": "^2.0.0"
   },
   "dependencies": {
-    "@turf/helpers": "^4.2.0",
-    "@turf/invariant": "^4.2.0",
-    "load-json-file": "^2.0.0",
-    "write-json-file": "^2.0.0"
+    "@turf/helpers": "^4.3.0",
+    "@turf/invariant": "^4.3.0"
   }
 }

README.md

@@ -12,4 +12,4 @@ # @turf/distance
 
--   `from` **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** origin point
--   `to` **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** destination point
+-   `from` **([Geometry](http://geojson.org/geojson-spec.html#geometry) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)> | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>)** origin point
+-   `to` **([Geometry](http://geojson.org/geojson-spec.html#geometry) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)> | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>)** destination point
 -   `units` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** can be degrees, radians, miles, or kilometers (optional, default `kilometers`)
@@ -16,0 +16,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6654

increased by10.55%

Dependency count

2

decreased by-50%

Lines of code

61

increased by1.67%

Worsened metrics

Dev dependency count

4

increased by100%

Dependency changes

• - Removedload-json-file@^2.0.0

• - Removedwrite-json-file@^2.0.0

• - Removeddetect-indent@5.0.0(transitive)

• - Removederror-ex@1.3.2(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedimurmurhash@0.1.4(transitive)

• - Removedis-arrayish@0.2.1(transitive)

• - Removedis-plain-obj@1.1.0(transitive)

• - Removedload-json-file@2.0.0(transitive)

• - Removedmake-dir@1.3.0(transitive)

• - Removedparse-json@2.2.0(transitive)

• - Removedpify@2.3.03.0.0(transitive)

• - Removedsignal-exit@3.0.7(transitive)

• - Removedsort-keys@2.0.0(transitive)

• - Removedstrip-bom@3.0.0(transitive)

• - Removedwrite-file-atomic@2.4.3(transitive)

• - Removedwrite-json-file@2.3.0(transitive)

• Updated@turf/helpers@^4.3.0

• Updated@turf/invariant@^4.3.0