@turf/circle - npm Package Compare versions

Comparing version 6.0.0 to 6.0.1

package.json

 {
   "name": "@turf/circle",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "description": "turf circle module",
   "main": "index",
+  "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.ts"
+    "index.d.ts"
   ],
@@ -42,3 +43,5 @@ "scripts": {
     "tape": "*",
-    "write-json-file": "*"
+    "write-json-file": "*",
+    "tslint": "*",
+    "@types/tape": "*"
   },
@@ -45,0 +48,0 @@ "dependencies": {

README.md

@@ -7,12 +7,12 @@ # @turf/circle
 
-Takes a [Point](https://tools.ietf.org/html/rfc7946#section-3.1.2) and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; and steps for precision.
+Takes a [Point][1] and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; and steps for precision.
 
 **Parameters**
 
--   `center` **([Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<[Point](https://tools.ietf.org/html/rfc7946#section-3.1.2)> | [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)>)** center point
--   `radius` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** radius of the circle
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Optional parameters (optional, default `{}`)
-    -   `options.steps` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** number of steps (optional, default `64`)
-    -   `options.units` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** miles, kilometers, degrees, or radians (optional, default `'kilometers'`)
-    -   `options.properties` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 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 `{}`)
+    -   `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 `{}`)
 
@@ -31,4 +31,20 @@ **Examples**
 
-Returns **[Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<[Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6)>** circle polygon
+Returns **[Feature][2]<[Polygon][8]>** circle polygon
 
+[1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+
+[2]: https://tools.ietf.org/html/rfc7946#section-3.2
+
+[3]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[8]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+
 <!-- This file is automatically generated. Please don't edit it directly:
@@ -35,0 +51,0 @@ if you find an error, edit the source file (likely index.js), and re-run

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

Number of lines in readme file

72

increased by28.57%

Worsened metrics

Total package byte prevSize

6040

decreased by-23.78%

Dev dependency count

9

increased by28.57%

Number of package files

4

decreased by-20%

Lines of code

38

decreased by-50.65%

No dependency changes