@turf/length 7.0.0-alpha.2 → 7.0.0

package/README.md

@@ -42,26 +42,21 @@ Returns **[number][8]** length of GeoJSON
 
 [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-<!-- 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/length
 ```
 
-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,23 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+var _distance = require('@turf/distance');
+var _meta = require('@turf/meta');
+function length(geojson, options = {}) {
+  return _meta.segmentReduce.call(void 0, 
+    geojson,
+    (previousValue, segment) => {
+      const coords = segment.geometry.coordinates;
+      return previousValue + _distance.distance.call(void 0, coords[0], coords[1], options);
+    },
+    0
+  );
+}
+__name(length, "length");
+var turf_length_default = length;
+
+
+
+exports.default = turf_length_default; exports.length = length;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";;;;AACA,SAAS,gBAAgB;AAEzB,SAAS,qBAAqB;AAkB9B,SAAS,OACP,SACA,UAEI,CAAC,GACG;AAER,SAAO;AAAA,IACL;AAAA,IACA,CAAC,eAAe,YAAY;AAC1B,YAAM,SAAS,QAAS,SAAS;AACjC,aAAO,gBAAiB,SAAS,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,OAAO;AAAA,IAChE;AAAA,IACA;AAAA,EACF;AACF;AAfS;AAkBT,IAAO,sBAAQ","sourcesContent":["import { Feature, FeatureCollection, GeometryCollection } from \"geojson\";\nimport { distance } from \"@turf/distance\";\nimport { Units } from \"@turf/helpers\";\nimport { segmentReduce } from \"@turf/meta\";\n\n/**\n * Takes a {@link GeoJSON} and measures its length in the specified units, {@link (Multi)Point}'s distance are ignored.\n *\n * @name length\n * @param {Feature<LineString|MultiLineString>} geojson GeoJSON to measure\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units=kilometers] can be degrees, radians, miles, or kilometers\n * @returns {number} length of GeoJSON\n * @example\n * var line = turf.lineString([[115, -32], [131, -22], [143, -25], [150, -34]]);\n * var length = turf.length(line, {units: 'miles'});\n *\n * //addToMap\n * var addToMap = [line];\n * line.properties.distance = length;\n */\nfunction length(\n  geojson: Feature<any> | FeatureCollection<any> | GeometryCollection,\n  options: {\n    units?: Units;\n  } = {}\n): number {\n  // Calculate distance from 2-vertex line segments\n  return segmentReduce(\n    geojson,\n    (previousValue, segment) => {\n      const coords = segment!.geometry.coordinates;\n      return previousValue! + distance(coords[0], coords[1], options);\n    },\n    0\n  );\n}\n\nexport { length };\nexport default length;\n"]}

package/dist/{es/index.js → cjs/index.d.cts}

@@ -1,5 +1,6 @@
-import distance from "@turf/distance";
-import { segmentReduce } from "@turf/meta";
+import { Feature, FeatureCollection, GeometryCollection } from 'geojson';
+import { Units } from '@turf/helpers';
+
 /**
  * Takes a {@link GeoJSON} and measures its length in the specified units, {@link (Multi)Point}'s distance are ignored.
  *
@@ -16,10 +17,8 @@ import { segmentReduce } from "@turf/meta";
  * var addToMap = [line];
  * line.properties.distance = length;
  */
-export default function length(geojson, options = {}) {
-    // Calculate distance from 2-vertex line segments
-    return segmentReduce(geojson, (previousValue, segment) => {
-        const coords = segment.geometry.coordinates;
-        return previousValue + distance(coords[0], coords[1], options);
-    }, 0);
-}
+declare function length(geojson: Feature<any> | FeatureCollection<any> | GeometryCollection, options?: {
+    units?: Units;
+}): number;
+
+export { length as default, length };

package/dist/{js → esm}/index.d.ts

@@ -1,5 +1,6 @@
-import { Feature, FeatureCollection, GeometryCollection } from "geojson";
-import { Units } from "@turf/helpers";
+import { Feature, FeatureCollection, GeometryCollection } from 'geojson';
+import { Units } from '@turf/helpers';
+
 /**
  * Takes a {@link GeoJSON} and measures its length in the specified units, {@link (Multi)Point}'s distance are ignored.
  *
@@ -16,6 +17,8 @@ import { Units } from "@turf/helpers";
  * var addToMap = [line];
  * line.properties.distance = length;
  */
-export default function length(geojson: Feature<any> | FeatureCollection<any> | GeometryCollection, options?: {
+declare function length(geojson: Feature<any> | FeatureCollection<any> | GeometryCollection, options?: {
     units?: Units;
 }): number;
+
+export { length as default, length };

package/dist/esm/index.js

@@ -0,0 +1,23 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { distance } from "@turf/distance";
+import { segmentReduce } from "@turf/meta";
+function length(geojson, options = {}) {
+  return segmentReduce(
+    geojson,
+    (previousValue, segment) => {
+      const coords = segment.geometry.coordinates;
+      return previousValue + distance(coords[0], coords[1], options);
+    },
+    0
+  );
+}
+__name(length, "length");
+var turf_length_default = length;
+export {
+  turf_length_default as default,
+  length
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, FeatureCollection, GeometryCollection } from \"geojson\";\nimport { distance } from \"@turf/distance\";\nimport { Units } from \"@turf/helpers\";\nimport { segmentReduce } from \"@turf/meta\";\n\n/**\n * Takes a {@link GeoJSON} and measures its length in the specified units, {@link (Multi)Point}'s distance are ignored.\n *\n * @name length\n * @param {Feature<LineString|MultiLineString>} geojson GeoJSON to measure\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units=kilometers] can be degrees, radians, miles, or kilometers\n * @returns {number} length of GeoJSON\n * @example\n * var line = turf.lineString([[115, -32], [131, -22], [143, -25], [150, -34]]);\n * var length = turf.length(line, {units: 'miles'});\n *\n * //addToMap\n * var addToMap = [line];\n * line.properties.distance = length;\n */\nfunction length(\n  geojson: Feature<any> | FeatureCollection<any> | GeometryCollection,\n  options: {\n    units?: Units;\n  } = {}\n): number {\n  // Calculate distance from 2-vertex line segments\n  return segmentReduce(\n    geojson,\n    (previousValue, segment) => {\n      const coords = segment!.geometry.coordinates;\n      return previousValue! + distance(coords[0], coords[1], options);\n    },\n    0\n  );\n}\n\nexport { length };\nexport default length;\n"],"mappings":";;;;AACA,SAAS,gBAAgB;AAEzB,SAAS,qBAAqB;AAkB9B,SAAS,OACP,SACA,UAEI,CAAC,GACG;AAER,SAAO;AAAA,IACL;AAAA,IACA,CAAC,eAAe,YAAY;AAC1B,YAAM,SAAS,QAAS,SAAS;AACjC,aAAO,gBAAiB,SAAS,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,OAAO;AAAA,IAChE;AAAA,IACA;AAAA,EACF;AACF;AAfS;AAkBT,IAAO,sBAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/length",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0",
   "description": "turf length module",
   "author": "Turf Authors",
   "contributors": [
@@ -28,46 +28,51 @@
     "units",
     "gis"
   ],
-  "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": "./dist/js/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": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "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": "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": {
-    "@types/tape": "*",
-    "benchmark": "*",
-    "load-json-file": "*",
-    "npm-run-all": "*",
-    "tape": "*",
-    "tslint": "*",
-    "tsx": "*",
-    "typescript": "*",
-    "write-json-file": "*"
+    "@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",
+    "typescript": "^5.2.2",
+    "write-json-file": "^5.0.0"
   },
   "dependencies": {
-    "@turf/distance": "^7.0.0-alpha.2",
-    "@turf/helpers": "^7.0.0-alpha.2",
-    "@turf/meta": "^7.0.0-alpha.2",
-    "tslib": "^2.3.0"
+    "@turf/distance": "^7.0.0",
+    "@turf/helpers": "^7.0.0",
+    "@turf/meta": "^7.0.0",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "3d3a7917025fbabe191dbddbc89754b86f9c7739"
 }

package/dist/es/package.json

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

package/dist/js/index.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
-const meta_1 = require("@turf/meta");
-/**
- * Takes a {@link GeoJSON} and measures its length in the specified units, {@link (Multi)Point}'s distance are ignored.
- *
- * @name length
- * @param {Feature<LineString|MultiLineString>} geojson GeoJSON to measure
- * @param {Object} [options={}] Optional parameters
- * @param {string} [options.units=kilometers] can be degrees, radians, miles, or kilometers
- * @returns {number} length of GeoJSON
- * @example
- * var line = turf.lineString([[115, -32], [131, -22], [143, -25], [150, -34]]);
- * var length = turf.length(line, {units: 'miles'});
- *
- * //addToMap
- * var addToMap = [line];
- * line.properties.distance = length;
- */
-function length(geojson, options = {}) {
-    // Calculate distance from 2-vertex line segments
-    return meta_1.segmentReduce(geojson, (previousValue, segment) => {
-        const coords = segment.geometry.coordinates;
-        return previousValue + distance_1.default(coords[0], coords[1], options);
-    }, 0);
-}
-exports.default = length;