@turf/along - npm Package Compare versions

Comparing version 7.1.0 to 7.2.0

dist/esm/index.d.ts

@@ -7,7 +7,7 @@ import { Feature, LineString, Point } from 'geojson';
  *
- * @name along
- * @param {Feature<LineString>} line input line
+ * @function
+ * @param {Feature<LineString>|LineString} line input line
  * @param {number} distance distance along the line
  * @param {Object} [options] Optional parameters
- * @param {string} [options.units="kilometers"] can be degrees, radians, miles, or kilometers
+ * @param {Units} [options.units="kilometers"] can be degrees, radians, miles, or kilometers
  * @returns {Feature<Point>} Point `distance` `units` along the line
@@ -14,0 +14,0 @@ * @example

package.json

 {
   "name": "@turf/along",
-  "version": "7.1.0",
+  "version": "7.2.0",
   "description": "turf along module",
@@ -56,21 +56,21 @@ "author": "Turf Authors",
     "@types/benchmark": "^2.1.5",
-    "@types/tape": "^4.2.32",
+    "@types/tape": "^4.13.4",
     "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"
+    "tape": "^5.9.0",
+    "tsup": "^8.3.5",
+    "tsx": "^4.19.2",
+    "typescript": "^5.5.4"
   },
   "dependencies": {
-    "@turf/bearing": "^7.1.0",
-    "@turf/destination": "^7.1.0",
-    "@turf/distance": "^7.1.0",
-    "@turf/helpers": "^7.1.0",
-    "@turf/invariant": "^7.1.0",
+    "@turf/bearing": "^7.2.0",
+    "@turf/destination": "^7.2.0",
+    "@turf/distance": "^7.2.0",
+    "@turf/helpers": "^7.2.0",
+    "@turf/invariant": "^7.2.0",
     "@types/geojson": "^7946.0.10",
-    "tslib": "^2.6.2"
+    "tslib": "^2.8.1"
   },
-  "gitHead": "68915eeebc9278bb40dec3f1034499698a0561ef"
+  "gitHead": "7b0f0374c4668cd569f8904c71e2ae7d941be867"
 }

README.md

@@ -11,7 +11,7 @@ # @turf/along
 
-*   `line` **[Feature][3]<[LineString][1]>** input line
+*   `line` **([Feature][3]<[LineString][1]> | [LineString][1])** input line
 *   `distance` **[number][4]** distance along the line
-*   `options` **[Object][5]?** Optional parameters
+*   `options` **[Object][5]?** Optional parameters (optional, default `{}`)
 
-    *   `options.units` **[string][6]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
+    *   `options.units` **Units** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
 
@@ -42,4 +42,2 @@ ### Examples
 
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
 <!-- 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. -->
@@ -46,0 +44,0 @@

No alert changes

Improved metrics

Total package byte prevSize

15199

3.89%

Worsened metrics

Number of lines in readme file

60

-3.23%

Dependency changes

• Updated

  @turf/bearing@^7.2.0

• Updated

  @turf/destination@^7.2.0

• Updated

  @turf/distance@^7.2.0

• Updated

  @turf/helpers@^7.2.0

• Updated

  @turf/invariant@^7.2.0

• Updated

  tslib@^2.8.1