turf-along - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

index.js

@@ -10,2 +10,3 @@ var distance = require('turf-distance');
  * @module turf/along
+ * @category measurement
  * @param {LineString} line a LineString feature
@@ -16,14 +17,26 @@ * @param {Number} distance distance along the 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 line = {
+ *   "type": "Feature",
+ *   "properties": {},
+ *   "geometry": {
+ *     "type": "LineString",
+ *     "coordinates": [
+ *       [-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 along = turf.along(line, 1, 'miles');
  *
- * //=along
+ * var result = {
+ *   "type": "FeatureCollection",
+ *   "features": [line, along]
+ * };
+ *
+ * //=result
  */
@@ -30,0 +43,0 @@ module.exports = function (line, dist, units) {

package.json

 {
   "name": "turf-along",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
@@ -29,6 +29,6 @@ "main": "index.js",
     "benchmark": "^1.0.0",
-    "tape": "^3.4.0",
+    "tape": "^3.5.0",
     "turf-featurecollection": "^1.0.0",
     "dox": "^0.6.1",
-    "doxme": "^1.4.2"
+    "doxme": "^1.4.3"
   },
@@ -35,0 +35,0 @@ "dependencies": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

139814

increased by0.19%

Lines of code

146

increased by9.77%

No dependency changes