@turf/line-slice 7.0.0-alpha.2 → 7.1.0-alpha.7

package/README.md

@@ -48,26 +48,21 @@ Returns **[Feature][4]<[LineString][5]>** sliced line
 
 [5]: https://tools.ietf.org/html/rfc7946#section-3.1.4
 
-<!-- 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. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/line-slice
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,29 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// index.js
+var _invariant = require('@turf/invariant');
+var _helpers = require('@turf/helpers');
+var _nearestpointonline = require('@turf/nearest-point-on-line');
+function lineSlice(startPt, stopPt, line) {
+  var coords = _invariant.getCoords.call(void 0, line);
+  if (_invariant.getType.call(void 0, line) !== "LineString")
+    throw new Error("line must be a LineString");
+  var startVertex = _nearestpointonline.nearestPointOnLine.call(void 0, line, startPt);
+  var stopVertex = _nearestpointonline.nearestPointOnLine.call(void 0, line, stopPt);
+  var ends;
+  if (startVertex.properties.index <= stopVertex.properties.index) {
+    ends = [startVertex, stopVertex];
+  } else {
+    ends = [stopVertex, startVertex];
+  }
+  var clipCoords = [ends[0].geometry.coordinates];
+  for (var i = ends[0].properties.index + 1; i < ends[1].properties.index + 1; i++) {
+    clipCoords.push(coords[i]);
+  }
+  clipCoords.push(ends[1].geometry.coordinates);
+  return _helpers.lineString.call(void 0, clipCoords, line.properties);
+}
+var turf_line_slice_default = lineSlice;
+
+
+
+exports.default = turf_line_slice_default; exports.lineSlice = lineSlice;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.js"],"names":[],"mappings":";AAAA,SAAS,WAAW,eAAe;AACnC,SAAS,cAAc,kBAAkB;AACzC,SAAS,0BAA0B;AA+BnC,SAAS,UAAU,SAAS,QAAQ,MAAM;AAExC,MAAI,SAAS,UAAU,IAAI;AAC3B,MAAI,QAAQ,IAAI,MAAM;AACpB,UAAM,IAAI,MAAM,2BAA2B;AAE7C,MAAI,cAAc,mBAAmB,MAAM,OAAO;AAClD,MAAI,aAAa,mBAAmB,MAAM,MAAM;AAChD,MAAI;AACJ,MAAI,YAAY,WAAW,SAAS,WAAW,WAAW,OAAO;AAC/D,WAAO,CAAC,aAAa,UAAU;AAAA,EACjC,OAAO;AACL,WAAO,CAAC,YAAY,WAAW;AAAA,EACjC;AACA,MAAI,aAAa,CAAC,KAAK,CAAC,EAAE,SAAS,WAAW;AAC9C,WACM,IAAI,KAAK,CAAC,EAAE,WAAW,QAAQ,GACnC,IAAI,KAAK,CAAC,EAAE,WAAW,QAAQ,GAC/B,KACA;AACA,eAAW,KAAK,OAAO,CAAC,CAAC;AAAA,EAC3B;AACA,aAAW,KAAK,KAAK,CAAC,EAAE,SAAS,WAAW;AAC5C,SAAO,WAAW,YAAY,KAAK,UAAU;AAC/C;AAGA,IAAO,0BAAQ","sourcesContent":["import { getCoords, getType } from \"@turf/invariant\";\nimport { lineString as linestring } from \"@turf/helpers\";\nimport { nearestPointOnLine } from \"@turf/nearest-point-on-line\";\n\n/**\n * Takes a {@link LineString|line}, a start {@link Point}, and a stop point\n * and returns a subsection of the line in-between those points.\n * The start & stop points don't need to fall exactly on the line.\n *\n * This can be useful for extracting only the part of a route between waypoints.\n *\n * @name lineSlice\n * @param {Coord} startPt starting point\n * @param {Coord} stopPt stopping point\n * @param {Feature<LineString>|LineString} line line to slice\n * @returns {Feature<LineString>} sliced line\n * @example\n * var line = turf.lineString([\n *     [-77.031669, 38.878605],\n *     [-77.029609, 38.881946],\n *     [-77.020339, 38.884084],\n *     [-77.025661, 38.885821],\n *     [-77.021884, 38.889563],\n *     [-77.019824, 38.892368]\n * ]);\n * var start = turf.point([-77.029609, 38.881946]);\n * var stop = turf.point([-77.021884, 38.889563]);\n *\n * var sliced = turf.lineSlice(start, stop, line);\n *\n * //addToMap\n * var addToMap = [start, stop, line]\n */\nfunction lineSlice(startPt, stopPt, line) {\n  // Validation\n  var coords = getCoords(line);\n  if (getType(line) !== \"LineString\")\n    throw new Error(\"line must be a LineString\");\n\n  var startVertex = nearestPointOnLine(line, startPt);\n  var stopVertex = nearestPointOnLine(line, stopPt);\n  var ends;\n  if (startVertex.properties.index <= stopVertex.properties.index) {\n    ends = [startVertex, stopVertex];\n  } else {\n    ends = [stopVertex, startVertex];\n  }\n  var clipCoords = [ends[0].geometry.coordinates];\n  for (\n    var i = ends[0].properties.index + 1;\n    i < ends[1].properties.index + 1;\n    i++\n  ) {\n    clipCoords.push(coords[i]);\n  }\n  clipCoords.push(ends[1].geometry.coordinates);\n  return linestring(clipCoords, line.properties);\n}\n\nexport { lineSlice };\nexport default lineSlice;\n"]}

package/dist/cjs/index.d.cts

@@ -0,0 +1,13 @@
+import { Feature, LineString } from 'geojson';
+import { Coord } from '@turf/helpers';
+
+/**
+ * http://turfjs.org/docs/#lineslice
+ */
+declare function lineSlice(
+  startPt: Coord,
+  stopPt: Coord,
+  line: Feature<LineString> | LineString
+): Feature<LineString>;
+
+export { lineSlice as default, lineSlice };

package/dist/esm/index.d.ts

@@ -0,0 +1,13 @@
+import { Feature, LineString } from 'geojson';
+import { Coord } from '@turf/helpers';
+
+/**
+ * http://turfjs.org/docs/#lineslice
+ */
+declare function lineSlice(
+  startPt: Coord,
+  stopPt: Coord,
+  line: Feature<LineString> | LineString
+): Feature<LineString>;
+
+export { lineSlice as default, lineSlice };

package/dist/esm/index.js

@@ -0,0 +1,29 @@
+// index.js
+import { getCoords, getType } from "@turf/invariant";
+import { lineString as linestring } from "@turf/helpers";
+import { nearestPointOnLine } from "@turf/nearest-point-on-line";
+function lineSlice(startPt, stopPt, line) {
+  var coords = getCoords(line);
+  if (getType(line) !== "LineString")
+    throw new Error("line must be a LineString");
+  var startVertex = nearestPointOnLine(line, startPt);
+  var stopVertex = nearestPointOnLine(line, stopPt);
+  var ends;
+  if (startVertex.properties.index <= stopVertex.properties.index) {
+    ends = [startVertex, stopVertex];
+  } else {
+    ends = [stopVertex, startVertex];
+  }
+  var clipCoords = [ends[0].geometry.coordinates];
+  for (var i = ends[0].properties.index + 1; i < ends[1].properties.index + 1; i++) {
+    clipCoords.push(coords[i]);
+  }
+  clipCoords.push(ends[1].geometry.coordinates);
+  return linestring(clipCoords, line.properties);
+}
+var turf_line_slice_default = lineSlice;
+export {
+  turf_line_slice_default as default,
+  lineSlice
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.js"],"sourcesContent":["import { getCoords, getType } from \"@turf/invariant\";\nimport { lineString as linestring } from \"@turf/helpers\";\nimport { nearestPointOnLine } from \"@turf/nearest-point-on-line\";\n\n/**\n * Takes a {@link LineString|line}, a start {@link Point}, and a stop point\n * and returns a subsection of the line in-between those points.\n * The start & stop points don't need to fall exactly on the line.\n *\n * This can be useful for extracting only the part of a route between waypoints.\n *\n * @name lineSlice\n * @param {Coord} startPt starting point\n * @param {Coord} stopPt stopping point\n * @param {Feature<LineString>|LineString} line line to slice\n * @returns {Feature<LineString>} sliced line\n * @example\n * var line = turf.lineString([\n *     [-77.031669, 38.878605],\n *     [-77.029609, 38.881946],\n *     [-77.020339, 38.884084],\n *     [-77.025661, 38.885821],\n *     [-77.021884, 38.889563],\n *     [-77.019824, 38.892368]\n * ]);\n * var start = turf.point([-77.029609, 38.881946]);\n * var stop = turf.point([-77.021884, 38.889563]);\n *\n * var sliced = turf.lineSlice(start, stop, line);\n *\n * //addToMap\n * var addToMap = [start, stop, line]\n */\nfunction lineSlice(startPt, stopPt, line) {\n  // Validation\n  var coords = getCoords(line);\n  if (getType(line) !== \"LineString\")\n    throw new Error(\"line must be a LineString\");\n\n  var startVertex = nearestPointOnLine(line, startPt);\n  var stopVertex = nearestPointOnLine(line, stopPt);\n  var ends;\n  if (startVertex.properties.index <= stopVertex.properties.index) {\n    ends = [startVertex, stopVertex];\n  } else {\n    ends = [stopVertex, startVertex];\n  }\n  var clipCoords = [ends[0].geometry.coordinates];\n  for (\n    var i = ends[0].properties.index + 1;\n    i < ends[1].properties.index + 1;\n    i++\n  ) {\n    clipCoords.push(coords[i]);\n  }\n  clipCoords.push(ends[1].geometry.coordinates);\n  return linestring(clipCoords, line.properties);\n}\n\nexport { lineSlice };\nexport default lineSlice;\n"],"mappings":";AAAA,SAAS,WAAW,eAAe;AACnC,SAAS,cAAc,kBAAkB;AACzC,SAAS,0BAA0B;AA+BnC,SAAS,UAAU,SAAS,QAAQ,MAAM;AAExC,MAAI,SAAS,UAAU,IAAI;AAC3B,MAAI,QAAQ,IAAI,MAAM;AACpB,UAAM,IAAI,MAAM,2BAA2B;AAE7C,MAAI,cAAc,mBAAmB,MAAM,OAAO;AAClD,MAAI,aAAa,mBAAmB,MAAM,MAAM;AAChD,MAAI;AACJ,MAAI,YAAY,WAAW,SAAS,WAAW,WAAW,OAAO;AAC/D,WAAO,CAAC,aAAa,UAAU;AAAA,EACjC,OAAO;AACL,WAAO,CAAC,YAAY,WAAW;AAAA,EACjC;AACA,MAAI,aAAa,CAAC,KAAK,CAAC,EAAE,SAAS,WAAW;AAC9C,WACM,IAAI,KAAK,CAAC,EAAE,WAAW,QAAQ,GACnC,IAAI,KAAK,CAAC,EAAE,WAAW,QAAQ,GAC/B,KACA;AACA,eAAW,KAAK,OAAO,CAAC,CAAC;AAAA,EAC3B;AACA,aAAW,KAAK,KAAK,CAAC,EAAE,SAAS,WAAW;AAC5C,SAAO,WAAW,YAAY,KAAK,UAAU;AAC/C;AAGA,IAAO,0BAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/line-slice",
-  "version": "7.0.0-alpha.2",
+  "version": "7.1.0-alpha.7+0ce6ecca0",
   "description": "turf line-slice module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -25,43 +25,50 @@
     "line",
     "distance"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./index.d.ts",
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "index.d.ts",
   "sideEffects": false,
   "files": [
-    "dist",
-    "index.d.ts"
+    "dist"
   ],
   "scripts": {
-    "bench": "tsx bench.js",
-    "build": "rollup -c ../../rollup.config.js && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "docs": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx test.js"
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts"
   },
   "devDependencies": {
-    "@turf/truncate": "^7.0.0-alpha.2",
-    "benchmark": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "rollup": "*",
-    "tape": "*",
-    "tsx": "*",
-    "write-json-file": "*"
+    "@turf/truncate": "^7.1.0-alpha.7+0ce6ecca0",
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "load-json-file": "^7.0.1",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/helpers": "^7.0.0-alpha.2",
-    "@turf/invariant": "^7.0.0-alpha.2",
-    "@turf/nearest-point-on-line": "^7.0.0-alpha.2"
+    "@turf/helpers": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/invariant": "^7.1.0-alpha.7+0ce6ecca0",
+    "@turf/nearest-point-on-line": "^7.1.0-alpha.7+0ce6ecca0"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "0ce6ecca05829690270fec6d6bed2003495fe0ea"
 }

package/dist/es/index.js

@@ -1,60 +0,0 @@
-import { getCoords, getType } from '@turf/invariant';
-import { lineString } from '@turf/helpers';
-import nearestPointOnLine from '@turf/nearest-point-on-line';
-
-/**
- * Takes a {@link LineString|line}, a start {@link Point}, and a stop point
- * and returns a subsection of the line in-between those points.
- * The start & stop points don't need to fall exactly on the line.
- *
- * This can be useful for extracting only the part of a route between waypoints.
- *
- * @name lineSlice
- * @param {Coord} startPt starting point
- * @param {Coord} stopPt stopping point
- * @param {Feature<LineString>|LineString} line line to slice
- * @returns {Feature<LineString>} sliced line
- * @example
- * var line = turf.lineString([
- *     [-77.031669, 38.878605],
- *     [-77.029609, 38.881946],
- *     [-77.020339, 38.884084],
- *     [-77.025661, 38.885821],
- *     [-77.021884, 38.889563],
- *     [-77.019824, 38.892368]
- * ]);
- * var start = turf.point([-77.029609, 38.881946]);
- * var stop = turf.point([-77.021884, 38.889563]);
- *
- * var sliced = turf.lineSlice(start, stop, line);
- *
- * //addToMap
- * var addToMap = [start, stop, line]
- */
-function lineSlice(startPt, stopPt, line) {
-  // Validation
-  var coords = getCoords(line);
-  if (getType(line) !== "LineString")
-    throw new Error("line must be a LineString");
-
-  var startVertex = nearestPointOnLine(line, startPt);
-  var stopVertex = nearestPointOnLine(line, stopPt);
-  var ends;
-  if (startVertex.properties.index <= stopVertex.properties.index) {
-    ends = [startVertex, stopVertex];
-  } else {
-    ends = [stopVertex, startVertex];
-  }
-  var clipCoords = [ends[0].geometry.coordinates];
-  for (
-    var i = ends[0].properties.index + 1;
-    i < ends[1].properties.index + 1;
-    i++
-  ) {
-    clipCoords.push(coords[i]);
-  }
-  clipCoords.push(ends[1].geometry.coordinates);
-  return lineString(clipCoords, line.properties);
-}
-
-export default lineSlice;

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,67 +0,0 @@
-'use strict';
-
-var invariant = require('@turf/invariant');
-var helpers = require('@turf/helpers');
-var nearestPointOnLine = require('@turf/nearest-point-on-line');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var nearestPointOnLine__default = /*#__PURE__*/_interopDefaultLegacy(nearestPointOnLine);
-
-/**
- * Takes a {@link LineString|line}, a start {@link Point}, and a stop point
- * and returns a subsection of the line in-between those points.
- * The start & stop points don't need to fall exactly on the line.
- *
- * This can be useful for extracting only the part of a route between waypoints.
- *
- * @name lineSlice
- * @param {Coord} startPt starting point
- * @param {Coord} stopPt stopping point
- * @param {Feature<LineString>|LineString} line line to slice
- * @returns {Feature<LineString>} sliced line
- * @example
- * var line = turf.lineString([
- *     [-77.031669, 38.878605],
- *     [-77.029609, 38.881946],
- *     [-77.020339, 38.884084],
- *     [-77.025661, 38.885821],
- *     [-77.021884, 38.889563],
- *     [-77.019824, 38.892368]
- * ]);
- * var start = turf.point([-77.029609, 38.881946]);
- * var stop = turf.point([-77.021884, 38.889563]);
- *
- * var sliced = turf.lineSlice(start, stop, line);
- *
- * //addToMap
- * var addToMap = [start, stop, line]
- */
-function lineSlice(startPt, stopPt, line) {
-  // Validation
-  var coords = invariant.getCoords(line);
-  if (invariant.getType(line) !== "LineString")
-    throw new Error("line must be a LineString");
-
-  var startVertex = nearestPointOnLine__default['default'](line, startPt);
-  var stopVertex = nearestPointOnLine__default['default'](line, stopPt);
-  var ends;
-  if (startVertex.properties.index <= stopVertex.properties.index) {
-    ends = [startVertex, stopVertex];
-  } else {
-    ends = [stopVertex, startVertex];
-  }
-  var clipCoords = [ends[0].geometry.coordinates];
-  for (
-    var i = ends[0].properties.index + 1;
-    i < ends[1].properties.index + 1;
-    i++
-  ) {
-    clipCoords.push(coords[i]);
-  }
-  clipCoords.push(ends[1].geometry.coordinates);
-  return helpers.lineString(clipCoords, line.properties);
-}
-
-module.exports = lineSlice;
-module.exports.default = lineSlice;

package/index.d.ts

@@ -1,11 +0,0 @@
-import { Feature, LineString } from "geojson";
-import { Coord } from "@turf/helpers";
-
-/**
- * http://turfjs.org/docs/#lineslice
- */
-export default function lineSlice(
-  startPt: Coord,
-  stopPt: Coord,
-  line: Feature<LineString> | LineString
-): Feature<LineString>;