@turf/circle - npm Package Compare versions

Comparing version 3.3.3 to 3.5.2-alpha.d2c36ee7

index.js

@@ -5,3 +5,2 @@ var destination = require('@turf/destination');
 
-
 /**
@@ -13,16 +12,7 @@ * Takes a {@link Point} and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; and steps for precision.
  * @param {number} radius radius of the circle
- * @param {number} steps number of steps
- * @param {String} [units=kilometers] miles, kilometers, degrees, or radians
+ * @param {number} [steps=64] number of steps
+ * @param {string} [units=kilometers] miles, kilometers, degrees, or radians
  * @returns {Feature<Polygon>} circle polygon
  * @example
- * var center = {
- *   "type": "Feature",
- *   "properties": {
- *     "marker-color": "#0f0"
- *   },
- *   "geometry": {
- *     "type": "Point",
- *     "coordinates": [-75.343, 39.984]
- *   }
- * };
+ * var center = point([-75.343, 39.984]);
  * var radius = 5;
@@ -34,8 +24,3 @@ * var steps = 10;
  *
- * var result = {
- *   "type": "FeatureCollection",
- *   "features": [center, circle]
- * };
- *
- * //=result
+ * //=circle
  */
@@ -42,0 +27,0 @@ module.exports = function (center, radius, steps, units) {

package.json

 {
   "name": "@turf/circle",
-  "version": "3.3.3",
+  "version": "3.5.2-alpha.d2c36ee7",
   "description": "turf circle module",
@@ -34,9 +34,9 @@ "main": "index.js",
     "tape": "^3.5.0",
-    "@turf/distance": "^3.3.3",
-    "@turf/inside": "^3.3.3"
+    "@turf/distance": "^3.5.2-alpha.d2c36ee7",
+    "@turf/inside": "^3.5.2-alpha.d2c36ee7"
   },
   "dependencies": {
-    "@turf/destination": "^3.3.3",
-    "@turf/helpers": "^3.3.3"
+    "@turf/destination": "^3.5.2-alpha.d2c36ee7",
+    "@turf/helpers": "^3.5.2-alpha.d2c36ee7"
   }
 }

README.md

@@ -11,4 +11,4 @@ # @turf/circle
 -   `radius` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** radius of the circle
--   `steps` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** number of steps
--   `units` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** miles, kilometers, degrees, or radians (optional, default `kilometers`)
+-   `steps` **\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** number of steps (optional, default `64`)
+-   `units` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** miles, kilometers, degrees, or radians (optional, default `kilometers`)
 
@@ -18,12 +18,3 @@ **Examples**
 ```javascript
-var center = {
-  "type": "Feature",
-  "properties": {
-    "marker-color": "#0f0"
-  },
-  "geometry": {
-    "type": "Point",
-    "coordinates": [-75.343, 39.984]
-  }
-};
+var center = point([-75.343, 39.984]);
 var radius = 5;
@@ -35,8 +26,3 @@ var steps = 10;
 
-var result = {
-  "type": "FeatureCollection",
-  "features": [center, circle]
-};
-
-//=result
+//=circle
 ```
@@ -46,2 +32,6 @@
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
@@ -48,0 +38,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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

Worsened metrics

Total package byte prevSize

6117

decreased by-39.6%

Number of package files

7

decreased by-30%

Lines of code

67

decreased by-17.28%

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

53

decreased by-15.87%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• Updated@turf/destination@^3.5.2-alpha.d2c36ee7

• Updated@turf/helpers@^3.5.2-alpha.d2c36ee7