@turf/mask
Advanced tools
Comparing version 5.1.5 to 6.2.0-alpha.1
{ | ||
"name": "@turf/mask", | ||
"version": "5.1.5", | ||
"version": "6.2.0-alpha.1", | ||
"description": "turf mask 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": [ | ||
@@ -31,10 +24,21 @@ "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": "*", | ||
"benchmark": "*", | ||
@@ -48,12 +52,9 @@ "load-json-file": "*", | ||
"dependencies": { | ||
"@turf/bbox": "^5.1.5", | ||
"@turf/helpers": "^5.1.5", | ||
"@turf/meta": "^5.1.5", | ||
"@turf/union": "^5.1.5", | ||
"@turf/bbox": "^6.2.0-alpha.1", | ||
"@turf/helpers": "^6.2.0-alpha.1", | ||
"@turf/meta": "^6.2.0-alpha.1", | ||
"@turf/union": "^6.2.0-alpha.1", | ||
"rbush": "^2.0.1" | ||
}, | ||
"@std/esm": { | ||
"esm": "js", | ||
"cjs": true | ||
} | ||
"gitHead": "fc519c045a8931c1e14eab9160a7e28391f8da02" | ||
} |
@@ -7,8 +7,8 @@ # @turf/mask | ||
Takes any type of [polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6) and an optional mask and returns a [polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6) exterior ring with holes. | ||
Takes any type of [polygon][1] and an optional mask and returns a [polygon][1] exterior ring with holes. | ||
**Parameters** | ||
- `polygon` **([FeatureCollection](https://tools.ietf.org/html/rfc7946#section-3.3) \| [Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<([Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6) \| [MultiPolygon](https://tools.ietf.org/html/rfc7946#section-3.1.7))>)** GeoJSON Polygon used as interior rings or holes. | ||
- `mask` **[Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<[Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6)>?** GeoJSON Polygon used as the exterior ring (if undefined, the world extent is used) | ||
- `polygon` **([FeatureCollection][2] \| [Feature][3]<([Polygon][4] \| [MultiPolygon][5])>)** GeoJSON Polygon used as interior rings or holes. | ||
- `mask` **[Feature][3]<[Polygon][4]>?** GeoJSON Polygon used as the exterior ring (if undefined, the world extent is used) | ||
@@ -27,4 +27,14 @@ **Examples** | ||
Returns **[Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<[Polygon](https://tools.ietf.org/html/rfc7946#section-3.1.6)>** Masked Polygon (exterior ring with holes). | ||
Returns **[Feature][3]<[Polygon][4]>** Masked Polygon (exterior ring with holes). | ||
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 | ||
[2]: https://tools.ietf.org/html/rfc7946#section-3.3 | ||
[3]: https://tools.ietf.org/html/rfc7946#section-3.2 | ||
[4]: https://tools.ietf.org/html/rfc7946#section-3.1.6 | ||
[5]: https://tools.ietf.org/html/rfc7946#section-3.1.7 | ||
<!-- This file is automatically generated. Please don't edit it directly: | ||
@@ -31,0 +41,0 @@ if you find an error, edit the source file (likely index.js), and re-run |
License Policy Violation
LicenseThis 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 riskPackage 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 riskA 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
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
21824
6
514
62
1
2
+ Added@turf/bbox@6.5.0(transitive)
+ Added@turf/helpers@6.5.0(transitive)
+ Added@turf/invariant@6.5.0(transitive)
+ Added@turf/meta@6.5.0(transitive)
+ Added@turf/union@6.5.0(transitive)
+ Addedpolygon-clipping@0.15.7(transitive)
+ Addedrobust-predicates@3.0.2(transitive)
+ Addedsplaytree@3.1.2(transitive)
- Removed@turf/bbox@5.1.5(transitive)
- Removed@turf/helpers@5.1.5(transitive)
- Removed@turf/meta@5.2.0(transitive)
- Removed@turf/union@5.1.5(transitive)
- Removedturf-jsts@1.2.3(transitive)
Updated@turf/bbox@^6.2.0-alpha.1
Updated@turf/helpers@^6.2.0-alpha.1
Updated@turf/meta@^6.2.0-alpha.1
Updated@turf/union@^6.2.0-alpha.1