@turf/boolean-touches 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -4,26 +4,31 @@
 
 ## booleanTouches
 
-Boolean-touches returns true if the first geometry is completely within the second geometry.
-The interiors of both geometries must intersect and, the interior and boundary of the primary (geometry a)
-must not intersect the exterior of the secondary (geometry b).
+Boolean-touches true if none of the points common to both geometries
+intersect the interiors of both geometries.
 
-**Parameters**
+### Parameters
 
--   `feature1` **([Geometry](https://tools.ietf.org/html/rfc7946#section-3.1) \| [Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<any>)** GeoJSON Feature or Geometry
--   `feature2` **([Geometry](https://tools.ietf.org/html/rfc7946#section-3.1) \| [Feature](https://tools.ietf.org/html/rfc7946#section-3.2)<any>)** GeoJSON Feature or Geometry
+*   `feature1` **([Geometry][1] | [Feature][2]\<any>)** GeoJSON Feature or Geometry
+*   `feature2` **([Geometry][1] | [Feature][2]\<any>)** GeoJSON Feature or Geometry
 
-**Examples**
+### Examples
 
 ```javascript
 var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
-var point = turf.point([1, 2]);
+var point = turf.point([1, 1]);
 
 turf.booleanTouches(point, line);
 //=true
 ```
 
-Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true/false
+Returns **[boolean][3]** true/false
+
+[1]: https://tools.ietf.org/html/rfc7946#section-3.1
+
+[2]: https://tools.ietf.org/html/rfc7946#section-3.2
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
 <!-- 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

package/dist/js/index.d.ts

@@ -1,4 +1,4 @@
-import { Feature, Geometry } from "@turf/helpers";
+import { Feature, Geometry } from "geojson";
 /**
  * Boolean-touches true if none of the points common to both geometries
  * intersect the interiors of both geometries.

package/dist/js/index.js

@@ -1,11 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var boolean_point_on_line_1 = __importDefault(require("@turf/boolean-point-on-line"));
-var boolean_point_in_polygon_1 = __importDefault(require("@turf/boolean-point-in-polygon"));
-var invariant_1 = require("@turf/invariant");
+const tslib_1 = require("tslib");
+const boolean_point_on_line_1 = tslib_1.__importDefault(require("@turf/boolean-point-on-line"));
+const boolean_point_in_polygon_1 = tslib_1.__importDefault(require("@turf/boolean-point-in-polygon"));
+const invariant_1 = require("@turf/invariant");
 /**
  * Boolean-touches true if none of the points common to both geometries
  * intersect the interiors of both geometries.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/boolean-touches",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf boolean-touches module",
   "author": "Turf Authors",
   "contributors": [
@@ -32,6 +32,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -42,14 +43,14 @@
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
+    "bench": "tsx bench.js",
     "build": "npm-run-all build:*",
     "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
     "build:js": "tsc",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "ts-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": {
     "@types/tape": "*",
@@ -60,15 +61,16 @@
     "load-json-file": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*"
   },
   "dependencies": {
-    "@turf/boolean-point-in-polygon": "^6.5.0",
-    "@turf/boolean-point-on-line": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0"
+    "@turf/boolean-point-in-polygon": "^7.0.0-alpha.1",
+    "@turf/boolean-point-on-line": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }