@turf/shortest-path 7.1.0-alpha.7 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -12
- package/package.json +13 -12
package/README.md
CHANGED
|
@@ -13,9 +13,9 @@ any [Feature][3] in [ obstacles][4]
|
|
|
13
13
|
* `end` **[Coord][5]** point
|
|
14
14
|
* `options` **[Object][6]** optional parameters (optional, default `{}`)
|
|
15
15
|
|
|
16
|
-
* `options.obstacles` **([Geometry][7] | [Feature][
|
|
17
|
-
* `options.units` **[string][
|
|
18
|
-
* `options.resolution` **[number][
|
|
16
|
+
* `options.obstacles` **([Geometry][7] | [Feature][3] | [FeatureCollection][8]<[Polygon][9]>)?** areas which path cannot travel
|
|
17
|
+
* `options.units` **[string][10]** unit in which resolution & minimum distance will be expressed in; it can be degrees, radians, miles, kilometers, ... (optional, default `'kilometers'`)
|
|
18
|
+
* `options.resolution` **[number][11]** distance between matrix points on which the path will be calculated (optional, default `100`)
|
|
19
19
|
|
|
20
20
|
### Examples
|
|
21
21
|
|
|
@@ -32,7 +32,7 @@ var path = turf.shortestPath(start, end, options);
|
|
|
32
32
|
var addToMap = [start, end, options.obstacles, path];
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Returns **[Feature][
|
|
35
|
+
Returns **[Feature][3]<[LineString][1]>** shortest path between start and end
|
|
36
36
|
|
|
37
37
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.4
|
|
38
38
|
|
|
@@ -48,17 +48,13 @@ Returns **[Feature][8]<[LineString][13]>** shortest path between start and end
|
|
|
48
48
|
|
|
49
49
|
[7]: https://tools.ietf.org/html/rfc7946#section-3.1
|
|
50
50
|
|
|
51
|
-
[8]: https://tools.ietf.org/html/rfc7946#section-3.
|
|
51
|
+
[8]: https://tools.ietf.org/html/rfc7946#section-3.3
|
|
52
52
|
|
|
53
|
-
[9]: https://tools.ietf.org/html/rfc7946#section-3.
|
|
53
|
+
[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6
|
|
54
54
|
|
|
55
|
-
[10]: https://
|
|
55
|
+
[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
|
|
56
56
|
|
|
57
|
-
[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/
|
|
58
|
-
|
|
59
|
-
[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
|
|
60
|
-
|
|
61
|
-
[13]: https://tools.ietf.org/html/rfc7946#section-3.1.4
|
|
57
|
+
[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
|
|
62
58
|
|
|
63
59
|
<!-- 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. -->
|
|
64
60
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@turf/shortest-path",
|
|
3
|
-
"version": "7.1.0
|
|
3
|
+
"version": "7.1.0",
|
|
4
4
|
"description": "turf shortest-path module",
|
|
5
5
|
"author": "Turf Authors",
|
|
6
6
|
"contributors": [
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"test:types": "tsc --esModuleInterop --module node16 --moduleResolution node16 --noEmit --strict types.ts"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
58
|
-
"@turf/truncate": "^7.1.0
|
|
58
|
+
"@turf/truncate": "^7.1.0",
|
|
59
59
|
"@types/benchmark": "^2.1.5",
|
|
60
60
|
"@types/tape": "^4.2.32",
|
|
61
61
|
"benchmark": "^2.1.4",
|
|
@@ -68,16 +68,17 @@
|
|
|
68
68
|
"write-json-file": "^5.0.0"
|
|
69
69
|
},
|
|
70
70
|
"dependencies": {
|
|
71
|
-
"@turf/bbox": "^7.1.0
|
|
72
|
-
"@turf/bbox-polygon": "^7.1.0
|
|
73
|
-
"@turf/boolean-point-in-polygon": "^7.1.0
|
|
74
|
-
"@turf/clean-coords": "^7.1.0
|
|
75
|
-
"@turf/distance": "^7.1.0
|
|
76
|
-
"@turf/helpers": "^7.1.0
|
|
77
|
-
"@turf/invariant": "^7.1.0
|
|
78
|
-
"@turf/meta": "^7.1.0
|
|
79
|
-
"@turf/transform-scale": "^7.1.0
|
|
71
|
+
"@turf/bbox": "^7.1.0",
|
|
72
|
+
"@turf/bbox-polygon": "^7.1.0",
|
|
73
|
+
"@turf/boolean-point-in-polygon": "^7.1.0",
|
|
74
|
+
"@turf/clean-coords": "^7.1.0",
|
|
75
|
+
"@turf/distance": "^7.1.0",
|
|
76
|
+
"@turf/helpers": "^7.1.0",
|
|
77
|
+
"@turf/invariant": "^7.1.0",
|
|
78
|
+
"@turf/meta": "^7.1.0",
|
|
79
|
+
"@turf/transform-scale": "^7.1.0",
|
|
80
|
+
"@types/geojson": "^7946.0.10",
|
|
80
81
|
"tslib": "^2.6.2"
|
|
81
82
|
},
|
|
82
|
-
"gitHead": "
|
|
83
|
+
"gitHead": "68915eeebc9278bb40dec3f1034499698a0561ef"
|
|
83
84
|
}
|