@turf/nearest-point 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 +7 -9
- package/package.json +7 -6
package/README.md
CHANGED
|
@@ -12,10 +12,10 @@ is geodesic.
|
|
|
12
12
|
### Parameters
|
|
13
13
|
|
|
14
14
|
* `targetPoint` **[Coord][2]** the reference point
|
|
15
|
-
* `points` **[FeatureCollection][3]<[Point][
|
|
16
|
-
* `options` **[Object][
|
|
15
|
+
* `points` **[FeatureCollection][3]<[Point][1]>** against input point set
|
|
16
|
+
* `options` **[Object][4]** Optional parameters (optional, default `{}`)
|
|
17
17
|
|
|
18
|
-
* `options.units` **[string][
|
|
18
|
+
* `options.units` **[string][5]** the units of the numeric result (optional, default `'kilometers'`)
|
|
19
19
|
|
|
20
20
|
### Examples
|
|
21
21
|
|
|
@@ -34,7 +34,7 @@ var addToMap = [targetPoint, points, nearest];
|
|
|
34
34
|
nearest.properties['marker-color'] = '#F00';
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
Returns **[Feature][
|
|
37
|
+
Returns **[Feature][6]<[Point][1]>** the closest point in the set to the reference point
|
|
38
38
|
|
|
39
39
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
|
|
40
40
|
|
|
@@ -42,13 +42,11 @@ Returns **[Feature][7]<[Point][4]>** the closest point in the set to the referen
|
|
|
42
42
|
|
|
43
43
|
[3]: https://tools.ietf.org/html/rfc7946#section-3.3
|
|
44
44
|
|
|
45
|
-
[4]: https://
|
|
45
|
+
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
|
46
46
|
|
|
47
|
-
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/
|
|
47
|
+
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
|
|
48
48
|
|
|
49
|
-
[6]: https://
|
|
50
|
-
|
|
51
|
-
[7]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
49
|
+
[6]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
52
50
|
|
|
53
51
|
<!-- 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. -->
|
|
54
52
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@turf/nearest-point",
|
|
3
|
-
"version": "7.1.0
|
|
3
|
+
"version": "7.1.0",
|
|
4
4
|
"description": "turf nearest-point module",
|
|
5
5
|
"author": "Turf Authors",
|
|
6
6
|
"license": "MIT",
|
|
@@ -66,11 +66,12 @@
|
|
|
66
66
|
"write-json-file": "^5.0.0"
|
|
67
67
|
},
|
|
68
68
|
"dependencies": {
|
|
69
|
-
"@turf/clone": "^7.1.0
|
|
70
|
-
"@turf/distance": "^7.1.0
|
|
71
|
-
"@turf/helpers": "^7.1.0
|
|
72
|
-
"@turf/meta": "^7.1.0
|
|
69
|
+
"@turf/clone": "^7.1.0",
|
|
70
|
+
"@turf/distance": "^7.1.0",
|
|
71
|
+
"@turf/helpers": "^7.1.0",
|
|
72
|
+
"@turf/meta": "^7.1.0",
|
|
73
|
+
"@types/geojson": "^7946.0.10",
|
|
73
74
|
"tslib": "^2.6.2"
|
|
74
75
|
},
|
|
75
|
-
"gitHead": "
|
|
76
|
+
"gitHead": "68915eeebc9278bb40dec3f1034499698a0561ef"
|
|
76
77
|
}
|