@turf/mask 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -6,46 +6,33 @@
 
 Takes any type of [polygon][1] and an optional mask and returns a [polygon][1] exterior ring with holes.
 
-**Parameters**
+### Parameters
 
-- `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)
+*   `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)
 
-**Examples**
+### Examples
 
 ```javascript
-var polygon = turf.polygon([
-  [
-    [112, -21],
-    [116, -36],
-    [146, -39],
-    [153, -24],
-    [133, -10],
-    [112, -21],
-  ],
-]);
-var mask = turf.polygon([
-  [
-    [90, -55],
-    [170, -55],
-    [170, 10],
-    [90, 10],
-    [90, -55],
-  ],
-]);
+var polygon = turf.polygon([[[112, -21], [116, -36], [146, -39], [153, -24], [133, -10], [112, -21]]]);
+var mask = turf.polygon([[[90, -55], [170, -55], [170, 10], [90, 10], [90, -55]]]);
 
 var masked = turf.mask(polygon, mask);
 
 //addToMap
-var addToMap = [masked];
+var addToMap = [masked]
 ```
 
-Returns **[Feature][3]&lt;[Polygon][4]>** 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:

package/index.d.ts

@@ -1,9 +1,4 @@
-import {
-  Feature,
-  Polygon,
-  MultiPolygon,
-  FeatureCollection,
-} from "@turf/helpers";
+import { Feature, Polygon, MultiPolygon, FeatureCollection } from "geojson";
 
 /**
  * http://turfjs.org/docs/#mask

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/mask",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf mask module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -26,6 +26,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -37,12 +38,12 @@
     "index.d.ts"
   ],
   "scripts": {
-    "bench": "node -r esm bench.js",
+    "bench": "tsx bench.js",
     "build": "rollup -c ../../rollup.config.js && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:tape": "tsx test.js",
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
     "benchmark": "*",
@@ -51,11 +52,12 @@
     "npm-run-all": "*",
     "rollup": "*",
     "tape": "*",
+    "tsx": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
+    "@turf/helpers": "^7.0.0-alpha.1",
     "polygon-clipping": "^0.15.3"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }