@turf/line-segment 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -4,13 +4,14 @@
 
 ## lineSegment
 
-Creates a [FeatureCollection][1] of 2-vertex [LineString][2] segments from a [(Multi)LineString][2] or [(Multi)Polygon][3].
+Creates a [FeatureCollection][1] of 2-vertex [LineString][2] segments from a
+[(Multi)LineString][2] or [(Multi)Polygon][3].
 
-**Parameters**
+### Parameters
 
--   `geojson` **([Geometry][4] \| [FeatureCollection][5] \| [Feature][6]<([LineString][7] \| [MultiLineString][8] \| [MultiPolygon][9] \| [Polygon][10])>)** GeoJSON Polygon or LineString
+*   `geojson` **[GeoJSON][4]** GeoJSON Polygon or LineString
 
-**Examples**
+### Examples
 
 ```javascript
 var polygon = turf.polygon([[[-50, 5], [-40, -10], [-50, -10], [-40, 5], [-50, 5]]]);
@@ -20,7 +21,7 @@ var segments = turf.lineSegment(polygon);
 var addToMap = [polygon, segments]
 ```
 
-Returns **[FeatureCollection][5]<[LineString][7]>** 2-vertex line segments
+Returns **[FeatureCollection][5]<[LineString][6]>** 2-vertex line segments
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.3
 
@@ -28,19 +29,11 @@ Returns **[FeatureCollection][5]&lt;[LineString][7]>** 2-vertex line segments
 
 [3]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
-[4]: https://tools.ietf.org/html/rfc7946#section-3.1
+[4]: https://tools.ietf.org/html/rfc7946#section-3
 
 [5]: https://tools.ietf.org/html/rfc7946#section-3.3
 
-[6]: https://tools.ietf.org/html/rfc7946#section-3.2
-
-[7]: https://tools.ietf.org/html/rfc7946#section-3.1.4
-
-[8]: https://tools.ietf.org/html/rfc7946#section-3.1.5
-
-[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7
-
-[10]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+[6]: 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

package/dist/es/index.js

@@ -1,4 +1,4 @@
-import { featureCollection, lineString, } from "@turf/helpers";
+import { featureCollection, lineString } from "@turf/helpers";
 import { getCoords } from "@turf/invariant";
 import { flattenEach } from "@turf/meta";
 /**
@@ -19,8 +19,8 @@ function lineSegment(geojson) {
     if (!geojson) {
         throw new Error("geojson is required");
     }
-    var results = [];
-    flattenEach(geojson, function (feature) {
+    const results = [];
+    flattenEach(geojson, (feature) => {
         lineSegmentFeature(feature, results);
     });
     return featureCollection(results);
@@ -34,8 +34,8 @@ function lineSegment(geojson) {
  * @returns {void}
  */
 function lineSegmentFeature(geojson, results) {
-    var coords = [];
-    var geometry = geojson.geometry;
+    let coords = [];
+    const geometry = geojson.geometry;
     if (geometry !== null) {
         switch (geometry.type) {
             case "Polygon":
@@ -44,9 +44,9 @@ function lineSegmentFeature(geojson, results) {
             case "LineString":
                 coords = [getCoords(geometry)];
         }
-        coords.forEach(function (coord) {
-            var segments = createSegments(coord, geojson.properties);
-            segments.forEach(function (segment) {
+        coords.forEach((coord) => {
+            const segments = createSegments(coord, geojson.properties);
+            segments.forEach((segment) => {
                 segment.id = results.length;
                 results.push(segment);
             });
@@ -62,9 +62,9 @@ function lineSegmentFeature(geojson, results) {
  * @returns {Array<Feature<LineString>>} line segments
  */
 function createSegments(coords, properties) {
-    var segments = [];
-    coords.reduce(function (previousCoords, currentCoords) {
-        var segment = lineString([previousCoords, currentCoords], properties);
+    const segments = [];
+    coords.reduce((previousCoords, currentCoords) => {
+        const segment = lineString([previousCoords, currentCoords], properties);
         segment.bbox = bbox(previousCoords, currentCoords);
         segments.push(segment);
         return currentCoords;
@@ -80,14 +80,14 @@ function createSegments(coords, properties) {
  * @returns {BBox} [west, south, east, north]
  */
 function bbox(coords1, coords2) {
-    var x1 = coords1[0];
-    var y1 = coords1[1];
-    var x2 = coords2[0];
-    var y2 = coords2[1];
-    var west = x1 < x2 ? x1 : x2;
-    var south = y1 < y2 ? y1 : y2;
-    var east = x1 > x2 ? x1 : x2;
-    var north = y1 > y2 ? y1 : y2;
+    const x1 = coords1[0];
+    const y1 = coords1[1];
+    const x2 = coords2[0];
+    const y2 = coords2[1];
+    const west = x1 < x2 ? x1 : x2;
+    const south = y1 < y2 ? y1 : y2;
+    const east = x1 > x2 ? x1 : x2;
+    const north = y1 > y2 ? y1 : y2;
     return [west, south, east, north];
 }
 export default lineSegment;

package/dist/js/index.d.ts

@@ -1,4 +1,4 @@
-import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon, Polygon } from "@turf/helpers";
+import { Feature, FeatureCollection, LineString, MultiLineString, MultiPolygon, Polygon } from "geojson";
 /**
  * Creates a {@link FeatureCollection} of 2-vertex {@link LineString} segments from a
  * {@link LineString|(Multi)LineString} or {@link Polygon|(Multi)Polygon}.

package/dist/js/index.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var helpers_1 = require("@turf/helpers");
-var invariant_1 = require("@turf/invariant");
-var meta_1 = require("@turf/meta");
+const helpers_1 = require("@turf/helpers");
+const invariant_1 = require("@turf/invariant");
+const meta_1 = require("@turf/meta");
 /**
  * Creates a {@link FeatureCollection} of 2-vertex {@link LineString} segments from a
  * {@link LineString|(Multi)LineString} or {@link Polygon|(Multi)Polygon}.
@@ -21,8 +21,8 @@ function lineSegment(geojson) {
     if (!geojson) {
         throw new Error("geojson is required");
     }
-    var results = [];
-    meta_1.flattenEach(geojson, function (feature) {
+    const results = [];
+    meta_1.flattenEach(geojson, (feature) => {
         lineSegmentFeature(feature, results);
     });
     return helpers_1.featureCollection(results);
@@ -36,8 +36,8 @@ function lineSegment(geojson) {
  * @returns {void}
  */
 function lineSegmentFeature(geojson, results) {
-    var coords = [];
-    var geometry = geojson.geometry;
+    let coords = [];
+    const geometry = geojson.geometry;
     if (geometry !== null) {
         switch (geometry.type) {
             case "Polygon":
@@ -46,9 +46,9 @@ function lineSegmentFeature(geojson, results) {
             case "LineString":
                 coords = [invariant_1.getCoords(geometry)];
         }
-        coords.forEach(function (coord) {
-            var segments = createSegments(coord, geojson.properties);
-            segments.forEach(function (segment) {
+        coords.forEach((coord) => {
+            const segments = createSegments(coord, geojson.properties);
+            segments.forEach((segment) => {
                 segment.id = results.length;
                 results.push(segment);
             });
@@ -64,9 +64,9 @@ function lineSegmentFeature(geojson, results) {
  * @returns {Array<Feature<LineString>>} line segments
  */
 function createSegments(coords, properties) {
-    var segments = [];
-    coords.reduce(function (previousCoords, currentCoords) {
-        var segment = helpers_1.lineString([previousCoords, currentCoords], properties);
+    const segments = [];
+    coords.reduce((previousCoords, currentCoords) => {
+        const segment = helpers_1.lineString([previousCoords, currentCoords], properties);
         segment.bbox = bbox(previousCoords, currentCoords);
         segments.push(segment);
         return currentCoords;
@@ -82,14 +82,14 @@ function createSegments(coords, properties) {
  * @returns {BBox} [west, south, east, north]
  */
 function bbox(coords1, coords2) {
-    var x1 = coords1[0];
-    var y1 = coords1[1];
-    var x2 = coords2[0];
-    var y2 = coords2[1];
-    var west = x1 < x2 ? x1 : x2;
-    var south = y1 < y2 ? y1 : y2;
-    var east = x1 > x2 ? x1 : x2;
-    var north = y1 > y2 ? y1 : y2;
+    const x1 = coords1[0];
+    const y1 = coords1[1];
+    const x2 = coords2[0];
+    const y2 = coords2[1];
+    const west = x1 < x2 ? x1 : x2;
+    const south = y1 < y2 ? y1 : y2;
+    const east = x1 > x2 ? x1 : x2;
+    const north = y1 > y2 ? y1 : y2;
     return [west, south, east, north];
 }
 exports.default = lineSegment;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/line-segment",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf line-segment module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -26,6 +26,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -36,13 +37,13 @@
     "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:tape": "tsx test.js"
   },
   "devDependencies": {
     "@types/tape": "*",
@@ -50,15 +51,16 @@
     "load-json-file": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0",
-    "@turf/invariant": "^6.5.0",
-    "@turf/meta": "^6.5.0"
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/invariant": "^7.0.0-alpha.1",
+    "@turf/meta": "^7.0.0-alpha.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }