@turf/sector - npm Package Compare versions

Comparing version 5.1.5 to 6.2.0-alpha.1

index.d.ts

@@ -1,2 +0,2 @@
-import { Feature, Polygon, Units, Coord } from '@turf/helpers';
+import { Feature, Polygon, Units, Coord, Properties } from '@turf/helpers';
 
@@ -12,5 +12,6 @@ /**
     options?: {
-        steps?: number,
+        steps?: number
         units?: Units
+        properties?: Properties
     }
 ): Feature<Polygon>;

package.json

 {
   "name": "@turf/sector",
-  "version": "5.1.5",
+  "version": "6.2.0-alpha.1",
   "description": "turf sector module",
-  "main": "main.js",
-  "module": "main.es.js",
-  "types": "index.d.ts",
-  "files": [
-    "index.js",
-    "index.d.ts",
-    "main.js",
-    "main.es.js"
-  ],
-  "scripts": {
-    "pretest": "rollup -c ../../rollup.config.js",
-    "test": "node -r @std/esm test.js",
-    "posttest": "node -r @std/esm ../../scripts/validate-es5-dependencies.js",
-    "bench": "node -r @std/esm bench.js",
-    "docs": "node ../../scripts/generate-readmes"
+  "author": "Turf Authors",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Turfjs/turf/issues"
   },
+  "homepage": "https://github.com/Turfjs/turf",
   "repository": {
@@ -25,2 +15,5 @@ "type": "git",
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "keywords": [
@@ -30,11 +23,22 @@ "turf",
   ],
-  "author": "Turf Authors",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/Turfjs/turf/issues"
+  "main": "dist/js/index.js",
+  "module": "dist/es/index.js",
+  "types": "index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "bench": "npm-run-all prepare bench:run",
+    "bench:run": "node bench.js",
+    "docs": "node ../../scripts/generate-readmes",
+    "posttest": "node -r esm ../../scripts/validate-es5-dependencies.js",
+    "prepare": "rollup -c ../../rollup.config.js",
+    "test": "npm-run-all prepare test:*",
+    "test:tape": "node -r esm test.js",
+    "test:types": "tsc --noEmit types.ts"
   },
-  "homepage": "https://github.com/Turfjs/turf",
   "devDependencies": {
-    "@std/esm": "*",
-    "@turf/truncate": "^5.1.5",
+    "@turf/truncate": "^6.2.0-alpha.1",
     "benchmark": "*",
@@ -47,12 +51,9 @@ "load-json-file": "*",
   "dependencies": {
-    "@turf/circle": "^5.1.5",
-    "@turf/helpers": "^5.1.5",
-    "@turf/invariant": "^5.1.5",
-    "@turf/line-arc": "^5.1.5",
-    "@turf/meta": "^5.1.5"
+    "@turf/circle": "^6.2.0-alpha.1",
+    "@turf/helpers": "^6.2.0-alpha.1",
+    "@turf/invariant": "^6.2.0-alpha.1",
+    "@turf/line-arc": "^6.2.0-alpha.1",
+    "@turf/meta": "^6.2.0-alpha.1"
   },
-  "@std/esm": {
-    "esm": "js",
-    "cjs": true
-  }
+  "gitHead": "fc519c045a8931c1e14eab9160a7e28391f8da02"
 }

README.md

@@ -7,3 +7,3 @@ # @turf/sector
 
-Creates a circular sector of a circle of given radius and center [Point](https://tools.ietf.org/html/rfc7946#section-3.1.2),
+Creates a circular sector of a circle of given radius and center [Point][1],
 between (clockwise) bearing1 and bearing2; 0 bearing is North of center point, positive clockwise.
@@ -13,9 +13,10 @@
 
--   `center` **[Coord](https://tools.ietf.org/html/rfc7946#section-3.1.1)** center point
--   `radius` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** radius of the circle
--   `bearing1` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** angle, in decimal degrees, of the first radius of the sector
--   `bearing2` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** angle, in decimal degrees, of the second radius of the sector
--   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Optional parameters (optional, default `{}`)
-    -   `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.steps` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** number of steps (optional, default `64`)
+-   `center` **[Coord][2]** center point
+-   `radius` **[number][3]** radius of the circle
+-   `bearing1` **[number][3]** angle, in decimal degrees, of the first radius of the sector
+-   `bearing2` **[number][3]** angle, in decimal degrees, of the second radius of the sector
+-   `options` **[Object][4]** Optional parameters (optional, default `{}`)
+    -   `options.units` **[string][5]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`)
+    -   `options.steps` **[number][3]** number of steps (optional, default `64`)
+    -   `options.properties` **Properties** Translate properties to Feature Polygon (optional, default `{}`)
 
@@ -36,4 +37,18 @@ **Examples**
 
-Returns **[Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<[Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6)>** sector polygon
+Returns **[Feature][6]<[Polygon][7]>** sector polygon
 
+[1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
+
+[2]: https://tools.ietf.org/html/rfc7946#section-3.1.1
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[6]: https://tools.ietf.org/html/rfc7946#section-3.2
+
+[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+
 <!-- This file is automatically generated. Please don't edit it directly:
@@ -40,0 +55,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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Improved metrics

Total package byte prevSize

13485

increased by4.32%

Dev dependency count

6

decreased by-14.29%

Lines of code

219

increased by3.3%

Number of lines in readme file

75

increased by25%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Added@turf/circle@6.5.0(transitive)

• + Added@turf/destination@6.5.0(transitive)

• + Added@turf/helpers@6.5.0(transitive)

• + Added@turf/invariant@6.5.0(transitive)

• + Added@turf/line-arc@6.5.0(transitive)

• + Added@turf/meta@6.5.0(transitive)

• - Removed@turf/circle@5.1.5(transitive)

• - Removed@turf/destination@5.1.5(transitive)

• - Removed@turf/helpers@5.1.5(transitive)

• - Removed@turf/invariant@5.2.0(transitive)

• - Removed@turf/line-arc@5.1.5(transitive)

• - Removed@turf/meta@5.2.0(transitive)

• Updated@turf/circle@^6.2.0-alpha.1

• Updated@turf/helpers@^6.2.0-alpha.1

• Updated@turf/invariant@^6.2.0-alpha.1

• Updated@turf/line-arc@^6.2.0-alpha.1

• Updated@turf/meta@^6.2.0-alpha.1