From f3d51729c06dcda5b21de5a95bdac1ca60181923 Mon Sep 17 00:00:00 2001 From: James Beard Date: Sun, 28 Jul 2024 10:20:04 +1000 Subject: [PATCH] Resolved critical parse-url vulnerability (dependency of documentation.js). Regenerated all READMEs, only changes being a shuffling of the internal link cross references. (#2664) --- package.json | 2 +- packages/turf-along/README.md | 20 +- packages/turf-bbox-clip/README.md | 18 +- packages/turf-bbox-polygon/README.md | 4 +- packages/turf-bezier-spline/README.md | 18 +- packages/turf-boolean-equal/README.md | 2 +- .../turf-boolean-point-in-polygon/README.md | 16 +- packages/turf-center-mean/README.md | 6 +- packages/turf-center-median/README.md | 24 +- packages/turf-center-of-mass/README.md | 6 +- packages/turf-center/README.md | 6 +- packages/turf-centroid/README.md | 6 +- packages/turf-circle/README.md | 26 +- packages/turf-clusters-dbscan/README.md | 24 +- packages/turf-clusters-kmeans/README.md | 18 +- packages/turf-clusters/README.md | 4 +- packages/turf-combine/README.md | 18 +- packages/turf-concave/README.md | 24 +- packages/turf-convex/README.md | 6 +- packages/turf-destination/README.md | 4 +- packages/turf-difference/README.md | 10 +- packages/turf-directional-mean/README.md | 2 +- packages/turf-distance-weight/README.md | 2 +- packages/turf-distance/README.md | 18 +- packages/turf-envelope/README.md | 4 +- packages/turf-flatten/README.md | 8 +- packages/turf-great-circle/README.md | 6 +- packages/turf-helpers/README.md | 184 ++-- packages/turf-hex-grid/README.md | 12 +- packages/turf-intersect/README.md | 16 +- packages/turf-invariant/README.md | 20 +- packages/turf-isobands/README.md | 30 +- packages/turf-isolines/README.md | 30 +- packages/turf-kinks/README.md | 16 +- packages/turf-line-chunk/README.md | 24 +- packages/turf-line-offset/README.md | 20 +- packages/turf-line-segment/README.md | 6 +- packages/turf-line-slice-along/README.md | 20 +- packages/turf-line-slice/README.md | 6 +- packages/turf-meta/README.md | 14 +- packages/turf-moran-index/README.md | 14 +- .../turf-nearest-neighbor-analysis/README.md | 40 +- packages/turf-nearest-point-on-line/README.md | 24 +- packages/turf-nearest-point-to-line/README.md | 28 +- packages/turf-nearest-point/README.md | 16 +- packages/turf-point-grid/README.md | 14 +- packages/turf-point-on-feature/README.md | 4 +- .../turf-point-to-line-distance/README.md | 24 +- packages/turf-points-within-polygon/README.md | 16 +- packages/turf-polygon-smooth/README.md | 18 +- packages/turf-polygon-tangents/README.md | 12 +- packages/turf-polygon-to-line/README.md | 18 +- packages/turf-polygonize/README.md | 14 +- packages/turf-quadrat-analysis/README.md | 22 +- packages/turf-rectangle-grid/README.md | 12 +- packages/turf-rhumb-destination/README.md | 4 +- packages/turf-sample/README.md | 10 +- packages/turf-shortest-path/README.md | 20 +- packages/turf-simplify/README.md | 20 +- .../README.md | 2 +- packages/turf-tag/README.md | 18 +- packages/turf-tin/README.md | 12 +- packages/turf-triangle-grid/README.md | 8 +- packages/turf-union/README.md | 14 +- pnpm-lock.yaml | 968 ++++++++++++++++-- 65 files changed, 1348 insertions(+), 704 deletions(-) diff --git a/package.json b/package.json index 87572435d1..620e9a23cc 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,7 @@ "d3-queue": "*", "decamelize": "^6.0.0", "dependency-tree": "^8.1.2", - "documentation": "^13.2.5", + "documentation": "^14.0.3", "es-check": "^7.1.1", "eslint": "^8.53.0", "eslint-config-prettier": "^9.0.0", diff --git a/packages/turf-along/README.md b/packages/turf-along/README.md index 1c2ad30c2c..e172218e84 100644 --- a/packages/turf-along/README.md +++ b/packages/turf-along/README.md @@ -8,11 +8,11 @@ Takes a [LineString][1] and returns a [Point][2] at a specified distance along t ### Parameters -* `line` **[Feature][3]<[LineString][4]>** input line -* `distance` **[number][5]** distance along the line -* `options` **[Object][6]?** Optional parameters +* `line` **[Feature][3]<[LineString][1]>** input line +* `distance` **[number][4]** distance along the line +* `options` **[Object][5]?** Optional parameters - * `options.units` **[string][7]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`) + * `options.units` **[string][6]** can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`) ### Examples @@ -26,7 +26,7 @@ var along = turf.along(line, 200, options); var addToMap = [along, line] ``` -Returns **[Feature][3]<[Point][8]>** Point `distance` `units` along the line +Returns **[Feature][3]<[Point][2]>** Point `distance` `units` along the line [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -34,15 +34,11 @@ Returns **[Feature][3]<[Point][8]>** Point `distance` `units` along the line [3]: https://tools.ietf.org/html/rfc7946#section-3.2 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/packages/turf-bbox-clip/README.md b/packages/turf-bbox-clip/README.md index 753546249c..e9031ca2c0 100644 --- a/packages/turf-bbox-clip/README.md +++ b/packages/turf-bbox-clip/README.md @@ -10,8 +10,8 @@ May result in degenerate edges when clipping Polygons. ### Parameters -* `feature` **[Feature][3]<([LineString][4] | [MultiLineString][5] | [Polygon][6] | [MultiPolygon][7])>** feature to clip to the bbox -* `bbox` **[BBox][8]** extent in \[minX, minY, maxX, maxY] order +* `feature` **[Feature][1]<([LineString][3] | [MultiLineString][4] | [Polygon][5] | [MultiPolygon][6])>** feature to clip to the bbox +* `bbox` **[BBox][7]** extent in \[minX, minY, maxX, maxY] order ### Examples @@ -25,23 +25,21 @@ var clipped = turf.bboxClip(poly, bbox); var addToMap = [bbox, poly, clipped] ``` -Returns **[Feature][3]<([LineString][4] | [MultiLineString][5] | [Polygon][6] | [MultiPolygon][7])>** clipped Feature +Returns **[Feature][1]<([LineString][3] | [MultiLineString][4] | [Polygon][5] | [MultiPolygon][6])>** clipped Feature [1]: https://tools.ietf.org/html/rfc7946#section-3.2 [2]: https://github.com/mapbox/lineclip -[3]: https://tools.ietf.org/html/rfc7946#section-3.2 +[3]: https://tools.ietf.org/html/rfc7946#section-3.1.4 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[4]: https://tools.ietf.org/html/rfc7946#section-3.1.5 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.5 +[5]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[6]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[8]: https://tools.ietf.org/html/rfc7946#section-5 +[7]: https://tools.ietf.org/html/rfc7946#section-5 diff --git a/packages/turf-bbox-polygon/README.md b/packages/turf-bbox-polygon/README.md index f63460721d..f0368d0432 100644 --- a/packages/turf-bbox-polygon/README.md +++ b/packages/turf-bbox-polygon/README.md @@ -25,7 +25,7 @@ var poly = turf.bboxPolygon(bbox); var addToMap = [poly] ``` -Returns **[Feature][6]<[Polygon][7]>** a Polygon representation of the bounding box +Returns **[Feature][6]<[Polygon][1]>** a Polygon representation of the bounding box [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -39,8 +39,6 @@ Returns **[Feature][6]<[Polygon][7]>** a Polygon representation of the bounding [6]: https://tools.ietf.org/html/rfc7946#section-3.2 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - --- diff --git a/packages/turf-bezier-spline/README.md b/packages/turf-bezier-spline/README.md index 4e71c4c1f3..58a7e82c00 100644 --- a/packages/turf-bezier-spline/README.md +++ b/packages/turf-bezier-spline/README.md @@ -12,12 +12,12 @@ The bezier spline implementation is by [Leszek Rybicki][3]. ### Parameters -* `line` **[Feature][4]<[LineString][5]>** input LineString -* `options` **[Object][6]** Optional parameters (optional, default `{}`) +* `line` **[Feature][4]<[LineString][1]>** input LineString +* `options` **[Object][5]** Optional parameters (optional, default `{}`) - * `options.properties` **[Object][6]** Translate properties to output (optional, default `{}`) - * `options.resolution` **[number][7]** time in milliseconds between points (optional, default `10000`) - * `options.sharpness` **[number][7]** a measure of how curvy the path should be between splines (optional, default `0.85`) + * `options.properties` **[Object][5]** Translate properties to output (optional, default `{}`) + * `options.resolution` **[number][6]** time in milliseconds between points (optional, default `10000`) + * `options.sharpness` **[number][6]** a measure of how curvy the path should be between splines (optional, default `0.85`) ### Examples @@ -38,7 +38,7 @@ var addToMap = [line, curved] curved.properties = { stroke: '#0F0' }; ``` -Returns **[Feature][4]<[LineString][5]>** curved line +Returns **[Feature][4]<[LineString][1]>** curved line [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -48,11 +48,9 @@ Returns **[Feature][4]<[LineString][5]>** curved line [4]: https://tools.ietf.org/html/rfc7946#section-3.2 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number diff --git a/packages/turf-boolean-equal/README.md b/packages/turf-boolean-equal/README.md index 818ee623e4..912a42388c 100644 --- a/packages/turf-boolean-equal/README.md +++ b/packages/turf-boolean-equal/README.md @@ -5,7 +5,7 @@ ## booleanEqual Determine whether two geometries of the same type have identical X,Y coordinate values. -See [http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm][1] +See [http://edndoc.esri.com/arcsde/9.0/general\_topics/understand\_spatial\_relations.htm][1] ### Parameters diff --git a/packages/turf-boolean-point-in-polygon/README.md b/packages/turf-boolean-point-in-polygon/README.md index 47f668cb63..b4e929eb17 100644 --- a/packages/turf-boolean-point-in-polygon/README.md +++ b/packages/turf-boolean-point-in-polygon/README.md @@ -10,10 +10,10 @@ resides inside the polygon. The polygon can be convex or concave. The function a ### Parameters * `point` **[Coord][4]** input point -* `polygon` **[Feature][5]<([Polygon][6] | [MultiPolygon][7])>** input polygon or multipolygon -* `options` **[Object][8]** Optional parameters (optional, default `{}`) +* `polygon` **[Feature][5]<([Polygon][2] | [MultiPolygon][3])>** input polygon or multipolygon +* `options` **[Object][6]** Optional parameters (optional, default `{}`) - * `options.ignoreBoundary` **[boolean][9]** True if polygon boundary should be ignored when determining if + * `options.ignoreBoundary` **[boolean][7]** True if polygon boundary should be ignored when determining if the point is inside the polygon otherwise false. (optional, default `false`) ### Examples @@ -32,7 +32,7 @@ turf.booleanPointInPolygon(pt, poly); //= true ``` -Returns **[boolean][9]** `true` if the Point is inside the Polygon; `false` if the Point is not inside the Polygon +Returns **[boolean][7]** `true` if the Point is inside the Polygon; `false` if the Point is not inside the Polygon [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -44,13 +44,9 @@ Returns **[boolean][9]** `true` if the Point is inside the Polygon; `false` if t [5]: https://tools.ietf.org/html/rfc7946#section-3.2 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean diff --git a/packages/turf-center-mean/README.md b/packages/turf-center-mean/README.md index 299afa4842..1efa4de049 100644 --- a/packages/turf-center-mean/README.md +++ b/packages/turf-center-mean/README.md @@ -34,7 +34,7 @@ mean.properties['marker-size'] = 'large'; mean.properties['marker-color'] = '#000'; ``` -Returns **[Feature][6]<[Point][7]>** a Point feature at the mean center point of all input features +Returns **[Feature][1]<[Point][6]>** a Point feature at the mean center point of all input features [1]: https://tools.ietf.org/html/rfc7946#section-3.2 @@ -46,9 +46,7 @@ Returns **[Feature][6]<[Point][7]>** a Point feature at the mean center point of [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[6]: https://tools.ietf.org/html/rfc7946#section-3.2 - -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[6]: https://tools.ietf.org/html/rfc7946#section-3.1.2 diff --git a/packages/turf-center-median/README.md b/packages/turf-center-median/README.md index d239e7a923..bc634bc78b 100644 --- a/packages/turf-center-median/README.md +++ b/packages/turf-center-median/README.md @@ -43,12 +43,12 @@ Press, 2009, 150–151. ### Parameters -* `features` **[FeatureCollection][3]\** Any GeoJSON Feature Collection -* `options` **[Object][4]** Optional parameters (optional, default `{}`) +* `features` **[FeatureCollection][1]\** Any GeoJSON Feature Collection +* `options` **[Object][3]** Optional parameters (optional, default `{}`) - * `options.weight` **[string][5]?** the property name used to weight the center - * `options.tolerance` **[number][6]** the difference in distance between candidate medians at which point the algorighim stops iterating. (optional, default `0.001`) - * `options.counter` **[number][6]** how many attempts to find the median, should the tolerance be insufficient. (optional, default `10`) + * `options.weight` **[string][4]?** the property name used to weight the center + * `options.tolerance` **[number][5]** the difference in distance between candidate medians at which point the algorighim stops iterating. (optional, default `0.001`) + * `options.counter` **[number][5]** how many attempts to find the median, should the tolerance be insufficient. (optional, default `10`) ### Examples @@ -60,23 +60,21 @@ var medianCenter = turf.centerMedian(points); var addToMap = [points, medianCenter] ``` -Returns **[Feature][7]<[Point][8]>** The median center of the collection +Returns **[Feature][6]<[Point][7]>** The median center of the collection [1]: https://tools.ietf.org/html/rfc7946#section-3.3 [2]: https://doi.org/10.1111/j.1467-9787.1962.tb00902.x} -[3]: https://tools.ietf.org/html/rfc7946#section-3.3 +[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[6]: https://tools.ietf.org/html/rfc7946#section-3.2 -[7]: https://tools.ietf.org/html/rfc7946#section-3.2 - -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 diff --git a/packages/turf-center-of-mass/README.md b/packages/turf-center-of-mass/README.md index 138195320b..7d35fd2fcd 100644 --- a/packages/turf-center-of-mass/README.md +++ b/packages/turf-center-of-mass/README.md @@ -24,7 +24,7 @@ var center = turf.centerOfMass(polygon); var addToMap = [polygon, center] ``` -Returns **[Feature][7]<[Point][8]>** the center of mass +Returns **[Feature][1]<[Point][7]>** the center of mass [1]: https://tools.ietf.org/html/rfc7946#section-3.2 @@ -38,9 +38,7 @@ Returns **[Feature][7]<[Point][8]>** the center of mass [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[7]: https://tools.ietf.org/html/rfc7946#section-3.2 - -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 diff --git a/packages/turf-center/README.md b/packages/turf-center/README.md index 8e6d3f138e..1f138a456a 100644 --- a/packages/turf-center/README.md +++ b/packages/turf-center/README.md @@ -32,7 +32,7 @@ center.properties['marker-size'] = 'large'; center.properties['marker-color'] = '#000'; ``` -Returns **[Feature][5]<[Point][6]>** a Point feature at the absolute center point of all input features +Returns **[Feature][1]<[Point][5]>** a Point feature at the absolute center point of all input features [1]: https://tools.ietf.org/html/rfc7946#section-3.2 @@ -42,9 +42,7 @@ Returns **[Feature][5]<[Point][6]>** a Point feature at the absolute center poin [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[5]: https://tools.ietf.org/html/rfc7946#section-3.2 - -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2 diff --git a/packages/turf-centroid/README.md b/packages/turf-centroid/README.md index 9d28e952f2..3e95e40643 100644 --- a/packages/turf-centroid/README.md +++ b/packages/turf-centroid/README.md @@ -24,7 +24,7 @@ var centroid = turf.centroid(polygon); var addToMap = [polygon, centroid] ``` -Returns **[Feature][4]<[Point][5]>** the centroid of the input object +Returns **[Feature][3]<[Point][4]>** the centroid of the input object [1]: https://tools.ietf.org/html/rfc7946#section-3 @@ -32,9 +32,7 @@ Returns **[Feature][4]<[Point][5]>** the centroid of the input object [3]: https://tools.ietf.org/html/rfc7946#section-3.2 -[4]: https://tools.ietf.org/html/rfc7946#section-3.2 - -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 diff --git a/packages/turf-circle/README.md b/packages/turf-circle/README.md index c28581442e..89fdaa522c 100644 --- a/packages/turf-circle/README.md +++ b/packages/turf-circle/README.md @@ -8,13 +8,13 @@ Takes a [Point][1] and calculates the circle polygon given a radius in degrees, ### Parameters -* `center` **([Feature][2]<[Point][3]> | [Array][4]<[number][5]>)** center point -* `radius` **[number][5]** radius of the circle -* `options` **[Object][6]** Optional parameters (optional, default `{}`) +* `center` **([Feature][2]<[Point][1]> | [Array][3]<[number][4]>)** center point +* `radius` **[number][4]** radius of the circle +* `options` **[Object][5]** Optional parameters (optional, default `{}`) - * `options.steps` **[number][5]** number of steps (optional, default `64`) - * `options.units` **[string][7]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`) - * `options.properties` **[Object][6]** properties (optional, default `{}`) + * `options.steps` **[number][4]** number of steps (optional, default `64`) + * `options.units` **[string][6]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`) + * `options.properties` **[Object][5]** properties (optional, default `{}`) ### Examples @@ -28,23 +28,21 @@ var circle = turf.circle(center, radius, options); var addToMap = [turf.point(center), circle] ``` -Returns **[Feature][2]<[Polygon][8]>** circle polygon +Returns **[Feature][2]<[Polygon][7]>** circle polygon [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 [2]: https://tools.ietf.org/html/rfc7946#section-3.2 -[3]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array -[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6 diff --git a/packages/turf-clusters-dbscan/README.md b/packages/turf-clusters-dbscan/README.md index a00e5c620c..974d6af7ca 100644 --- a/packages/turf-clusters-dbscan/README.md +++ b/packages/turf-clusters-dbscan/README.md @@ -8,13 +8,13 @@ Takes a set of [points][1] and partition them into clusters according to [https: ### Parameters -* `points` **[FeatureCollection][3]<[Point][4]>** to be clustered -* `maxDistance` **[number][5]** Maximum Distance between any point of the cluster to generate the clusters (kilometers only) -* `options` **[Object][6]** Optional parameters (optional, default `{}`) +* `points` **[FeatureCollection][3]<[Point][1]>** to be clustered +* `maxDistance` **[number][4]** Maximum Distance between any point of the cluster to generate the clusters (kilometers only) +* `options` **[Object][5]** Optional parameters (optional, default `{}`) - * `options.units` **[string][7]** in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`) - * `options.mutate` **[boolean][8]** Allows GeoJSON input to be mutated (optional, default `false`) - * `options.minPoints` **[number][5]** Minimum number of points to generate a single cluster, + * `options.units` **[string][6]** in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`) + * `options.mutate` **[boolean][7]** Allows GeoJSON input to be mutated (optional, default `false`) + * `options.minPoints` **[number][4]** Minimum number of points to generate a single cluster, points which do not meet this requirement will be classified as an 'edge' or 'noise'. (optional, default `3`) ### Examples @@ -29,7 +29,7 @@ var clustered = turf.clustersDbscan(points, maxDistance); var addToMap = [clustered]; ``` -Returns **[FeatureCollection][3]<[Point][4]>** Clustered Points with an additional two properties associated to each Feature:* {number} cluster - the associated clusterId +Returns **[FeatureCollection][3]<[Point][1]>** Clustered Points with an additional two properties associated to each Feature:* {number} cluster - the associated clusterId * {string} dbscan - type of point it has been classified as ('core'|'edge'|'noise') [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -38,15 +38,13 @@ Returns **[FeatureCollection][3]<[Point][4]>** Clustered Points with an addition [3]: https://tools.ietf.org/html/rfc7946#section-3.3 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean diff --git a/packages/turf-clusters-kmeans/README.md b/packages/turf-clusters-kmeans/README.md index 3d29df8124..fe77503c88 100644 --- a/packages/turf-clusters-kmeans/README.md +++ b/packages/turf-clusters-kmeans/README.md @@ -9,11 +9,11 @@ It uses the [k-means algorithm][2] ### Parameters -* `points` **[FeatureCollection][3]<[Point][4]>** to be clustered -* `options` **[Object][5]** Optional parameters (optional, default `{}`) +* `points` **[FeatureCollection][3]<[Point][1]>** to be clustered +* `options` **[Object][4]** Optional parameters (optional, default `{}`) - * `options.numberOfClusters` **[number][6]** numberOfClusters that will be generated (optional, default `Math.sqrt(numberOfPoints/2)`) - * `options.mutate` **[boolean][7]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`) + * `options.numberOfClusters` **[number][5]** numberOfClusters that will be generated (optional, default `Math.sqrt(numberOfPoints/2)`) + * `options.mutate` **[boolean][6]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`) ### Examples @@ -27,7 +27,7 @@ var clustered = turf.clustersKmeans(points, options); var addToMap = [clustered]; ``` -Returns **[FeatureCollection][3]<[Point][4]>** Clustered Points with an additional two properties associated to each Feature:* {number} cluster - the associated clusterId +Returns **[FeatureCollection][3]<[Point][1]>** Clustered Points with an additional two properties associated to each Feature:* {number} cluster - the associated clusterId * {\[number, number]} centroid - Centroid of the cluster \[Longitude, Latitude] [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -36,13 +36,11 @@ Returns **[FeatureCollection][3]<[Point][4]>** Clustered Points with an addition [3]: https://tools.ietf.org/html/rfc7946#section-3.3 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean diff --git a/packages/turf-clusters/README.md b/packages/turf-clusters/README.md index 7a82242646..51531ab0fe 100644 --- a/packages/turf-clusters/README.md +++ b/packages/turf-clusters/README.md @@ -50,7 +50,7 @@ Type: [Function][2] * `clusterValue` **any?** Value used to create cluster being processed. * `currentIndex` **[number][3]?** The index of the current element being processed in the array.Starts at index 0 -Returns **void** +Returns **void** ## clusterEach @@ -96,7 +96,7 @@ turf.clusterEach(clustered, 'cluster', function (cluster, clusterValue) { }); ``` -Returns **void** +Returns **void** ## clusterReduceCallback diff --git a/packages/turf-combine/README.md b/packages/turf-combine/README.md index 604d5c183f..1c530e47de 100644 --- a/packages/turf-combine/README.md +++ b/packages/turf-combine/README.md @@ -9,7 +9,7 @@ into [MultiPoint][5], [MultiLineString][6], or [MultiPolygon][7] features. ### Parameters -* `fc` **[FeatureCollection][8]<([Point][9] | [LineString][10] | [Polygon][11])>** a FeatureCollection of any type +* `fc` **[FeatureCollection][1]<([Point][2] | [LineString][3] | [Polygon][4])>** a FeatureCollection of any type ### Examples @@ -25,7 +25,7 @@ var combined = turf.combine(fc); var addToMap = [combined] ``` -Returns **[FeatureCollection][8]<([MultiPoint][12] | [MultiLineString][13] | [MultiPolygon][14])>** a FeatureCollection of corresponding type to input +Returns **[FeatureCollection][1]<([MultiPoint][5] | [MultiLineString][6] | [MultiPolygon][7])>** a FeatureCollection of corresponding type to input [1]: https://tools.ietf.org/html/rfc7946#section-3.3 @@ -41,20 +41,6 @@ Returns **[FeatureCollection][8]<([MultiPoint][12] | [MultiLineString][13] | [Mu [7]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[8]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - -[11]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[12]: https://tools.ietf.org/html/rfc7946#section-3.1.3 - -[13]: https://tools.ietf.org/html/rfc7946#section-3.1.5 - -[14]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - --- diff --git a/packages/turf-concave/README.md b/packages/turf-concave/README.md index bd47b3b608..eb903ad4cc 100644 --- a/packages/turf-concave/README.md +++ b/packages/turf-concave/README.md @@ -9,12 +9,12 @@ Internally, this uses [turf-tin][2] to generate geometries. ### Parameters -* `points` **[FeatureCollection][3]<[Point][4]>** input points -* `options` **[Object][5]** Optional parameters (optional, default `{}`) +* `points` **[FeatureCollection][3]<[Point][1]>** input points +* `options` **[Object][4]** Optional parameters (optional, default `{}`) - * `options.maxEdge` **[number][6]** the length (in 'units') of an edge necessary for part of the + * `options.maxEdge` **[number][5]** the length (in 'units') of an edge necessary for part of the hull to become concave. (optional, default `Infinity`) - * `options.units` **[string][7]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) + * `options.units` **[string][6]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) ### Examples @@ -35,7 +35,7 @@ var hull = turf.concave(points, options); var addToMap = [points, hull] ``` -Returns **([Feature][8]<([Polygon][9] | [MultiPolygon][10])> | null)** a concave hull (null value is returned if unable to compute hull) +Returns **([Feature][7]<([Polygon][8] | [MultiPolygon][9])> | null)** a concave hull (null value is returned if unable to compute hull) [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -43,19 +43,17 @@ Returns **([Feature][8]<([Polygon][9] | [MultiPolygon][10])> | null)** a concave [3]: https://tools.ietf.org/html/rfc7946#section-3.3 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[7]: https://tools.ietf.org/html/rfc7946#section-3.2 -[8]: https://tools.ietf.org/html/rfc7946#section-3.2 +[8]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.7 +[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7 diff --git a/packages/turf-convex/README.md b/packages/turf-convex/README.md index a359457ef1..bf8763bf79 100644 --- a/packages/turf-convex/README.md +++ b/packages/turf-convex/README.md @@ -36,7 +36,7 @@ var hull = turf.convex(points); var addToMap = [points, hull] ``` -Returns **[Feature][9]<[Polygon][10]>** a convex hull +Returns **[Feature][1]<[Polygon][3]>** a convex hull [1]: https://tools.ietf.org/html/rfc7946#section-3.2 @@ -54,10 +54,6 @@ Returns **[Feature][9]<[Polygon][10]>** a convex hull [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[9]: https://tools.ietf.org/html/rfc7946#section-3.2 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - --- diff --git a/packages/turf-destination/README.md b/packages/turf-destination/README.md index 17221156a0..c2f0f5880d 100644 --- a/packages/turf-destination/README.md +++ b/packages/turf-destination/README.md @@ -34,7 +34,7 @@ destination.properties['marker-color'] = '#f00'; point.properties['marker-color'] = '#0f0'; ``` -Returns **[Feature][7]<[Point][8]>** destination point +Returns **[Feature][7]<[Point][1]>** destination point [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -50,8 +50,6 @@ Returns **[Feature][7]<[Point][8]>** destination point [7]: https://tools.ietf.org/html/rfc7946#section-3.2 -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - --- diff --git a/packages/turf-difference/README.md b/packages/turf-difference/README.md index b9f2a70aa1..4659b157fc 100644 --- a/packages/turf-difference/README.md +++ b/packages/turf-difference/README.md @@ -8,7 +8,7 @@ Finds the difference between multiple [polygons][1] by clipping the subsequent p ### Parameters -* `features` **[FeatureCollection][2]<([Polygon][3] | [MultiPolygon][4])>** input Polygon features +* `features` **[FeatureCollection][2]<([Polygon][1] | [MultiPolygon][3])>** input Polygon features ### Examples @@ -40,17 +40,15 @@ var difference = turf.difference(turf.featureCollection([polygon1, polygon2])); var addToMap = [polygon1, polygon2, difference]; ``` -Returns **([Feature][5]<([Polygon][3] | [MultiPolygon][4])> | null)** a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`) +Returns **([Feature][4]<([Polygon][1] | [MultiPolygon][3])> | null)** a Polygon or MultiPolygon feature showing the area of `polygon1` excluding the area of `polygon2` (if empty returns `null`) [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 [2]: https://tools.ietf.org/html/rfc7946#section-3.3 -[3]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[3]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[5]: https://tools.ietf.org/html/rfc7946#section-3.2 +[4]: https://tools.ietf.org/html/rfc7946#section-3.2 diff --git a/packages/turf-directional-mean/README.md b/packages/turf-directional-mean/README.md index 8870687cf6..f509e3d3eb 100644 --- a/packages/turf-directional-mean/README.md +++ b/packages/turf-directional-mean/README.md @@ -25,7 +25,7 @@ It can handle segments of line or the whole line. ### Parameters -* `lines` **[FeatureCollection][3]<[LineString][4]>** +* `lines` **[FeatureCollection][3]<[LineString][4]>** * `options` **[object][1]** (optional, default `{}`) * `options.planar` **[boolean][5]** whether the spatial reference system is projected or geographical. (optional, default `true`) diff --git a/packages/turf-distance-weight/README.md b/packages/turf-distance-weight/README.md index ea93a5b0fd..10325b385c 100644 --- a/packages/turf-distance-weight/README.md +++ b/packages/turf-distance-weight/README.md @@ -12,7 +12,7 @@ calcualte the Minkowski p-norm distance between two features. * `feature2` **[Feature][1]<[Point][2]>** point feature * `p` p-norm 1=\ diff --git a/packages/turf-envelope/README.md b/packages/turf-envelope/README.md index 60cb055dfb..26e0628ead 100644 --- a/packages/turf-envelope/README.md +++ b/packages/turf-envelope/README.md @@ -25,7 +25,7 @@ var enveloped = turf.envelope(features); var addToMap = [features, enveloped]; ``` -Returns **[Feature][3]<[Polygon][4]>** a rectangular Polygon feature that encompasses all vertices +Returns **[Feature][3]<[Polygon][1]>** a rectangular Polygon feature that encompasses all vertices [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -33,8 +33,6 @@ Returns **[Feature][3]<[Polygon][4]>** a rectangular Polygon feature that encomp [3]: https://tools.ietf.org/html/rfc7946#section-3.2 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - --- diff --git a/packages/turf-flatten/README.md b/packages/turf-flatten/README.md index bdf62b41dc..9f7195ff1c 100644 --- a/packages/turf-flatten/README.md +++ b/packages/turf-flatten/README.md @@ -8,7 +8,7 @@ Flattens any [GeoJSON][1] to a [FeatureCollection][2] inspired by [geojson-flatt ### Parameters -* `geojson` **[GeoJSON][4]** any valid GeoJSON Object +* `geojson` **[GeoJSON][1]** any valid GeoJSON Object ### Examples @@ -25,7 +25,7 @@ var flatten = turf.flatten(multiGeometry); var addToMap = [flatten] ``` -Returns **[FeatureCollection][5]\** all Multi-Geometries are flattened into single Features +Returns **[FeatureCollection][2]\** all Multi-Geometries are flattened into single Features [1]: https://tools.ietf.org/html/rfc7946#section-3 @@ -33,10 +33,6 @@ Returns **[FeatureCollection][5]\** all Multi-Geometries are flattened into [3]: https://github.com/tmcw/geojson-flatten -[4]: https://tools.ietf.org/html/rfc7946#section-3 - -[5]: https://tools.ietf.org/html/rfc7946#section-3.3 - --- diff --git a/packages/turf-great-circle/README.md b/packages/turf-great-circle/README.md index 221bf2ad9a..8703e2577b 100644 --- a/packages/turf-great-circle/README.md +++ b/packages/turf-great-circle/README.md @@ -31,7 +31,7 @@ var greatCircle = turf.greatCircle(start, end, {properties: {name: 'Seattle to D var addToMap = [start, end, greatCircle] ``` -Returns **[Feature][6]<([LineString][7] | [MultiLineString][8])>** great circle line feature +Returns **[Feature][6]<([LineString][1] | [MultiLineString][2])>** great circle line feature [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -45,10 +45,6 @@ Returns **[Feature][6]<([LineString][7] | [MultiLineString][8])>** great circle [6]: https://tools.ietf.org/html/rfc7946#section-3.2 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.5 - --- diff --git a/packages/turf-helpers/README.md b/packages/turf-helpers/README.md index 729530d7f4..abd0a5d82b 100644 --- a/packages/turf-helpers/README.md +++ b/packages/turf-helpers/README.md @@ -30,12 +30,12 @@ Wraps a GeoJSON [Geometry][3] in a GeoJSON [Feature][4]. ### Parameters -* `geometry` **[Geometry][5]** input geometry +* `geometry` **[Geometry][3]** input geometry * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the Feature + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the Feature ### Examples @@ -50,7 +50,7 @@ var feature = turf.feature(geometry); //=feature ``` -Returns **[Feature][8]** a GeoJSON Feature +Returns **[Feature][4]** a GeoJSON Feature ## geometry @@ -59,8 +59,8 @@ For GeometryCollection type use `helpers.geometryCollection` ### Parameters -* `type` **[string][7]** Geometry Type -* `coordinates` **[Array][6]\** Coordinates +* `type` **[string][6]** Geometry Type +* `coordinates` **[Array][5]\** Coordinates * `options` **[Object][2]** Optional Parameters (optional, default `{}`) ### Examples @@ -72,20 +72,20 @@ var geometry = turf.geometry(type, coordinates); // => geometry ``` -Returns **[Geometry][5]** a GeoJSON Geometry +Returns **[Geometry][3]** a GeoJSON Geometry ## point -Creates a [Point][9] [Feature][4] from a Position. +Creates a [Point][7] [Feature][4] from a Position. ### Parameters -* `coordinates` **[Array][6]<[number][1]>** longitude, latitude position (each in decimal degrees) +* `coordinates` **[Array][5]<[number][1]>** longitude, latitude position (each in decimal degrees) * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the Feature + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the Feature ### Examples @@ -95,21 +95,21 @@ var point = turf.point([-75.343, 39.984]); //=point ``` -Returns **[Feature][8]<[Point][10]>** a Point feature +Returns **[Feature][4]<[Point][7]>** a Point feature ## points -Creates a [Point][9] [FeatureCollection][11] from an Array of Point coordinates. +Creates a [Point][7] [FeatureCollection][8] from an Array of Point coordinates. ### Parameters -* `coordinates` **[Array][6]<[Array][6]<[number][1]>>** an array of Points +* `coordinates` **[Array][5]<[Array][5]<[number][1]>>** an array of Points * `properties` **[Object][2]** Translate these properties to each Feature (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the FeatureCollection - * `options.id` **([string][7] | [number][1])?** Identifier associated with the FeatureCollection + * `options.id` **([string][6] | [number][1])?** Identifier associated with the FeatureCollection ### Examples @@ -123,20 +123,20 @@ var points = turf.points([ //=points ``` -Returns **[FeatureCollection][12]<[Point][10]>** Point Feature +Returns **[FeatureCollection][8]<[Point][7]>** Point Feature ## polygon -Creates a [Polygon][13] [Feature][4] from an Array of LinearRings. +Creates a [Polygon][9] [Feature][4] from an Array of LinearRings. ### Parameters -* `coordinates` **[Array][6]<[Array][6]<[Array][6]<[number][1]>>>** an array of LinearRings +* `coordinates` **[Array][5]<[Array][5]<[Array][5]<[number][1]>>>** an array of LinearRings * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the Feature + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the Feature ### Examples @@ -146,20 +146,20 @@ var polygon = turf.polygon([[[-5, 52], [-4, 56], [-2, 51], [-7, 54], [-5, 52]]], //=polygon ``` -Returns **[Feature][8]<[Polygon][14]>** Polygon Feature +Returns **[Feature][4]<[Polygon][9]>** Polygon Feature ## polygons -Creates a [Polygon][13] [FeatureCollection][11] from an Array of Polygon coordinates. +Creates a [Polygon][9] [FeatureCollection][8] from an Array of Polygon coordinates. ### Parameters -* `coordinates` **[Array][6]<[Array][6]<[Array][6]<[Array][6]<[number][1]>>>>** an array of Polygon coordinates +* `coordinates` **[Array][5]<[Array][5]<[Array][5]<[Array][5]<[number][1]>>>>** an array of Polygon coordinates * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the FeatureCollection + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the FeatureCollection ### Examples @@ -172,20 +172,20 @@ var polygons = turf.polygons([ //=polygons ``` -Returns **[FeatureCollection][12]<[Polygon][14]>** Polygon FeatureCollection +Returns **[FeatureCollection][8]<[Polygon][9]>** Polygon FeatureCollection ## lineString -Creates a [LineString][15] [Feature][4] from an Array of Positions. +Creates a [LineString][10] [Feature][4] from an Array of Positions. ### Parameters -* `coordinates` **[Array][6]<[Array][6]<[number][1]>>** an array of Positions +* `coordinates` **[Array][5]<[Array][5]<[number][1]>>** an array of Positions * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the Feature + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the Feature ### Examples @@ -197,21 +197,21 @@ var linestring2 = turf.lineString([[-14, 43], [-13, 40], [-15, 45], [-10, 49]], //=linestring2 ``` -Returns **[Feature][8]<[LineString][16]>** LineString Feature +Returns **[Feature][4]<[LineString][10]>** LineString Feature ## lineStrings -Creates a [LineString][15] [FeatureCollection][11] from an Array of LineString coordinates. +Creates a [LineString][10] [FeatureCollection][8] from an Array of LineString coordinates. ### Parameters -* `coordinates` **[Array][6]<[Array][6]<[Array][6]<[number][1]>>>** an array of LinearRings +* `coordinates` **[Array][5]<[Array][5]<[Array][5]<[number][1]>>>** an array of LinearRings * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the FeatureCollection - * `options.id` **([string][7] | [number][1])?** Identifier associated with the FeatureCollection + * `options.id` **([string][6] | [number][1])?** Identifier associated with the FeatureCollection ### Examples @@ -224,19 +224,19 @@ var linestrings = turf.lineStrings([ //=linestrings ``` -Returns **[FeatureCollection][12]<[LineString][16]>** LineString FeatureCollection +Returns **[FeatureCollection][8]<[LineString][10]>** LineString FeatureCollection ## featureCollection -Takes one or more [Features][4] and creates a [FeatureCollection][11]. +Takes one or more [Features][4] and creates a [FeatureCollection][8]. ### Parameters -* `features` **[Array][6]<[Feature][8]>** input features +* `features` **[Array][5]<[Feature][4]>** input features * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the Feature + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the Feature ### Examples @@ -254,21 +254,21 @@ var collection = turf.featureCollection([ //=collection ``` -Returns **[FeatureCollection][12]** FeatureCollection of Features +Returns **[FeatureCollection][8]** FeatureCollection of Features ## multiLineString -Creates a [Feature\][17] based on a +Creates a [Feature\][11] based on a coordinate array. Properties can be added optionally. ### Parameters -* `coordinates` **[Array][6]<[Array][6]<[Array][6]<[number][1]>>>** an array of LineStrings +* `coordinates` **[Array][5]<[Array][5]<[Array][5]<[number][1]>>>** an array of LineStrings * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the Feature + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the Feature ### Examples @@ -278,23 +278,23 @@ var multiLine = turf.multiLineString([[[0,0],[10,10]]]); //=multiLine ``` -* Throws **[Error][18]** if no coordinates are passed +* Throws **[Error][12]** if no coordinates are passed -Returns **[Feature][8]<[MultiLineString][19]>** a MultiLineString feature +Returns **[Feature][4]<[MultiLineString][13]>** a MultiLineString feature ## multiPoint -Creates a [Feature\][20] based on a +Creates a [Feature\][14] based on a coordinate array. Properties can be added optionally. ### Parameters -* `coordinates` **[Array][6]<[Array][6]<[number][1]>>** an array of Positions +* `coordinates` **[Array][5]<[Array][5]<[number][1]>>** an array of Positions * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the Feature + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the Feature ### Examples @@ -304,23 +304,23 @@ var multiPt = turf.multiPoint([[0,0],[10,10]]); //=multiPt ``` -* Throws **[Error][18]** if no coordinates are passed +* Throws **[Error][12]** if no coordinates are passed -Returns **[Feature][8]<[MultiPoint][21]>** a MultiPoint feature +Returns **[Feature][4]<[MultiPoint][15]>** a MultiPoint feature ## multiPolygon -Creates a [Feature\][22] based on a +Creates a [Feature\][16] based on a coordinate array. Properties can be added optionally. ### Parameters -* `coordinates` **[Array][6]<[Array][6]<[Array][6]<[Array][6]<[number][1]>>>>** an array of Polygons +* `coordinates` **[Array][5]<[Array][5]<[Array][5]<[Array][5]<[number][1]>>>>** an array of Polygons * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the Feature + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the Feature ### Examples @@ -330,23 +330,23 @@ var multiPoly = turf.multiPolygon([[[[0,0],[0,10],[10,10],[10,0],[0,0]]]]); //=multiPoly ``` -* Throws **[Error][18]** if no coordinates are passed +* Throws **[Error][12]** if no coordinates are passed -Returns **[Feature][8]<[MultiPolygon][23]>** a multipolygon feature +Returns **[Feature][4]<[MultiPolygon][17]>** a multipolygon feature ## geometryCollection -Creates a [Feature\][24] based on a +Creates a [Feature\][18] based on a coordinate array. Properties can be added optionally. ### Parameters -* `geometries` **[Array][6]<[Geometry][5]>** an array of GeoJSON Geometries +* `geometries` **[Array][5]<[Geometry][3]>** an array of GeoJSON Geometries * `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`) * `options` **[Object][2]** Optional Parameters (optional, default `{}`) - * `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature - * `options.id` **([string][7] | [number][1])?** Identifier associated with the Feature + * `options.bbox` **[Array][5]<[number][1]>?** Bounding Box Array \[west, south, east, north] associated with the Feature + * `options.id` **([string][6] | [number][1])?** Identifier associated with the Feature ### Examples @@ -358,7 +358,7 @@ var collection = turf.geometryCollection([pt, line]); // => collection ``` -Returns **[Feature][8]<[GeometryCollection][25]>** a GeoJSON GeometryCollection Feature +Returns **[Feature][4]<[GeometryCollection][19]>** a GeoJSON GeometryCollection Feature ## round @@ -389,7 +389,7 @@ Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, ce ### Parameters * `radians` **[number][1]** in radians across the sphere -* `units` **[string][7]** can be degrees, radians, miles, inches, yards, metres, +* `units` **[string][6]** can be degrees, radians, miles, inches, yards, metres, meters, kilometres, kilometers. (optional, default `"kilometers"`) Returns **[number][1]** distance @@ -402,7 +402,7 @@ Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, ce ### Parameters * `distance` **[number][1]** in real units -* `units` **[string][7]** can be degrees, radians, miles, inches, yards, metres, +* `units` **[string][6]** can be degrees, radians, miles, inches, yards, metres, meters, kilometres, kilometers. (optional, default `"kilometers"`) Returns **[number][1]** radians @@ -415,7 +415,7 @@ Valid units: miles, nauticalmiles, inches, yards, meters, metres, centimeters, k ### Parameters * `distance` **[number][1]** in real units -* `units` **[string][7]** can be degrees, radians, miles, inches, yards, metres, +* `units` **[string][6]** can be degrees, radians, miles, inches, yards, metres, meters, kilometres, kilometers. (optional, default `"kilometers"`) Returns **[number][1]** degrees @@ -494,7 +494,7 @@ turf.isNumber('foo') //=false ``` -Returns **[boolean][26]** true/false +Returns **[boolean][20]** true/false ## isObject @@ -513,7 +513,7 @@ turf.isObject('foo') //=false ``` -Returns **[boolean][26]** true/false, including false for Arrays and Functions +Returns **[boolean][20]** true/false, including false for Arrays and Functions [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number @@ -523,49 +523,37 @@ Returns **[boolean][26]** true/false, including false for Arrays and Functions [4]: https://tools.ietf.org/html/rfc7946#section-3.2 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1 +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 -[8]: https://tools.ietf.org/html/rfc7946#section-3.2 +[8]: https://tools.ietf.org/html/rfc7946#section-3.3 -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[10]: https://tools.ietf.org/html/rfc7946#section-3.1.4 -[11]: https://tools.ietf.org/html/rfc7946#section-3.3 +[11]: Feature -[12]: https://tools.ietf.org/html/rfc7946#section-3.3 +[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error -[13]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[13]: https://tools.ietf.org/html/rfc7946#section-3.1.5 -[14]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[14]: Feature -[15]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[15]: https://tools.ietf.org/html/rfc7946#section-3.1.3 -[16]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[16]: Feature -[17]: Feature +[17]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error +[18]: Feature -[19]: https://tools.ietf.org/html/rfc7946#section-3.1.5 +[19]: https://tools.ietf.org/html/rfc7946#section-3.1.8 -[20]: Feature - -[21]: https://tools.ietf.org/html/rfc7946#section-3.1.3 - -[22]: Feature - -[23]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[24]: Feature - -[25]: https://tools.ietf.org/html/rfc7946#section-3.1.8 - -[26]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean diff --git a/packages/turf-hex-grid/README.md b/packages/turf-hex-grid/README.md index 72bee83640..c87c7a1c78 100644 --- a/packages/turf-hex-grid/README.md +++ b/packages/turf-hex-grid/README.md @@ -17,8 +17,8 @@ described in [Hexagonal Grids][3]. * `options.units` **[string][7]** used in calculating cell size, can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) * `options.properties` **[Object][6]** passed to each hexagon or triangle of the grid (optional, default `{}`) - * `options.mask` **[Feature][8]<[Polygon][9]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it - * `options.triangles` **[boolean][10]** whether to return as triangles instead of hexagons (optional, default `false`) + * `options.mask` **[Feature][8]<[Polygon][2]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it + * `options.triangles` **[boolean][9]** whether to return as triangles instead of hexagons (optional, default `false`) ### Examples @@ -33,7 +33,7 @@ var hexgrid = turf.hexGrid(bbox, cellSide, options); var addToMap = [hexgrid]; ``` -Returns **[FeatureCollection][11]<[Polygon][9]>** a hexagonal grid +Returns **[FeatureCollection][1]<[Polygon][2]>** a hexagonal grid [1]: https://tools.ietf.org/html/rfc7946#section-3.3 @@ -51,11 +51,7 @@ Returns **[FeatureCollection][11]<[Polygon][9]>** a hexagonal grid [8]: https://tools.ietf.org/html/rfc7946#section-3.2 -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - -[11]: https://tools.ietf.org/html/rfc7946#section-3.3 +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean diff --git a/packages/turf-intersect/README.md b/packages/turf-intersect/README.md index e356efd3f2..cfbd2f83b7 100644 --- a/packages/turf-intersect/README.md +++ b/packages/turf-intersect/README.md @@ -9,10 +9,10 @@ finds their polygonal intersection. If they don't intersect, returns null. ### Parameters -* `features` **[FeatureCollection][3]<([Polygon][4] | [MultiPolygon][5])>** the features to intersect -* `options` **[Object][6]** Optional Parameters (optional, default `{}`) +* `features` **[FeatureCollection][3]<([Polygon][1] | [MultiPolygon][2])>** the features to intersect +* `options` **[Object][4]** Optional Parameters (optional, default `{}`) - * `options.properties` **[Object][6]** Translate GeoJSON Properties to Feature (optional, default `{}`) + * `options.properties` **[Object][4]** Translate GeoJSON Properties to Feature (optional, default `{}`) ### Examples @@ -42,7 +42,7 @@ var intersection = turf.intersect(turf.featureCollection([poly1, poly2])); var addToMap = [poly1, poly2, intersection]; ``` -Returns **([Feature][7] | null)** returns a feature representing the area they share (either a [Polygon][1] or +Returns **([Feature][5] | null)** returns a feature representing the area they share (either a [Polygon][1] or [MultiPolygon][2]). If they do not share any area, returns `null`. [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -51,13 +51,9 @@ Returns **([Feature][7] | null)** returns a feature representing the area they s [3]: https://tools.ietf.org/html/rfc7946#section-3.3 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[7]: https://tools.ietf.org/html/rfc7946#section-3.2 +[5]: https://tools.ietf.org/html/rfc7946#section-3.2 diff --git a/packages/turf-invariant/README.md b/packages/turf-invariant/README.md index 0b9becdbe6..a885eebbb5 100644 --- a/packages/turf-invariant/README.md +++ b/packages/turf-invariant/README.md @@ -66,8 +66,8 @@ Enforce expectations about types of GeoJSON objects for Turf. ## featureOf -Enforce expectations about types of [Feature][10] inputs for Turf. -Internally this uses [geojsonType][11] to judge geometry types. +Enforce expectations about types of [Feature][5] inputs for Turf. +Internally this uses [geojsonType][10] to judge geometry types. ### Parameters @@ -81,12 +81,12 @@ Internally this uses [geojsonType][11] to judge geometry types. ## collectionOf -Enforce expectations about types of [FeatureCollection][12] inputs for Turf. -Internally this uses [geojsonType][11] to judge geometry types. +Enforce expectations about types of [FeatureCollection][11] inputs for Turf. +Internally this uses [geojsonType][10] to judge geometry types. ### Parameters -* `featureCollection` **[FeatureCollection][13]** a FeatureCollection for which features will be judged +* `featureCollection` **[FeatureCollection][11]** a FeatureCollection for which features will be judged * `type` **[string][8]** expected GeoJSON type * `name` **[string][8]** name of calling function @@ -128,7 +128,7 @@ Get GeoJSON object's type, Geometry type is prioritize. ### Parameters * `geojson` **[GeoJSON][7]** GeoJSON object -* `_name` **[string][8]?** +* `_name` **[string][8]?** * `name` **[string][8]** name of the variable to display in error message (unused) (optional, default `"geojson"`) ### Examples @@ -166,13 +166,9 @@ Returns **[string][8]** GeoJSON type [9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error -[10]: https://tools.ietf.org/html/rfc7946#section-3.2 +[10]: #geojsontype -[11]: #geojsontype - -[12]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[13]: https://tools.ietf.org/html/rfc7946#section-3.3 +[11]: https://tools.ietf.org/html/rfc7946#section-3.3 diff --git a/packages/turf-isobands/README.md b/packages/turf-isobands/README.md index a2ebefbc46..a2397c4d19 100644 --- a/packages/turf-isobands/README.md +++ b/packages/turf-isobands/README.md @@ -9,35 +9,29 @@ value breaks and generates filled contour isobands. ### Parameters -* `pointGrid` **[FeatureCollection][3]<[Point][4]>** input points - must be square or rectangular -* `breaks` **[Array][5]<[number][6]>** where to draw contours -* `options` **[Object][7]** options on output (optional, default `{}`) +* `pointGrid` **[FeatureCollection][1]<[Point][2]>** input points - must be square or rectangular +* `breaks` **[Array][3]<[number][4]>** where to draw contours +* `options` **[Object][5]** options on output (optional, default `{}`) - * `options.zProperty` **[string][8]** the property name in `points` from which z-values will be pulled (optional, default `'elevation'`) - * `options.commonProperties` **[Object][7]** GeoJSON properties passed to ALL isobands (optional, default `{}`) - * `options.breaksProperties` **[Array][5]<[Object][7]>** GeoJSON properties passed, in order, to the correspondent isoband (order defined by breaks) (optional, default `[]`) + * `options.zProperty` **[string][6]** the property name in `points` from which z-values will be pulled (optional, default `'elevation'`) + * `options.commonProperties` **[Object][5]** GeoJSON properties passed to ALL isobands (optional, default `{}`) + * `options.breaksProperties` **[Array][3]<[Object][5]>** GeoJSON properties passed, in order, to the correspondent isoband (order defined by breaks) (optional, default `[]`) -Returns **[FeatureCollection][3]<[MultiPolygon][9]>** a FeatureCollection of [MultiPolygon][10] features representing isobands +Returns **[FeatureCollection][1]<[MultiPolygon][7]>** a FeatureCollection of [MultiPolygon][7] features representing isobands [1]: https://tools.ietf.org/html/rfc7946#section-3.3 [2]: https://tools.ietf.org/html/rfc7946#section-3.1.2 -[3]: https://tools.ietf.org/html/rfc7946#section-3.3 +[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.7 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7 diff --git a/packages/turf-isolines/README.md b/packages/turf-isolines/README.md index 406606ed04..83c9a60fcd 100644 --- a/packages/turf-isolines/README.md +++ b/packages/turf-isolines/README.md @@ -9,13 +9,13 @@ value breaks and generates [isolines][3]. ### Parameters -* `pointGrid` **[FeatureCollection][4]<[Point][5]>** input points -* `breaks` **[Array][6]<[number][7]>** values of `zProperty` where to draw isolines -* `options` **[Object][8]** Optional parameters (optional, default `{}`) +* `pointGrid` **[FeatureCollection][1]<[Point][2]>** input points +* `breaks` **[Array][4]<[number][5]>** values of `zProperty` where to draw isolines +* `options` **[Object][6]** Optional parameters (optional, default `{}`) - * `options.zProperty` **[string][9]** the property name in `points` from which z-values will be pulled (optional, default `'elevation'`) - * `options.commonProperties` **[Object][8]** GeoJSON properties passed to ALL isolines (optional, default `{}`) - * `options.breaksProperties` **[Array][6]<[Object][8]>** GeoJSON properties passed, in order, to the correspondent isoline; + * `options.zProperty` **[string][7]** the property name in `points` from which z-values will be pulled (optional, default `'elevation'`) + * `options.commonProperties` **[Object][6]** GeoJSON properties passed to ALL isolines (optional, default `{}`) + * `options.breaksProperties` **[Array][4]<[Object][6]>** GeoJSON properties passed, in order, to the correspondent isoline; the breaks array will define the order in which the isolines are created (optional, default `[]`) ### Examples @@ -37,7 +37,7 @@ var lines = turf.isolines(pointGrid, breaks, {zProperty: 'temperature'}); var addToMap = [lines]; ``` -Returns **[FeatureCollection][4]<[MultiLineString][10]>** a FeatureCollection of [MultiLineString][11] features representing isolines +Returns **[FeatureCollection][1]<[MultiLineString][8]>** a FeatureCollection of [MultiLineString][8] features representing isolines [1]: https://tools.ietf.org/html/rfc7946#section-3.3 @@ -45,21 +45,15 @@ Returns **[FeatureCollection][4]<[MultiLineString][10]>** a FeatureCollection of [3]: https://en.wikipedia.org/wiki/Contour_line -[4]: https://tools.ietf.org/html/rfc7946#section-3.3 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.5 - -[11]: https://tools.ietf.org/html/rfc7946#section-3.1.5 +[8]: https://tools.ietf.org/html/rfc7946#section-3.1.5 diff --git a/packages/turf-kinks/README.md b/packages/turf-kinks/README.md index b1cc8bc5b9..28316dce36 100644 --- a/packages/turf-kinks/README.md +++ b/packages/turf-kinks/README.md @@ -10,7 +10,7 @@ returns [points][5] at all self-intersections. ### Parameters -* `featureIn` **[Feature][6]<([LineString][7] | [MultiLineString][8] | [MultiPolygon][9] | [Polygon][10])>** input feature +* `featureIn` **[Feature][6]<([LineString][1] | [MultiLineString][2] | [MultiPolygon][3] | [Polygon][4])>** input feature ### Examples @@ -29,7 +29,7 @@ var kinks = turf.kinks(poly); var addToMap = [poly, kinks] ``` -Returns **[FeatureCollection][11]<[Point][12]>** self-intersections +Returns **[FeatureCollection][7]<[Point][5]>** self-intersections [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -43,17 +43,7 @@ Returns **[FeatureCollection][11]<[Point][12]>** self-intersections [6]: https://tools.ietf.org/html/rfc7946#section-3.2 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.5 - -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[11]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[12]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[7]: https://tools.ietf.org/html/rfc7946#section-3.3 diff --git a/packages/turf-line-chunk/README.md b/packages/turf-line-chunk/README.md index d699d50c14..ef0b74797d 100644 --- a/packages/turf-line-chunk/README.md +++ b/packages/turf-line-chunk/README.md @@ -9,12 +9,12 @@ If the line is shorter than the segment length then the original line is returne ### Parameters -* `geojson` **([FeatureCollection][2] | [Geometry][3] | [Feature][4]<([LineString][5] | [MultiLineString][6])>)** the lines to split -* `segmentLength` **[number][7]** how long to make each segment -* `options` **[Object][8]** Optional parameters (optional, default `{}`) +* `geojson` **([FeatureCollection][2] | [Geometry][3] | [Feature][4]<([LineString][1] | [MultiLineString][5])>)** the lines to split +* `segmentLength` **[number][6]** how long to make each segment +* `options` **[Object][7]** Optional parameters (optional, default `{}`) - * `options.units` **[string][9]** units can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) - * `options.reverse` **[boolean][10]** reverses coordinates to start the first chunked segment at the end (optional, default `false`) + * `options.units` **[string][8]** units can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) + * `options.reverse` **[boolean][9]** reverses coordinates to start the first chunked segment at the end (optional, default `false`) ### Examples @@ -27,7 +27,7 @@ var chunk = turf.lineChunk(line, 15, {units: 'miles'}); var addToMap = [chunk]; ``` -Returns **[FeatureCollection][2]<[LineString][5]>** collection of line segments +Returns **[FeatureCollection][2]<[LineString][1]>** collection of line segments [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -37,17 +37,15 @@ Returns **[FeatureCollection][2]<[LineString][5]>** collection of line segments [4]: https://tools.ietf.org/html/rfc7946#section-3.2 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[5]: https://tools.ietf.org/html/rfc7946#section-3.1.5 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.5 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean diff --git a/packages/turf-line-offset/README.md b/packages/turf-line-offset/README.md index 7cb21ebc4d..3301253d70 100644 --- a/packages/turf-line-offset/README.md +++ b/packages/turf-line-offset/README.md @@ -8,11 +8,11 @@ Takes a [line][1] and returns a [line][1] at offset by the specified distance. ### Parameters -* `geojson` **([Geometry][2] | [Feature][3]<([LineString][4] | [MultiLineString][5])>)** input GeoJSON -* `distance` **[number][6]** distance to offset the line (can be of negative value) -* `options` **[Object][7]** Optional parameters (optional, default `{}`) +* `geojson` **([Geometry][2] | [Feature][3]<([LineString][1] | [MultiLineString][4])>)** input GeoJSON +* `distance` **[number][5]** distance to offset the line (can be of negative value) +* `options` **[Object][6]** Optional parameters (optional, default `{}`) - * `options.units` **[string][8]** can be degrees, radians, miles, kilometers, inches, yards, meters (optional, default `'kilometers'`) + * `options.units` **[string][7]** can be degrees, radians, miles, kilometers, inches, yards, meters (optional, default `'kilometers'`) ### Examples @@ -26,7 +26,7 @@ var addToMap = [offsetLine, line] offsetLine.properties.stroke = "#00F" ``` -Returns **[Feature][3]<([LineString][4] | [MultiLineString][5])>** Line offset from the input line +Returns **[Feature][3]<([LineString][1] | [MultiLineString][4])>** Line offset from the input line [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -34,15 +34,13 @@ Returns **[Feature][3]<([LineString][4] | [MultiLineString][5])>** Line offset f [3]: https://tools.ietf.org/html/rfc7946#section-3.2 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[4]: https://tools.ietf.org/html/rfc7946#section-3.1.5 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.5 +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/packages/turf-line-segment/README.md b/packages/turf-line-segment/README.md index b437615965..ca191f8f41 100644 --- a/packages/turf-line-segment/README.md +++ b/packages/turf-line-segment/README.md @@ -21,7 +21,7 @@ var segments = turf.lineSegment(polygon); var addToMap = [polygon, segments] ``` -Returns **[FeatureCollection][5]<[LineString][6]>** 2-vertex line segments +Returns **[FeatureCollection][1]<[LineString][2]>** 2-vertex line segments [1]: https://tools.ietf.org/html/rfc7946#section-3.3 @@ -31,10 +31,6 @@ Returns **[FeatureCollection][5]<[LineString][6]>** 2-vertex line segments [4]: https://tools.ietf.org/html/rfc7946#section-3 -[5]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - --- diff --git a/packages/turf-line-slice-along/README.md b/packages/turf-line-slice-along/README.md index c69da0900a..4fddeb597c 100644 --- a/packages/turf-line-slice-along/README.md +++ b/packages/turf-line-slice-along/README.md @@ -12,12 +12,12 @@ This can be useful for extracting only the part of a route between two distances ### Parameters -* `line` **([Feature][3]<[LineString][4]> | [LineString][4])** input line -* `startDist` **[number][5]** distance along the line to starting point -* `stopDist` **[number][5]** distance along the line to ending point -* `options` **[Object][6]** Optional parameters (optional, default `{}`) +* `line` **([Feature][3]<[LineString][1]> | [LineString][1])** input line +* `startDist` **[number][4]** distance along the line to starting point +* `stopDist` **[number][4]** distance along the line to ending point +* `options` **[Object][5]** Optional parameters (optional, default `{}`) - * `options.units` **[string][7]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) + * `options.units` **[string][6]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) ### Examples @@ -31,7 +31,7 @@ var sliced = turf.lineSliceAlong(line, start, stop, {units: 'miles'}); var addToMap = [line, start, stop, sliced] ``` -Returns **[Feature][3]<[LineString][4]>** sliced line +Returns **[Feature][3]<[LineString][1]>** sliced line [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -39,13 +39,11 @@ Returns **[Feature][3]<[LineString][4]>** sliced line [3]: https://tools.ietf.org/html/rfc7946#section-3.2 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/packages/turf-line-slice/README.md b/packages/turf-line-slice/README.md index 668efe84c0..2b5e88cc0a 100644 --- a/packages/turf-line-slice/README.md +++ b/packages/turf-line-slice/README.md @@ -14,7 +14,7 @@ This can be useful for extracting only the part of a route between waypoints. * `startPt` **[Coord][3]** starting point * `stopPt` **[Coord][3]** stopping point -* `line` **([Feature][4]<[LineString][5]> | [LineString][5])** line to slice +* `line` **([Feature][4]<[LineString][1]> | [LineString][1])** line to slice ### Examples @@ -36,7 +36,7 @@ var sliced = turf.lineSlice(start, stop, line); var addToMap = [start, stop, line] ``` -Returns **[Feature][4]<[LineString][5]>** sliced line +Returns **[Feature][4]<[LineString][1]>** sliced line [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -46,8 +46,6 @@ Returns **[Feature][4]<[LineString][5]>** sliced line [4]: https://tools.ietf.org/html/rfc7946#section-3.2 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - --- diff --git a/packages/turf-meta/README.md b/packages/turf-meta/README.md index 8a8affc2b3..13dc60352f 100644 --- a/packages/turf-meta/README.md +++ b/packages/turf-meta/README.md @@ -43,7 +43,7 @@ turf.coordEach(features, function (currentCoord, coordIndex, featureIndex, multi }); ``` -Returns **void** +Returns **void** ## coordReduceCallback @@ -141,7 +141,7 @@ turf.propEach(features, function (currentProperties, featureIndex) { }); ``` -Returns **void** +Returns **void** ## propReduceCallback @@ -234,7 +234,7 @@ turf.featureEach(features, function (currentFeature, featureIndex) { }); ``` -Returns **void** +Returns **void** ## featureReduceCallback @@ -352,7 +352,7 @@ turf.geomEach(features, function (currentGeometry, featureIndex, featureProperti }); ``` -Returns **void** +Returns **void** ## geomReduceCallback @@ -521,7 +521,7 @@ Type: [Function][1] * `geometryIndex` **[number][3]** The current index of the Geometry being processed. * `segmentIndex` **[number][3]** The current index of the Segment being processed. -Returns **void** +Returns **void** ## segmentEach @@ -554,7 +554,7 @@ turf.segmentEach(polygon, function () { }); ``` -Returns **void** +Returns **void** ## segmentReduceCallback @@ -620,7 +620,7 @@ var total = turf.segmentReduce(polygon, function (previousValue) { }, initialValue); ``` -Returns **void** +Returns **void** ## lineEachCallback diff --git a/packages/turf-moran-index/README.md b/packages/turf-moran-index/README.md index 532fc98f0b..ce93589de4 100644 --- a/packages/turf-moran-index/README.md +++ b/packages/turf-moran-index/README.md @@ -28,8 +28,8 @@ the z-score can be calculated based on a normal or random assumption. ### Parameters -* `fc` **[FeatureCollection][3]\** -* `options` **[Object][4]** +* `fc` **[FeatureCollection][3]\** +* `options` **[Object][4]** * `options.inputField` **[string][5]** the property name, must contain numeric values * `options.threshold` **[number][6]** the distance threshold (optional, default `100000`) @@ -49,7 +49,7 @@ const result = turf.moranIndex(dataset, { }); ``` -Returns **[MoranIndex][8]** +Returns **[MoranIndex][8]** ## mean @@ -57,9 +57,9 @@ get mean of a list ### Parameters -* `y` **[Array][9]<[number][6]>** +* `y` **[Array][9]<[number][6]>** -Returns **[number][6]** +Returns **[number][6]** ## variance @@ -67,9 +67,9 @@ get variance of a list ### Parameters -* `y` **[Array][9]<[number][6]>** +* `y` **[Array][9]<[number][6]>** -Returns **[number][6]** +Returns **[number][6]** ## MoranIndex diff --git a/packages/turf-nearest-neighbor-analysis/README.md b/packages/turf-nearest-neighbor-analysis/README.md index c13aa226e0..5b66701dfd 100644 --- a/packages/turf-nearest-neighbor-analysis/README.md +++ b/packages/turf-nearest-neighbor-analysis/README.md @@ -22,18 +22,16 @@ dispersed. **Remarks** * Though the analysis will work on any [FeatureCollection][3] type, it - -works best with [Point][4] collections. + works best with [Point][4] collections. * This analysis is *very* sensitive to the study area provided. - -If no [Feature\][1] is passed as the study area, the function draws a box -around the data, which may distort the findings. This analysis works best -with a bounded area of interest within with the data is either clustered, -dispersed, or randomly distributed. For example, a city's subway stops may -look extremely clustered if the study area is an entire state. On the other -hand, they may look rather evenly dispersed if the study area is limited to -the city's downtown. + If no [Feature\][1] is passed as the study area, the function draws a box + around the data, which may distort the findings. This analysis works best + with a bounded area of interest within with the data is either clustered, + dispersed, or randomly distributed. For example, a city's subway stops may + look extremely clustered if the study area is an entire state. On the other + hand, they may look rather evenly dispersed if the study area is limited to + the city's downtown. **Bibliography** @@ -43,12 +41,12 @@ Measure of Spatial Relationships in Populations,” *Ecology* 35, no. 4 ### Parameters -* `dataset` **[FeatureCollection][6]\** FeatureCollection (pref. of points) to study -* `options` **[Object][7]** Optional parameters (optional, default `{}`) +* `dataset` **[FeatureCollection][3]\** FeatureCollection (pref. of points) to study +* `options` **[Object][6]** Optional parameters (optional, default `{}`) - * `options.studyArea` **[Feature][8]<[Polygon][9]>?** polygon representing the study area - * `options.units` **[string][10]** unit of measurement for distances and, squared, area. (optional, default `'kilometers'`) - * `options.properties` **[Object][7]** properties (optional, default `{}`) + * `options.studyArea` **[Feature][7]<[Polygon][8]>?** polygon representing the study area + * `options.units` **[string][9]** unit of measurement for distances and, squared, area. (optional, default `'kilometers'`) + * `options.properties` **[Object][6]** properties (optional, default `{}`) ### Examples @@ -61,7 +59,7 @@ var nearestNeighborStudyArea = turf.nearestNeighborAnalysis(dataset); var addToMap = [dataset, nearestNeighborStudyArea]; ``` -Returns **[Feature][8]<[Polygon][9]>** A polygon of the study area or an approximation of one. +Returns **[Feature][7]<[Polygon][8]>** A polygon of the study area or an approximation of one. [1]: Feature @@ -73,15 +71,13 @@ Returns **[Feature][8]<[Polygon][9]>** A polygon of the study area or an approxi [5]: http://doi.org/10.2307/1931034 -[6]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[8]: https://tools.ietf.org/html/rfc7946#section-3.2 +[7]: https://tools.ietf.org/html/rfc7946#section-3.2 -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[8]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/packages/turf-nearest-point-on-line/README.md b/packages/turf-nearest-point-on-line/README.md index 5847978a5f..b08a461845 100644 --- a/packages/turf-nearest-point-on-line/README.md +++ b/packages/turf-nearest-point-on-line/README.md @@ -8,11 +8,11 @@ Takes a [Point][1] and a [LineString][2] and calculates the closest Point on the ### Parameters -* `lines` **([Geometry][3] | [Feature][4]<([LineString][5] | [MultiLineString][6])>)** lines to snap to -* `pt` **([Geometry][3] | [Feature][4]<[Point][7]> | [Array][8]<[number][9]>)** point to snap from -* `options` **[Object][10]** Optional parameters (optional, default `{}`) +* `lines` **([Geometry][3] | [Feature][4]<([LineString][2] | [MultiLineString][5])>)** lines to snap to +* `pt` **([Geometry][3] | [Feature][4]<[Point][1]> | [Array][6]<[number][7]>)** point to snap from +* `options` **[Object][8]** Optional parameters (optional, default `{}`) - * `options.units` **[string][11]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) + * `options.units` **[string][9]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) ### Examples @@ -34,7 +34,7 @@ var addToMap = [line, pt, snapped]; snapped.properties['marker-color'] = '#00f'; ``` -Returns **[Feature][4]<[Point][7]>** closest point on the `line` to `point`. The properties object will contain three values: `index`: closest point was found on nth line part, `dist`: distance between pt and the closest point, `location`: distance along the line between start and the closest point. +Returns **[Feature][4]<[Point][1]>** closest point on the `line` to `point`. The properties object will contain three values: `index`: closest point was found on nth line part, `dist`: distance between pt and the closest point, `location`: distance along the line between start and the closest point. [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -44,19 +44,15 @@ Returns **[Feature][4]<[Point][7]>** closest point on the `line` to `point`. The [4]: https://tools.ietf.org/html/rfc7946#section-3.2 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[5]: https://tools.ietf.org/html/rfc7946#section-3.1.5 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.5 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/packages/turf-nearest-point-to-line/README.md b/packages/turf-nearest-point-to-line/README.md index 277fe0dfa6..5796910411 100644 --- a/packages/turf-nearest-point-to-line/README.md +++ b/packages/turf-nearest-point-to-line/README.md @@ -9,13 +9,13 @@ to a [line][3]. The returned point has a `dist` property indicating its distance ### Parameters -* `points` **([FeatureCollection][4] | [GeometryCollection][5]<[Point][6]>)** Point Collection -* `line` **([Feature][7] | [Geometry][8]<[LineString][9]>)** Line Feature -* `options` **[Object][10]?** Optional parameters +* `points` **([FeatureCollection][2] | [GeometryCollection][4]<[Point][1]>)** Point Collection +* `line` **([Feature][5] | [Geometry][6]<[LineString][3]>)** Line Feature +* `options` **[Object][7]?** Optional parameters - * `options.units` **[string][11]** unit of the output distance property + * `options.units` **[string][8]** unit of the output distance property (eg: degrees, radians, miles, or kilometers) (optional, default `'kilometers'`) - * `options.properties` **[Object][10]** Translate Properties to Point (optional, default `{}`) + * `options.properties` **[Object][7]** Translate Properties to Point (optional, default `{}`) ### Examples @@ -31,7 +31,7 @@ var nearest = turf.nearestPointToLine(points, line); var addToMap = [nearest, line]; ``` -Returns **[Feature][7]<[Point][6]>** the closest point +Returns **[Feature][5]<[Point][1]>** the closest point ## pt @@ -47,21 +47,15 @@ Translate Properties to final Point, priorities: [3]: https://tools.ietf.org/html/rfc7946#section-3.1.4 -[4]: https://tools.ietf.org/html/rfc7946#section-3.3 +[4]: https://tools.ietf.org/html/rfc7946#section-3.1.8 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.8 +[5]: https://tools.ietf.org/html/rfc7946#section-3.2 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[6]: https://tools.ietf.org/html/rfc7946#section-3.1 -[7]: https://tools.ietf.org/html/rfc7946#section-3.2 +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[8]: https://tools.ietf.org/html/rfc7946#section-3.1 - -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/packages/turf-nearest-point/README.md b/packages/turf-nearest-point/README.md index fe152de9b8..818a71afb4 100644 --- a/packages/turf-nearest-point/README.md +++ b/packages/turf-nearest-point/README.md @@ -12,10 +12,10 @@ is geodesic. ### Parameters * `targetPoint` **[Coord][2]** the reference point -* `points` **[FeatureCollection][3]<[Point][4]>** against input point set -* `options` **[Object][5]** Optional parameters (optional, default `{}`) +* `points` **[FeatureCollection][3]<[Point][1]>** against input point set +* `options` **[Object][4]** Optional parameters (optional, default `{}`) - * `options.units` **[string][6]** the units of the numeric result (optional, default `'kilometers'`) + * `options.units` **[string][5]** the units of the numeric result (optional, default `'kilometers'`) ### Examples @@ -34,7 +34,7 @@ var addToMap = [targetPoint, points, nearest]; nearest.properties['marker-color'] = '#F00'; ``` -Returns **[Feature][7]<[Point][4]>** the closest point in the set to the reference point +Returns **[Feature][6]<[Point][1]>** the closest point in the set to the reference point [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -42,13 +42,11 @@ Returns **[Feature][7]<[Point][4]>** the closest point in the set to the referen [3]: https://tools.ietf.org/html/rfc7946#section-3.3 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[7]: https://tools.ietf.org/html/rfc7946#section-3.2 +[6]: https://tools.ietf.org/html/rfc7946#section-3.2 diff --git a/packages/turf-point-grid/README.md b/packages/turf-point-grid/README.md index 249f6201a9..6c409b727a 100644 --- a/packages/turf-point-grid/README.md +++ b/packages/turf-point-grid/README.md @@ -13,7 +13,7 @@ Creates a [Point][1] grid from a bounding box, [FeatureCollection][2] or [Featur * `options` **[Object][6]** Optional parameters (optional, default `{}`) * `options.units` **[string][7]** used in calculating cellSide, can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) - * `options.mask` **[Feature][8]<([Polygon][9] | [MultiPolygon][10])>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it + * `options.mask` **[Feature][3]<([Polygon][8] | [MultiPolygon][9])>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it * `options.properties` **[Object][6]** passed to each point of the grid (optional, default `{}`) ### Examples @@ -29,7 +29,7 @@ var grid = turf.pointGrid(extent, cellSide, options); var addToMap = [grid]; ``` -Returns **[FeatureCollection][11]<[Point][12]>** grid of points +Returns **[FeatureCollection][2]<[Point][1]>** grid of points [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -45,15 +45,9 @@ Returns **[FeatureCollection][11]<[Point][12]>** grid of points [7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[8]: https://tools.ietf.org/html/rfc7946#section-3.2 +[8]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[11]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[12]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7 diff --git a/packages/turf-point-on-feature/README.md b/packages/turf-point-on-feature/README.md index 967167398f..0db0b5002c 100644 --- a/packages/turf-point-on-feature/README.md +++ b/packages/turf-point-on-feature/README.md @@ -33,7 +33,7 @@ var pointOnPolygon = turf.pointOnFeature(polygon); var addToMap = [polygon, pointOnPolygon]; ``` -Returns **[Feature][5]<[Point][6]>** a point on the surface of `input` +Returns **[Feature][5]<[Point][1]>** a point on the surface of `input` [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -45,8 +45,6 @@ Returns **[Feature][5]<[Point][6]>** a point on the surface of `input` [5]: https://tools.ietf.org/html/rfc7946#section-3.2 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - --- diff --git a/packages/turf-point-to-line-distance/README.md b/packages/turf-point-to-line-distance/README.md index 30be6d7984..37d7ce1e34 100644 --- a/packages/turf-point-to-line-distance/README.md +++ b/packages/turf-point-to-line-distance/README.md @@ -9,13 +9,13 @@ minimum distance between the point and any segment of the `LineString`. ### Parameters -* `pt` **([Feature][3]<[Point][4]> | [Array][5]<[number][6]>)** Feature or Geometry -* `line` **[Feature][3]<[LineString][7]>** GeoJSON Feature or Geometry -* `options` **[Object][8]** Optional parameters (optional, default `{}`) +* `pt` **([Feature][3]<[Point][1]> | [Array][4]<[number][5]>)** Feature or Geometry +* `line` **[Feature][3]<[LineString][2]>** GeoJSON Feature or Geometry +* `options` **[Object][6]** Optional parameters (optional, default `{}`) - * `options.units` **[string][9]** can be anything supported by turf/convertLength + * `options.units` **[string][7]** can be anything supported by turf/convertLength (ex: degrees, radians, miles, or kilometers) (optional, default `"kilometers"`) - * `options.method` **[string][9]** wether to calculate the distance based on geodesic (spheroid) or + * `options.method` **[string][7]** wether to calculate the distance based on geodesic (spheroid) or planar (flat) method. Valid options are 'geodesic' or 'planar'. (optional, default `"geodesic"`) ### Examples @@ -28,7 +28,7 @@ var distance = turf.pointToLineDistance(pt, line, {units: 'miles'}); //=69.11854715938406 ``` -Returns **[number][6]** distance between point and line +Returns **[number][5]** distance between point and line [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -36,17 +36,13 @@ Returns **[number][6]** distance between point and line [3]: https://tools.ietf.org/html/rfc7946#section-3.2 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/packages/turf-points-within-polygon/README.md b/packages/turf-points-within-polygon/README.md index 4954f7c05e..9cd0fa91a0 100644 --- a/packages/turf-points-within-polygon/README.md +++ b/packages/turf-points-within-polygon/README.md @@ -8,8 +8,8 @@ Finds [Points][1] or [MultiPoint][2] coordinate positions that fall within [(Mul ### Parameters -* `points` **([Feature][4] | [FeatureCollection][5]<([Point][6] | [MultiPoint][7])>)** Point(s) or MultiPoint(s) as input search -* `polygons` **([FeatureCollection][5] | [Geometry][8] | [Feature][4]<([Polygon][9] | [MultiPolygon][10])>)** (Multi)Polygon(s) to check if points are within +* `points` **([Feature][4] | [FeatureCollection][5]<([Point][1] | [MultiPoint][2])>)** Point(s) or MultiPoint(s) as input search +* `polygons` **([FeatureCollection][5] | [Geometry][6] | [Feature][4]<([Polygon][3] | [MultiPolygon][7])>)** (Multi)Polygon(s) to check if points are within ### Examples @@ -42,7 +42,7 @@ turf.featureEach(ptsWithin, function (currentFeature) { }); ``` -Returns **[FeatureCollection][5]<([Point][6] | [MultiPoint][7])>** Point(s) or MultiPoint(s) with positions that land within at least one polygon. The geometry type will match what was passsed in +Returns **[FeatureCollection][5]<([Point][1] | [MultiPoint][2])>** Point(s) or MultiPoint(s) with positions that land within at least one polygon. The geometry type will match what was passsed in [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -54,15 +54,9 @@ Returns **[FeatureCollection][5]<([Point][6] | [MultiPoint][7])>** Point(s) or M [5]: https://tools.ietf.org/html/rfc7946#section-3.3 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[6]: https://tools.ietf.org/html/rfc7946#section-3.1 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.3 - -[8]: https://tools.ietf.org/html/rfc7946#section-3.1 - -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.7 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7 diff --git a/packages/turf-polygon-smooth/README.md b/packages/turf-polygon-smooth/README.md index 2610dfd82d..f028a5a5ea 100644 --- a/packages/turf-polygon-smooth/README.md +++ b/packages/turf-polygon-smooth/README.md @@ -9,10 +9,10 @@ Warning: may create degenerate polygons. ### Parameters -* `inputPolys` **([FeatureCollection][4]<([Polygon][5] | [MultiPolygon][6])> | [Feature][7]<([Polygon][5] | [MultiPolygon][6])> | [Polygon][5] | [MultiPolygon][6])** (Multi)Polygon(s) to smooth -* `options` **[Object][8]** Optional parameters (optional, default `{}`) +* `inputPolys` **([FeatureCollection][4]<([Polygon][1] | [MultiPolygon][2])> | [Feature][5]<([Polygon][1] | [MultiPolygon][2])> | [Polygon][1] | [MultiPolygon][2])** (Multi)Polygon(s) to smooth +* `options` **[Object][6]** Optional parameters (optional, default `{}`) - * `options.iterations` **[string][9]** The number of times to smooth the polygon. A higher value means a smoother polygon. (optional, default `1`) + * `options.iterations` **[string][7]** The number of times to smooth the polygon. A higher value means a smoother polygon. (optional, default `1`) ### Examples @@ -25,7 +25,7 @@ var smoothed = turf.polygonSmooth(polygon, {iterations: 3}) var addToMap = [smoothed, polygon]; ``` -Returns **[FeatureCollection][4]<([Polygon][5] | [MultiPolygon][6])>** FeatureCollection containing the smoothed polygon/multipoylgons +Returns **[FeatureCollection][4]<([Polygon][1] | [MultiPolygon][2])>** FeatureCollection containing the smoothed polygon/multipoylgons [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -35,15 +35,11 @@ Returns **[FeatureCollection][4]<([Polygon][5] | [MultiPolygon][6])>** FeatureCo [4]: https://tools.ietf.org/html/rfc7946#section-3.3 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[5]: https://tools.ietf.org/html/rfc7946#section-3.2 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.7 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[7]: https://tools.ietf.org/html/rfc7946#section-3.2 - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/packages/turf-polygon-tangents/README.md b/packages/turf-polygon-tangents/README.md index 4e9a2a3393..9f7c968679 100644 --- a/packages/turf-polygon-tangents/README.md +++ b/packages/turf-polygon-tangents/README.md @@ -9,7 +9,7 @@ Finds the tangents of a [(Multi)Polygon][1] from a [Point][2]. ### Parameters * `pt` **[Coord][3]** to calculate the tangent points from -* `polygon` **[Feature][4]<([Polygon][5] | [MultiPolygon][6])>** to get tangents from +* `polygon` **[Feature][4]<([Polygon][1] | [MultiPolygon][5])>** to get tangents from ### Examples @@ -23,7 +23,7 @@ var tangents = turf.polygonTangents(point, polygon) var addToMap = [tangents, point, polygon]; ``` -Returns **[FeatureCollection][7]<[Point][8]>** Feature Collection containing the two tangent points +Returns **[FeatureCollection][6]<[Point][2]>** Feature Collection containing the two tangent points [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -33,13 +33,9 @@ Returns **[FeatureCollection][7]<[Point][8]>** Feature Collection containing the [4]: https://tools.ietf.org/html/rfc7946#section-3.2 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[5]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[7]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[6]: https://tools.ietf.org/html/rfc7946#section-3.3 diff --git a/packages/turf-polygon-to-line/README.md b/packages/turf-polygon-to-line/README.md index 7b6cf7aa99..0205df3f74 100644 --- a/packages/turf-polygon-to-line/README.md +++ b/packages/turf-polygon-to-line/README.md @@ -9,10 +9,10 @@ Converts a [Polygon][1] to [(Multi)LineString][2] or [MultiPolygon][3] to a ### Parameters -* `poly` **[Feature][5]<([Polygon][6] | [MultiPolygon][7])>** Feature to convert -* `options` **[Object][8]** Optional parameters (optional, default `{}`) +* `poly` **[Feature][5]<([Polygon][1] | [MultiPolygon][3])>** Feature to convert +* `options` **[Object][6]** Optional parameters (optional, default `{}`) - * `options.properties` **[Object][8]** translates GeoJSON properties to Feature (optional, default `{}`) + * `options.properties` **[Object][6]** translates GeoJSON properties to Feature (optional, default `{}`) ### Examples @@ -25,7 +25,7 @@ var line = turf.polygonToLine(poly); var addToMap = [line]; ``` -Returns **([FeatureCollection][9] | [Feature][5]<([LineString][10] | MultiLinestring)>)** converted (Multi)Polygon to (Multi)LineString +Returns **([FeatureCollection][4] | [Feature][5]<([LineString][2] | MultiLinestring)>)** converted (Multi)Polygon to (Multi)LineString [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -37,15 +37,7 @@ Returns **([FeatureCollection][9] | [Feature][5]<([LineString][10] | MultiLinest [5]: https://tools.ietf.org/html/rfc7946#section-3.2 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[9]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object diff --git a/packages/turf-polygonize/README.md b/packages/turf-polygonize/README.md index fb292ae8ac..48f42a366f 100644 --- a/packages/turf-polygonize/README.md +++ b/packages/turf-polygonize/README.md @@ -18,13 +18,13 @@ The implementation correctly handles: ### Parameters -* `geoJson` **([FeatureCollection][3] | [Geometry][4] | [Feature][5]<([LineString][6] | [MultiLineString][7])>)** Lines in order to polygonize +* `geoJson` **([FeatureCollection][3] | [Geometry][4] | [Feature][5]<([LineString][1] | [MultiLineString][6])>)** Lines in order to polygonize -* Throws **[Error][8]** if geoJson is invalid. +* Throws **[Error][7]** if geoJson is invalid. -Returns **[FeatureCollection][3]<[Polygon][9]>** Polygons created +Returns **[FeatureCollection][3]<[Polygon][2]>** Polygons created [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -36,13 +36,9 @@ Returns **[FeatureCollection][3]<[Polygon][9]>** Polygons created [5]: https://tools.ietf.org/html/rfc7946#section-3.2 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[6]: https://tools.ietf.org/html/rfc7946#section-3.1.5 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.5 - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error - -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error diff --git a/packages/turf-quadrat-analysis/README.md b/packages/turf-quadrat-analysis/README.md index 8fdadf1f9e..d4802e36e1 100644 --- a/packages/turf-quadrat-analysis/README.md +++ b/packages/turf-quadrat-analysis/README.md @@ -36,7 +36,7 @@ which is simply the area of the study area divided by the number of features. * `options.studyBbox` **bbox?** bbox representing the study area * `options.confidenceLevel` **[number][4]** a confidence level. - The unit is percentage . 5 means 95%, value must be in [K_TABLE][5] (optional, default `20`) + The unit is percentage . 5 means 95%, value must be in [K\_TABLE][5] (optional, default `20`) ### Examples @@ -48,7 +48,7 @@ var result = turf.quadratAnalysis(dataset); Returns **[Object][3]** result [QuadratAnalysisResult][6] -## K_TABLE +## K\_TABLE the confidence level @@ -56,12 +56,12 @@ Type: [Object][3] ### Properties -* `20` **[number][4]** -* `15` **[number][4]** -* `10` **[number][4]** -* `5` **[number][4]** -* `2` **[number][4]** -* `1` **[number][4]** +* `20` **[number][4]** +* `15` **[number][4]** +* `10` **[number][4]** +* `5` **[number][4]** +* `2` **[number][4]** +* `1` **[number][4]** ## QuadratAnalysisResult @@ -71,9 +71,9 @@ Type: [Object][3] ### Properties -* `criticalValue` **[number][4]** -* `maxAbsoluteDifference` **[number][4]** -* `isRandom` **[boolean][7]** +* `criticalValue` **[number][4]** +* `maxAbsoluteDifference` **[number][4]** +* `isRandom` **[boolean][7]** * `observedDistribution` **[Array][8]<[number][4]>** the cumulative distribution of observed features, the index represents the number of features in the quadrat. diff --git a/packages/turf-rectangle-grid/README.md b/packages/turf-rectangle-grid/README.md index 97d35946c6..9ad5c99ff6 100644 --- a/packages/turf-rectangle-grid/README.md +++ b/packages/turf-rectangle-grid/README.md @@ -15,7 +15,7 @@ Creates a grid of rectangles from a bounding box, [Feature][1] or [FeatureCollec * `options.units` **[string][6]** units ("degrees", "radians", "miles", "kilometers") that the given cellWidth and cellHeight are expressed in. Converted at the southern border. (optional, default `'kilometers'`) - * `options.mask` **[Feature][7]<([Polygon][8] | [MultiPolygon][9])>?** if passed a Polygon or MultiPolygon, + * `options.mask` **[Feature][1]<([Polygon][7] | [MultiPolygon][8])>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it * `options.properties` **[Object][5]** passed to each point of the grid (optional, default `{}`) @@ -33,7 +33,7 @@ var rectangleGrid = turf.rectangleGrid(bbox, cellWidth, cellHeight, options); var addToMap = [rectangleGrid] ``` -Returns **[FeatureCollection][10]<[Polygon][8]>** a grid of polygons +Returns **[FeatureCollection][2]<[Polygon][7]>** a grid of polygons [1]: https://tools.ietf.org/html/rfc7946#section-3.2 @@ -47,13 +47,9 @@ Returns **[FeatureCollection][10]<[Polygon][8]>** a grid of polygons [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[7]: https://tools.ietf.org/html/rfc7946#section-3.2 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.3 +[8]: https://tools.ietf.org/html/rfc7946#section-3.1.7 diff --git a/packages/turf-rhumb-destination/README.md b/packages/turf-rhumb-destination/README.md index 74e53e22d9..001ad5d59b 100644 --- a/packages/turf-rhumb-destination/README.md +++ b/packages/turf-rhumb-destination/README.md @@ -32,7 +32,7 @@ var addToMap = [pt, destination] destination.properties['marker-color'] = '#00F'; ``` -Returns **[Feature][6]<[Point][7]>** Destination point. +Returns **[Feature][6]<[Point][1]>** Destination point. [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -46,8 +46,6 @@ Returns **[Feature][6]<[Point][7]>** Destination point. [6]: https://tools.ietf.org/html/rfc7946#section-3.2 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - --- diff --git a/packages/turf-sample/README.md b/packages/turf-sample/README.md index 4d48654357..d853c8b2c3 100644 --- a/packages/turf-sample/README.md +++ b/packages/turf-sample/README.md @@ -8,8 +8,8 @@ Takes a [FeatureCollection][1] and returns a FeatureCollection with given number ### Parameters -* `featurecollection` **[FeatureCollection][3]** set of input features -* `num` **[number][4]** number of features to select +* `featurecollection` **[FeatureCollection][1]** set of input features +* `num` **[number][3]** number of features to select ### Examples @@ -26,15 +26,13 @@ turf.featureEach(sample, function (currentFeature) { }); ``` -Returns **[FeatureCollection][3]** a FeatureCollection with `n` features +Returns **[FeatureCollection][1]** a FeatureCollection with `n` features [1]: https://tools.ietf.org/html/rfc7946#section-3.3 [2]: https://tools.ietf.org/html/rfc7946#section-3.2 -[3]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number diff --git a/packages/turf-shortest-path/README.md b/packages/turf-shortest-path/README.md index 9fbeae5810..4875b1b769 100644 --- a/packages/turf-shortest-path/README.md +++ b/packages/turf-shortest-path/README.md @@ -13,9 +13,9 @@ any [Feature][3] in [ obstacles][4] * `end` **[Coord][5]** point * `options` **[Object][6]** optional parameters (optional, default `{}`) - * `options.obstacles` **([Geometry][7] | [Feature][8] | [FeatureCollection][9]<[Polygon][10]>)?** areas which path cannot travel - * `options.units` **[string][11]** unit in which resolution & minimum distance will be expressed in; it can be degrees, radians, miles, kilometers, ... (optional, default `'kilometers'`) - * `options.resolution` **[number][12]** distance between matrix points on which the path will be calculated (optional, default `100`) + * `options.obstacles` **([Geometry][7] | [Feature][3] | [FeatureCollection][8]<[Polygon][9]>)?** areas which path cannot travel + * `options.units` **[string][10]** unit in which resolution & minimum distance will be expressed in; it can be degrees, radians, miles, kilometers, ... (optional, default `'kilometers'`) + * `options.resolution` **[number][11]** distance between matrix points on which the path will be calculated (optional, default `100`) ### Examples @@ -32,7 +32,7 @@ var path = turf.shortestPath(start, end, options); var addToMap = [start, end, options.obstacles, path]; ``` -Returns **[Feature][8]<[LineString][13]>** shortest path between start and end +Returns **[Feature][3]<[LineString][1]>** shortest path between start and end [1]: https://tools.ietf.org/html/rfc7946#section-3.1.4 @@ -48,17 +48,13 @@ Returns **[Feature][8]<[LineString][13]>** shortest path between start and end [7]: https://tools.ietf.org/html/rfc7946#section-3.1 -[8]: https://tools.ietf.org/html/rfc7946#section-3.2 +[8]: https://tools.ietf.org/html/rfc7946#section-3.3 -[9]: https://tools.ietf.org/html/rfc7946#section-3.3 +[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - -[13]: https://tools.ietf.org/html/rfc7946#section-3.1.4 +[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number diff --git a/packages/turf-simplify/README.md b/packages/turf-simplify/README.md index fd34108671..42e5337021 100644 --- a/packages/turf-simplify/README.md +++ b/packages/turf-simplify/README.md @@ -9,12 +9,12 @@ Takes a [GeoJSON][1] object and returns a simplified version. Internally uses th ### Parameters -* `geojson` **[GeoJSON][3]** object to be simplified -* `options` **[Object][4]** Optional parameters (optional, default `{}`) +* `geojson` **[GeoJSON][1]** object to be simplified +* `options` **[Object][3]** Optional parameters (optional, default `{}`) - * `options.tolerance` **[number][5]** simplification tolerance (optional, default `1`) - * `options.highQuality` **[boolean][6]** whether or not to spend more time to create a higher-quality simplification with a different algorithm (optional, default `false`) - * `options.mutate` **[boolean][6]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`) + * `options.tolerance` **[number][4]** simplification tolerance (optional, default `1`) + * `options.highQuality` **[boolean][5]** whether or not to spend more time to create a higher-quality simplification with a different algorithm (optional, default `false`) + * `options.mutate` **[boolean][5]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`) ### Examples @@ -48,19 +48,17 @@ var simplified = turf.simplify(geojson, options); var addToMap = [geojson, simplified] ``` -Returns **[GeoJSON][3]** a simplified GeoJSON +Returns **[GeoJSON][1]** a simplified GeoJSON [1]: https://tools.ietf.org/html/rfc7946#section-3 [2]: http://mourner.github.io/simplify-js/ -[3]: https://tools.ietf.org/html/rfc7946#section-3 +[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object -[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean diff --git a/packages/turf-standard-deviational-ellipse/README.md b/packages/turf-standard-deviational-ellipse/README.md index 28983314cc..727d3b1f38 100644 --- a/packages/turf-standard-deviational-ellipse/README.md +++ b/packages/turf-standard-deviational-ellipse/README.md @@ -7,7 +7,7 @@ Takes a collection of features and returns a standard deviational ellipse, also known as a “directional distribution.” The standard deviational ellipse aims to show the direction and the distribution of a dataset by drawing -an ellipse that contains about one standard deviation’s worth (~ 70%) of the +an ellipse that contains about one standard deviation’s worth (\~ 70%) of the data. This module mirrors the functionality of [Directional Distribution][1] diff --git a/packages/turf-tag/README.md b/packages/turf-tag/README.md index 4dda208adf..c8c82ed6b2 100644 --- a/packages/turf-tag/README.md +++ b/packages/turf-tag/README.md @@ -8,10 +8,10 @@ Takes a set of [points][1] and a set of [polygons][2] and/or [multipolygons][3] ### Parameters -* `points` **[FeatureCollection][4]<[Point][5]>** input points -* `polygons` **[FeatureCollection][4]<([Polygon][6] | [MultiPolygon][7])>** input (multi)polygons -* `field` **[string][8]** property in `polygons` to add to joined {} features -* `outField` **[string][8]** property in `points` in which to store joined property from `polygons` +* `points` **[FeatureCollection][4]<[Point][1]>** input points +* `polygons` **[FeatureCollection][4]<([Polygon][2] | [MultiPolygon][3])>** input (multi)polygons +* `field` **[string][5]** property in `polygons` to add to joined {} features +* `outField` **[string][5]** property in `points` in which to store joined property from `polygons` ### Examples @@ -42,7 +42,7 @@ var tagged = turf.tag(points, polygons, 'pop', 'population'); var addToMap = [tagged, polygons] ``` -Returns **[FeatureCollection][4]<[Point][5]>** points with `containingPolyId` property containing values from `polyId` +Returns **[FeatureCollection][4]<[Point][1]>** points with `containingPolyId` property containing values from `polyId` [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -52,13 +52,7 @@ Returns **[FeatureCollection][4]<[Point][5]>** points with `containingPolyId` pr [4]: https://tools.ietf.org/html/rfc7946#section-3.3 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String diff --git a/packages/turf-tin/README.md b/packages/turf-tin/README.md index 109e7b1112..5ae8f4f70f 100644 --- a/packages/turf-tin/README.md +++ b/packages/turf-tin/README.md @@ -15,8 +15,8 @@ triangle. ### Parameters -* `points` **[FeatureCollection][3]<[Point][4]>** input points -* `z` **[String][5]?** name of the property from which to pull z values +* `points` **[FeatureCollection][3]<[Point][1]>** input points +* `z` **[String][4]?** name of the property from which to pull z values This is optional: if not given, then there will be no extra data added to the derived triangles. ### Examples @@ -39,7 +39,7 @@ for (var i = 0; i < tin.features.length; i++) { } ``` -Returns **[FeatureCollection][3]<[Polygon][6]>** TIN output +Returns **[FeatureCollection][3]<[Polygon][5]>** TIN output [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -47,11 +47,9 @@ Returns **[FeatureCollection][3]<[Polygon][6]>** TIN output [3]: https://tools.ietf.org/html/rfc7946#section-3.3 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[5]: https://tools.ietf.org/html/rfc7946#section-3.1.6 diff --git a/packages/turf-triangle-grid/README.md b/packages/turf-triangle-grid/README.md index 0e3805aa15..10dcd092d5 100644 --- a/packages/turf-triangle-grid/README.md +++ b/packages/turf-triangle-grid/README.md @@ -13,7 +13,7 @@ Takes a bounding box and a cell depth and returns a set of triangular [polygons] * `options` **[Object][4]** Optional parameters (optional, default `{}`) * `options.units` **[string][5]** used in calculating cellSide, can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) - * `options.mask` **[Feature][6]<[Polygon][7]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it + * `options.mask` **[Feature][6]<[Polygon][1]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it * `options.properties` **[Object][4]** passed to each point of the grid (optional, default `{}`) ### Examples @@ -29,7 +29,7 @@ var triangleGrid = turf.triangleGrid(bbox, cellSide, options); var addToMap = [triangleGrid]; ``` -Returns **[FeatureCollection][8]<[Polygon][7]>** grid of polygons +Returns **[FeatureCollection][7]<[Polygon][1]>** grid of polygons [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -43,9 +43,7 @@ Returns **[FeatureCollection][8]<[Polygon][7]>** grid of polygons [6]: https://tools.ietf.org/html/rfc7946#section-3.2 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[8]: https://tools.ietf.org/html/rfc7946#section-3.3 +[7]: https://tools.ietf.org/html/rfc7946#section-3.3 diff --git a/packages/turf-union/README.md b/packages/turf-union/README.md index b21344f10e..42f68d4848 100644 --- a/packages/turf-union/README.md +++ b/packages/turf-union/README.md @@ -8,10 +8,10 @@ Takes input [(Multi)Polygon(s)][1] and returns a combined polygon. If the input ### Parameters -* `polygon1` **[Feature][3]<([Polygon][4] | [MultiPolygon][5])>** input Polygon features -* `options` **[Object][6]** Optional Parameters (optional, default `{}`) +* `polygon1` **[Feature][3]<([Polygon][1] | [MultiPolygon][2])>** input Polygon features +* `options` **[Object][4]** Optional Parameters (optional, default `{}`) - * `options.properties` **[Object][6]** Translate Properties to output Feature (optional, default `{}`) + * `options.properties` **[Object][4]** Translate Properties to output Feature (optional, default `{}`) ### Examples @@ -37,7 +37,7 @@ var union = turf.union(turf.featureCollection([poly1, poly2])); var addToMap = [poly1, poly2, union]; ``` -Returns **[Feature][3]<([Polygon][4] | [MultiPolygon][5])>** a combined [Polygon][1] or [MultiPolygon][2] feature, or null if the inputs are empty +Returns **[Feature][3]<([Polygon][1] | [MultiPolygon][2])>** a combined [Polygon][1] or [MultiPolygon][2] feature, or null if the inputs are empty [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -45,11 +45,7 @@ Returns **[Feature][3]<([Polygon][4] | [MultiPolygon][5])>** a combined [Polygon [3]: https://tools.ietf.org/html/rfc7946#section-3.2 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 94110705be..ca1e8f6955 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -48,8 +48,8 @@ importers: specifier: ^8.1.2 version: 8.1.2 documentation: - specifier: ^13.2.5 - version: 13.2.5 + specifier: ^14.0.3 + version: 14.0.3 es-check: specifier: ^7.1.1 version: 7.1.1 @@ -6211,7 +6211,7 @@ importers: version: 5.7.2 tsup: specifier: ^8.0.1 - version: 8.0.1(typescript@5.3.3) + version: 8.0.1(ts-node@9.1.1)(typescript@5.3.3) tsx: specifier: ^4.6.2 version: 4.6.2 @@ -8951,10 +8951,20 @@ packages: resolution: {integrity: sha512-DauBl25PKZZ0WVJr42a6CNvI6efsdzofl9sajqZr2Gf5Gu733WkDdUGiPkUHXiUvYGzNNlFQde2wdZdfQPG+yw==} dev: false + /@types/debug@4.1.12: + resolution: {integrity: sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==} + dependencies: + '@types/ms': 0.7.34 + dev: true + /@types/estree@1.0.5: resolution: {integrity: sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==} dev: true + /@types/extend@3.0.4: + resolution: {integrity: sha512-ArMouDUTJEz1SQRpFsT2rIw7DeqICFv5aaVzLSIYMYQSLcwcGOfT3VyglQs/p7K3F7fT4zxr0NWxYZIdifD6dA==} + dev: true + /@types/geojson@7946.0.14: resolution: {integrity: sha512-WCfD5Ht3ZesJUsONdhvm84dmzWOiOzOAqOncN0++w0lBw1o8OuDNJF2McvvCef/yBqb/HYRahp1BYtODFQ8bRg==} dev: false @@ -8962,6 +8972,12 @@ packages: /@types/geojson@7946.0.8: resolution: {integrity: sha512-1rkryxURpr6aWP7R786/UQOkJ3PcpQiWkAXBmdWc7ryFWqN6a4xfK7BtjXvFBKO9LjQ+MWQSWxYeZX1OApnArA==} + /@types/hast@2.3.10: + resolution: {integrity: sha512-McWspRw8xx8J9HurkVBfYj0xKoE25tOFlHGdx4MJ5xORQrMGZNqJhVQWaIbm6Oyla5kYOXtDiopzKRJzEOkwJw==} + dependencies: + '@types/unist': 2.0.10 + dev: true + /@types/json-schema@7.0.15: resolution: {integrity: sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==} dev: true @@ -8984,6 +9000,10 @@ packages: resolution: {integrity: sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==} dev: true + /@types/ms@0.7.34: + resolution: {integrity: sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g==} + dev: true + /@types/node@18.11.9: resolution: {integrity: sha512-CRpX21/kGdzjOpFsZSkcrXMGIBWMGNIHXXBVFSH+ggkftxg+XYP20TESbh+zFvFj3EQOl5byk0HTRn1IL6hbqg==} dev: true @@ -9000,6 +9020,10 @@ packages: resolution: {integrity: sha512-dISoDXWWQwUquiKsyZ4Ng+HX2KsPL7LyHKHQwgGFEA3IaKac4Obd+h2a/a6waisAoepJlBcx9paWqjA8/HVjCw==} dev: true + /@types/parse5@6.0.3: + resolution: {integrity: sha512-SuT16Q1K51EAVPz1K29DJ/sXjhSQ0zjvsypYJ6tlwVsRV9jwW5Adq2ch8Dq8kDBCkYnELS7N7VNCSB5nC56t/g==} + dev: true + /@types/rbush@3.0.3: resolution: {integrity: sha512-lX55lR0iYCgapxD3IrgujpQA1zDxwZI5qMRelKvmKAsSMplFVr7wmMpG7/6+Op2tjrgEex8o3vjg8CRDrRNYxg==} dev: true @@ -9016,6 +9040,10 @@ packages: resolution: {integrity: sha512-3fT48uRSRppOdQIlNCQKNNJRVaqzxkdCSTZM+NeHNxEpw6JejLLH78OHP54BxUHYEsa7pVsGn6uON552jwv9ZQ==} dev: true + /@types/supports-color@8.1.3: + resolution: {integrity: sha512-Hy6UMpxhE3j1tLpl27exp1XqHD7n8chAiNPzWfz16LPZoMMoSc4dzLl6w9qijkEb/r5O1ozdu1CWGA2L83ZeZg==} + dev: true + /@types/tape@4.13.4: resolution: {integrity: sha512-0Mw8/FAMheD2MvyaFYDaAix7X5GfNjl/XI+zvqJdzC6N05BmHKz6Hwn+r7+8PEXDEKrC3V/irC9z7mrl5a130g==} dependencies: @@ -9680,6 +9708,10 @@ packages: resolution: {integrity: sha512-xFbRxM1tahm08yHBP16MMjVUAvDaBMD38zsM9EMAUN61omwLmKlOpB/Zku5QkjZ8TZ4vn53pj+t518cH0S03RQ==} dev: true + /bail@2.0.2: + resolution: {integrity: sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==} + dev: true + /balanced-match@1.0.2: resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} dev: true @@ -9974,6 +10006,10 @@ packages: resolution: {integrity: sha512-vlNK021QdI7PNeiUh/lKkC/mNHHfV0m/Ad5JoI0TYtlBnJAslM/JIkm/tGC88bkLIwO6OQ5uV6ztS6kVAtCDlg==} dev: true + /ccount@2.0.1: + resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==} + dev: true + /chalk@2.4.2: resolution: {integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==} engines: {node: '>=4'} @@ -10008,14 +10044,26 @@ packages: resolution: {integrity: sha512-HRcDxZuZqMx3/a+qrzxdBKBPUpxWEq9xw2OPZ3a/174ihfrQKVsFhqtthBInFy1zZ9GgZyFXOatNujm8M+El3g==} dev: true + /character-entities-html4@2.1.0: + resolution: {integrity: sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==} + dev: true + /character-entities-legacy@1.1.4: resolution: {integrity: sha512-3Xnr+7ZFS1uxeiUDvV02wQ+QDbc55o97tIV5zHScSPJpcLm/r0DFPcoY3tYRp+VZukxuMeKgXYmsXQHO05zQeA==} dev: true + /character-entities-legacy@3.0.0: + resolution: {integrity: sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==} + dev: true + /character-entities@1.2.4: resolution: {integrity: sha512-iBMyeEHxfVnIakwOuDXpVkc54HijNgCyQB2w0VfGQThle6NXn50zU6V/u+LDhxHcDUPojn6Kpga3PTAD8W1bQw==} dev: true + /character-entities@2.0.2: + resolution: {integrity: sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==} + dev: true + /character-reference-invalid@1.1.4: resolution: {integrity: sha512-mKKUkUbhPpQlCOfIuZkvSEgktjPFIsZKRRbC6KWVEMvlzblj3i3asQv5ODsrwt0N3pHAEvjP8KTQPHkp0+6jOg==} dev: true @@ -10242,6 +10290,10 @@ packages: resolution: {integrity: sha512-GHuDRO12Sypu2cV70d1dkA2EUmXHgntrzbpvOB+Qy+49ypNfGgFQIC2fhhXbnyrJRynDCAARsT7Ou0M6hirpfw==} dev: true + /comma-separated-tokens@2.0.3: + resolution: {integrity: sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==} + dev: true + /commander@10.0.0: resolution: {integrity: sha512-zS5PnTI22FIRM6ylNW8G4Ap0IEOyk62fhLSD0+uHRT9McRCLGpkVNvao4bjimpK/GShynyQkFFxHhwMcETmduA==} engines: {node: '>=14'} @@ -10724,6 +10776,12 @@ packages: engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} dev: true + /decode-named-character-reference@1.0.2: + resolution: {integrity: sha512-O8x12RzrUF8xyVcY0KJowWsmaJxQbmy0/EtnNtHRpsOcT7dFk5W598coHqBVpmWo1oQQfsCqfCmkZN5DJrZVdg==} + dependencies: + character-entities: 2.0.2 + dev: true + /decode-uri-component@0.2.2: resolution: {integrity: sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==} engines: {node: '>=0.10'} @@ -10871,6 +10929,11 @@ packages: resolution: {integrity: sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==} dev: true + /dequal@2.0.3: + resolution: {integrity: sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==} + engines: {node: '>=6'} + dev: true + /detect-indent@5.0.0: resolution: {integrity: sha512-rlpvsxUtM0PQvy9iZe640/IWwWYyBsTApREbA1pHOpmOUIl9MkP/U4z7vTtg4Oaojvqhxt7sdufnT0EzGaR31g==} engines: {node: '>=4'} @@ -10992,6 +11055,11 @@ packages: engines: {node: '>=0.3.1'} dev: true + /diff@5.2.0: + resolution: {integrity: sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==} + engines: {node: '>=0.3.1'} + dev: true + /dir-glob@3.0.1: resolution: {integrity: sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==} engines: {node: '>=8'} @@ -11071,6 +11139,55 @@ packages: - supports-color dev: true + /documentation@14.0.3: + resolution: {integrity: sha512-B7cAviVKN9Rw7Ofd+9grhVuxiHwly6Ieh+d/ceMw8UdBOv/irkuwnDEJP8tq0wgdLJDUVuIkovV+AX9mTrZFxg==} + engines: {node: '>=14'} + hasBin: true + dependencies: + '@babel/core': 7.23.5 + '@babel/generator': 7.23.5 + '@babel/parser': 7.23.5 + '@babel/traverse': 7.23.5 + '@babel/types': 7.23.5 + chalk: 5.3.0 + chokidar: 3.5.3 + diff: 5.2.0 + doctrine-temporary-fork: 2.1.0 + git-url-parse: 13.1.0 + github-slugger: 1.4.0 + glob: 8.1.0 + globals-docs: 2.4.1 + highlight.js: 11.10.0 + ini: 3.0.1 + js-yaml: 4.1.0 + konan: 2.1.1 + lodash: 4.17.21 + mdast-util-find-and-replace: 2.2.2 + mdast-util-inject: 1.1.0 + micromark-util-character: 1.2.0 + parse-filepath: 1.0.2 + pify: 6.1.0 + read-pkg-up: 9.1.0 + remark: 14.0.3 + remark-gfm: 3.0.1 + remark-html: 15.0.2 + remark-reference-links: 6.0.1 + remark-toc: 8.0.1 + resolve: 1.22.8 + strip-json-comments: 5.0.1 + unist-builder: 3.0.1 + unist-util-visit: 4.1.2 + vfile: 5.3.7 + vfile-reporter: 7.0.5 + vfile-sort: 3.0.1 + yargs: 17.7.2 + optionalDependencies: + '@vue/compiler-sfc': 3.3.11 + vue-template-compiler: 2.7.15 + transitivePeerDependencies: + - supports-color + dev: true + /dot-prop@5.3.0: resolution: {integrity: sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q==} engines: {node: '>=8'} @@ -11387,6 +11504,11 @@ packages: engines: {node: '>=10'} dev: true + /escape-string-regexp@5.0.0: + resolution: {integrity: sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==} + engines: {node: '>=12'} + dev: true + /escodegen@2.1.0: resolution: {integrity: sha512-2NlIDTwUWJN0mRPQOdtQBzbUHvdGY2P1VXSyU83Q3xKxM7WHX2Ql8dKq782Q9TgQUNOLEzEYu9bzLNj1q88I5w==} engines: {node: '>=6.0'} @@ -11817,6 +11939,14 @@ packages: path-exists: 4.0.0 dev: true + /find-up@6.3.0: + resolution: {integrity: sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + dependencies: + locate-path: 7.2.0 + path-exists: 5.0.0 + dev: true + /find-up@7.0.0: resolution: {integrity: sha512-YyZM99iHrqLKjmt4LJDj58KI+fYyufRLBSYcqycxf//KpBk9FoewoGX0450m9nB44qrZnovzC2oeP5hUibxc/g==} engines: {node: '>=18'} @@ -12171,10 +12301,18 @@ packages: emoji-regex: 6.1.1 dev: true + /github-slugger@1.4.0: + resolution: {integrity: sha512-w0dzqw/nt51xMVmlaV1+JRzN+oCa1KfcgGEWhxUG16wbdA+Xnt/yoFO8Z8x/V82ZcZ0wy6ln9QDup5avbhiDhQ==} + dev: true + /github-slugger@1.5.0: resolution: {integrity: sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw==} dev: true + /github-slugger@2.0.0: + resolution: {integrity: sha512-IaOQ9puYtjrkq7Y0Ygl9KDZnrf/aiUJYUpVf89y8kyaxbRG7Y1SrX/jaumrv81vc61+kiMempujsM3Yw7w5qcw==} + dev: true + /glob-parent@3.1.0: resolution: {integrity: sha512-E8Ak/2+dZY6fnzlR7+ueWvhsH1SjHr4jjss4YS/h4py44jY9MhK/VFdaZJAWDz6BbL21KeteKxFSFpq8OS5gVA==} dependencies: @@ -12249,6 +12387,7 @@ packages: /glob@8.1.0: resolution: {integrity: sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==} engines: {node: '>=12'} + deprecated: Glob versions prior to v9 are no longer supported dependencies: fs.realpath: 1.0.0 inflight: 1.0.6 @@ -12440,16 +12579,56 @@ packages: function-bind: 1.1.2 dev: true + /hast-util-from-parse5@7.1.2: + resolution: {integrity: sha512-Nz7FfPBuljzsN3tCQ4kCBKqdNhQE2l0Tn+X1ubgKBPRoiDIu1mL08Cfw4k7q71+Duyaw7DXDN+VTAp4Vh3oCOw==} + dependencies: + '@types/hast': 2.3.10 + '@types/unist': 2.0.10 + hastscript: 7.2.0 + property-information: 6.5.0 + vfile: 5.3.7 + vfile-location: 4.1.0 + web-namespaces: 2.0.1 + dev: true + /hast-util-is-element@1.1.0: resolution: {integrity: sha512-oUmNua0bFbdrD/ELDSSEadRVtWZOf3iF6Lbv81naqsIV99RnSCieTbWuWCY8BAeEfKJTKl0gRdokv+dELutHGQ==} dev: true + /hast-util-parse-selector@3.1.1: + resolution: {integrity: sha512-jdlwBjEexy1oGz0aJ2f4GKMaVKkA9jwjr4MjAAI22E5fM/TXVZHuS5OpONtdeIkRKqAaryQ2E9xNQxijoThSZA==} + dependencies: + '@types/hast': 2.3.10 + dev: true + + /hast-util-raw@7.2.3: + resolution: {integrity: sha512-RujVQfVsOrxzPOPSzZFiwofMArbQke6DJjnFfceiEbFh7S05CbPt0cYN+A5YeD3pso0JQk6O1aHBnx9+Pm2uqg==} + dependencies: + '@types/hast': 2.3.10 + '@types/parse5': 6.0.3 + hast-util-from-parse5: 7.1.2 + hast-util-to-parse5: 7.1.0 + html-void-elements: 2.0.1 + parse5: 6.0.1 + unist-util-position: 4.0.4 + unist-util-visit: 4.1.2 + vfile: 5.3.7 + web-namespaces: 2.0.1 + zwitch: 2.0.4 + dev: true + /hast-util-sanitize@3.0.2: resolution: {integrity: sha512-+2I0x2ZCAyiZOO/sb4yNLFmdwPBnyJ4PBkVTUMKMqBwYNA+lXSgOmoRXlJFazoyid9QPogRRKgKhVEodv181sA==} dependencies: xtend: 4.0.2 dev: true + /hast-util-sanitize@4.1.0: + resolution: {integrity: sha512-Hd9tU0ltknMGRDv+d6Ro/4XKzBqQnP/EZrpiTbpFYfXv/uOhWeKc+2uajcbEvAEH98VZd7eII2PiXm13RihnLw==} + dependencies: + '@types/hast': 2.3.10 + dev: true + /hast-util-to-html@7.1.3: resolution: {integrity: sha512-yk2+1p3EJTEE9ZEUkgHsUSVhIpCsL/bvT8E5GzmWc+N1Po5gBw+0F8bo7dpxXR0nu0bQVxVZGX2lBGF21CmeDw==} dependencies: @@ -12465,10 +12644,51 @@ packages: xtend: 4.0.2 dev: true + /hast-util-to-html@8.0.4: + resolution: {integrity: sha512-4tpQTUOr9BMjtYyNlt0P50mH7xj0Ks2xpo8M943Vykljf99HW6EzulIoJP1N3eKOSScEHzyzi9dm7/cn0RfGwA==} + dependencies: + '@types/hast': 2.3.10 + '@types/unist': 2.0.10 + ccount: 2.0.1 + comma-separated-tokens: 2.0.3 + hast-util-raw: 7.2.3 + hast-util-whitespace: 2.0.1 + html-void-elements: 2.0.1 + property-information: 6.5.0 + space-separated-tokens: 2.0.2 + stringify-entities: 4.0.4 + zwitch: 2.0.4 + dev: true + + /hast-util-to-parse5@7.1.0: + resolution: {integrity: sha512-YNRgAJkH2Jky5ySkIqFXTQiaqcAtJyVE+D5lkN6CdtOqrnkLfGYYrEcKuHOJZlp+MwjSwuD3fZuawI+sic/RBw==} + dependencies: + '@types/hast': 2.3.10 + comma-separated-tokens: 2.0.3 + property-information: 6.5.0 + space-separated-tokens: 2.0.2 + web-namespaces: 2.0.1 + zwitch: 2.0.4 + dev: true + /hast-util-whitespace@1.0.4: resolution: {integrity: sha512-I5GTdSfhYfAPNztx2xJRQpG8cuDSNt599/7YUn7Gx/WxNMsG+a835k97TDkFgk123cwjfwINaZknkKkphx/f2A==} dev: true + /hast-util-whitespace@2.0.1: + resolution: {integrity: sha512-nAxA0v8+vXSBDt3AnRUNjyRIQ0rD+ntpbAp4LnPkumc5M9yUbSMa4XDU9Q6etY4f1Wp4bNgvc1yjiZtsTTrSng==} + dev: true + + /hastscript@7.2.0: + resolution: {integrity: sha512-TtYPq24IldU8iKoJQqvZOuhi5CyCQRAbvDOX0x1eW6rsHSxa/1i2CCiptNTotGHJ3VoHRGmqiv6/D3q113ikkw==} + dependencies: + '@types/hast': 2.3.10 + comma-separated-tokens: 2.0.3 + hast-util-parse-selector: 3.1.1 + property-information: 6.5.0 + space-separated-tokens: 2.0.2 + dev: true + /he@1.2.0: resolution: {integrity: sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==} hasBin: true @@ -12480,6 +12700,11 @@ packages: resolution: {integrity: sha512-tzcUFauisWKNHaRkN4Wjl/ZA07gENAjFl3J/c480dprkGTg5EQstgaNFqBfUqCq54kZRIEcreTsAgF/m2quD7A==} dev: true + /highlight.js@11.10.0: + resolution: {integrity: sha512-SYVnVFswQER+zu1laSya563s+F8VDGt7o35d4utbamowvUNLLMovFqwCLSocpZTz3MgaSRA1IbqRWZv97dtErQ==} + engines: {node: '>=12.0.0'} + dev: true + /hosted-git-info@2.8.9: resolution: {integrity: sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==} dev: true @@ -12516,6 +12741,10 @@ packages: resolution: {integrity: sha512-uE/TxKuyNIcx44cIWnjr/rfIATDH7ZaOMmstu0CwhFG1Dunhlp4OC6/NMbhiwoq5BpW0ubi303qnEk/PZj614w==} dev: true + /html-void-elements@2.0.1: + resolution: {integrity: sha512-0quDb7s97CfemeJAnW9wC0hw78MtW7NU3hqtCD75g2vFlDLt36llsYD7uB7SUzojLMP24N5IatXf7ylGXiGG9A==} + dev: true + /http-cache-semantics@4.1.1: resolution: {integrity: sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==} dev: true @@ -12677,6 +12906,11 @@ packages: resolution: {integrity: sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==} dev: true + /ini@3.0.1: + resolution: {integrity: sha512-it4HyVAUTKBc6m8e1iXWvXSTdndF7HbdN713+kvLrymxTaU4AUBWrJ4vEooP+V7fexnVD3LKcBshjGGPefSMUQ==} + engines: {node: ^12.13.0 || ^14.15.0 || >=16.0.0} + dev: true + /init-package-json@5.0.0: resolution: {integrity: sha512-kBhlSheBfYmq3e0L1ii+VKe3zBTLL5lDCDWR+f9dLmEGSB3MqLlMlsolubSsyI88Bg6EA+BIMlomAnQ1SwgQBw==} engines: {node: ^14.17.0 || ^16.13.0 || >=18.0.0} @@ -13351,10 +13585,15 @@ packages: engines: {node: '>=0.10.0'} dev: true + /kleur@4.1.5: + resolution: {integrity: sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==} + engines: {node: '>=6'} + dev: true + /konan@2.1.1: resolution: {integrity: sha512-7ZhYV84UzJ0PR/RJnnsMZcAbn+kLasJhVNWsu8ZyVEJYRpGA5XESQ9d/7zOa08U0Ou4cmB++hMNY/3OSV9KIbg==} dependencies: - '@babel/parser': 7.12.3 + '@babel/parser': 7.23.5 '@babel/traverse': 7.23.5 transitivePeerDependencies: - supports-color @@ -13682,6 +13921,10 @@ packages: resolution: {integrity: sha512-vM6rUVCVUJJt33bnmHiZEvr7wPT78ztX7rojL+LW51bHtLh6HTjx84LA5W4+oa6aKEJA7jJu5LR6vQRBpA5DVg==} dev: true + /longest-streak@3.1.0: + resolution: {integrity: sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==} + dev: true + /lru-cache@10.1.0: resolution: {integrity: sha512-/1clY/ui8CzjKFyjdvwPWJUYKiFVXG2I2cY0ssG7h4+hwk+XOIX7ZSG9Q7TW8TW3Kp3BUSqgFWBLgL4PJ+Blag==} engines: {node: 14 || >=16.14} @@ -13807,6 +14050,10 @@ packages: repeat-string: 1.6.1 dev: true + /markdown-table@3.0.3: + resolution: {integrity: sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==} + dev: true + /matrix-to-grid@4.0.0: resolution: {integrity: sha512-0JukXYrNe55LsmZFex/rp4ZUkZNeVJtMLPXxJb4SwpOhIVML3nOLHUeg2HaRDyqc0j7O4b+GZuEeJQF2GcJ5Lw==} dependencies: @@ -13820,6 +14067,14 @@ packages: unist-util-visit: 2.0.3 dev: true + /mdast-util-definitions@5.1.2: + resolution: {integrity: sha512-8SVPMuHqlPME/z3gqVwWY4zVXn8lqKv/pAhC57FuJ40ImXyBpmO5ukh98zB2v7Blql2FiHjHv9LVztSIqjY+MA==} + dependencies: + '@types/mdast': 3.0.15 + '@types/unist': 2.0.10 + unist-util-visit: 4.1.2 + dev: true + /mdast-util-find-and-replace@1.1.1: resolution: {integrity: sha512-9cKl33Y21lyckGzpSmEQnIDjEfeeWelN5s1kUW1LwdB0Fkuq2u+4GdqcGEygYxJE8GVqCl0741bYXHgamfWAZA==} dependencies: @@ -13828,6 +14083,15 @@ packages: unist-util-visit-parents: 3.1.1 dev: true + /mdast-util-find-and-replace@2.2.2: + resolution: {integrity: sha512-MTtdFRz/eMDHXzeK6W3dO7mXUlF82Gom4y0oOgvHhh/HXZAGvIQDUvQ0SuUx+j2tv44b8xTHOm8K/9OoRFnXKw==} + dependencies: + '@types/mdast': 3.0.15 + escape-string-regexp: 5.0.0 + unist-util-is: 5.2.1 + unist-util-visit-parents: 5.1.3 + dev: true + /mdast-util-from-markdown@0.8.5: resolution: {integrity: sha512-2hkTXtYYnr+NubD/g6KGBS/0mFmBcifAsI0yIWRiRo0PjVs6SSOSOdtzbp6kSGnShDN6G5aWZpKQ2lWRy27mWQ==} dependencies: @@ -13840,6 +14104,25 @@ packages: - supports-color dev: true + /mdast-util-from-markdown@1.3.1: + resolution: {integrity: sha512-4xTO/M8c82qBcnQc1tgpNtubGUW/Y1tBQ1B0i5CtSoelOLKFYlElIr3bvgREYYO5iRqbMY1YuqZng0GVOI8Qww==} + dependencies: + '@types/mdast': 3.0.15 + '@types/unist': 2.0.10 + decode-named-character-reference: 1.0.2 + mdast-util-to-string: 3.2.0 + micromark: 3.2.0 + micromark-util-decode-numeric-character-reference: 1.1.0 + micromark-util-decode-string: 1.1.0 + micromark-util-normalize-identifier: 1.1.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + unist-util-stringify-position: 3.0.3 + uvu: 0.5.6 + transitivePeerDependencies: + - supports-color + dev: true + /mdast-util-gfm-autolink-literal@0.1.3: resolution: {integrity: sha512-GjmLjWrXg1wqMIO9+ZsRik/s7PLwTaeCHVB7vRxUwLntZc8mzmTsLVr6HW1yLokcnhfURsn5zmSVdi3/xWWu1A==} dependencies: @@ -13850,12 +14133,36 @@ packages: - supports-color dev: true + /mdast-util-gfm-autolink-literal@1.0.3: + resolution: {integrity: sha512-My8KJ57FYEy2W2LyNom4n3E7hKTuQk/0SES0u16tjA9Z3oFkF4RrC/hPAPgjlSpezsOvI8ObcXcElo92wn5IGA==} + dependencies: + '@types/mdast': 3.0.15 + ccount: 2.0.1 + mdast-util-find-and-replace: 2.2.2 + micromark-util-character: 1.2.0 + dev: true + + /mdast-util-gfm-footnote@1.0.2: + resolution: {integrity: sha512-56D19KOGbE00uKVj3sgIykpwKL179QsVFwx/DCW0u/0+URsryacI4MAdNJl0dh+u2PSsD9FtxPFbHCzJ78qJFQ==} + dependencies: + '@types/mdast': 3.0.15 + mdast-util-to-markdown: 1.5.0 + micromark-util-normalize-identifier: 1.1.0 + dev: true + /mdast-util-gfm-strikethrough@0.2.3: resolution: {integrity: sha512-5OQLXpt6qdbttcDG/UxYY7Yjj3e8P7X16LzvpX8pIQPYJ/C2Z1qFGMmcw+1PZMUM3Z8wt8NRfYTvCni93mgsgA==} dependencies: mdast-util-to-markdown: 0.6.5 dev: true + /mdast-util-gfm-strikethrough@1.0.3: + resolution: {integrity: sha512-DAPhYzTYrRcXdMjUtUjKvW9z/FNAMTdU0ORyMcbmkwYNbKocDpdk+PX1L1dQgOID/+vVs1uBQ7ElrBQfZ0cuiQ==} + dependencies: + '@types/mdast': 3.0.15 + mdast-util-to-markdown: 1.5.0 + dev: true + /mdast-util-gfm-table@0.1.6: resolution: {integrity: sha512-j4yDxQ66AJSBwGkbpFEp9uG/LS1tZV3P33fN1gkyRB2LoRL+RR3f76m0HPHaby6F4Z5xr9Fv1URmATlRRUIpRQ==} dependencies: @@ -13863,12 +14170,30 @@ packages: mdast-util-to-markdown: 0.6.5 dev: true + /mdast-util-gfm-table@1.0.7: + resolution: {integrity: sha512-jjcpmNnQvrmN5Vx7y7lEc2iIOEytYv7rTvu+MeyAsSHTASGCCRA79Igg2uKssgOs1i1po8s3plW0sTu1wkkLGg==} + dependencies: + '@types/mdast': 3.0.15 + markdown-table: 3.0.3 + mdast-util-from-markdown: 1.3.1 + mdast-util-to-markdown: 1.5.0 + transitivePeerDependencies: + - supports-color + dev: true + /mdast-util-gfm-task-list-item@0.1.6: resolution: {integrity: sha512-/d51FFIfPsSmCIRNp7E6pozM9z1GYPIkSy1urQ8s/o4TC22BZ7DqfHFWiqBD23bc7J3vV1Fc9O4QIHBlfuit8A==} dependencies: mdast-util-to-markdown: 0.6.5 dev: true + /mdast-util-gfm-task-list-item@1.0.2: + resolution: {integrity: sha512-PFTA1gzfp1B1UaiJVyhJZA1rm0+Tzn690frc/L8vNX1Jop4STZgOE6bxUhnzdVSB+vm2GU1tIsuQcA9bxTQpMQ==} + dependencies: + '@types/mdast': 3.0.15 + mdast-util-to-markdown: 1.5.0 + dev: true + /mdast-util-gfm@0.1.2: resolution: {integrity: sha512-NNkhDx/qYcuOWB7xHUGWZYVXvjPFFd6afg6/e2g+SV4r9q5XUcCbV4Wfa3DLYIiD+xAEZc6K4MGaE/m0KDcPwQ==} dependencies: @@ -13881,12 +14206,33 @@ packages: - supports-color dev: true + /mdast-util-gfm@2.0.2: + resolution: {integrity: sha512-qvZ608nBppZ4icQlhQQIAdc6S3Ffj9RGmzwUKUWuEICFnd1LVkN3EktF7ZHAgfcEdvZB5owU9tQgt99e2TlLjg==} + dependencies: + mdast-util-from-markdown: 1.3.1 + mdast-util-gfm-autolink-literal: 1.0.3 + mdast-util-gfm-footnote: 1.0.2 + mdast-util-gfm-strikethrough: 1.0.3 + mdast-util-gfm-table: 1.0.7 + mdast-util-gfm-task-list-item: 1.0.2 + mdast-util-to-markdown: 1.5.0 + transitivePeerDependencies: + - supports-color + dev: true + /mdast-util-inject@1.1.0: resolution: {integrity: sha512-CcJ0mHa36QYumDKiZ2OIR+ClhfOM7zIzN+Wfy8tRZ1hpH9DKLCS+Mh4DyK5bCxzE9uxMWcbIpeNFWsg1zrj/2g==} dependencies: mdast-util-to-string: 1.1.0 dev: true + /mdast-util-phrasing@3.0.1: + resolution: {integrity: sha512-WmI1gTXUBJo4/ZmSk79Wcb2HcjPJBzM1nlI/OUWA8yk2X9ik3ffNbBGsU+09BFmXaL1IBb9fiuvq6/KMiNycSg==} + dependencies: + '@types/mdast': 3.0.15 + unist-util-is: 5.2.1 + dev: true + /mdast-util-to-hast@10.2.0: resolution: {integrity: sha512-JoPBfJ3gBnHZ18icCwHR50orC9kNH81tiR1gs01D8Q5YpV6adHNO9nKNuFBCJQ941/32PT1a63UF/DitmS3amQ==} dependencies: @@ -13900,6 +14246,19 @@ packages: unist-util-visit: 2.0.3 dev: true + /mdast-util-to-hast@12.3.0: + resolution: {integrity: sha512-pits93r8PhnIoU4Vy9bjW39M2jJ6/tdHyja9rrot9uujkN7UTU9SDnE6WNJz/IGyQk3XHX6yNNtrBH6cQzm8Hw==} + dependencies: + '@types/hast': 2.3.10 + '@types/mdast': 3.0.15 + mdast-util-definitions: 5.1.2 + micromark-util-sanitize-uri: 1.2.0 + trim-lines: 3.0.1 + unist-util-generated: 2.0.1 + unist-util-position: 4.0.4 + unist-util-visit: 4.1.2 + dev: true + /mdast-util-to-markdown@0.6.5: resolution: {integrity: sha512-XeV9sDE7ZlOQvs45C9UKMtfTcctcaj/pGwH8YLbMHoMOXNNCn2LsqVQOqrF1+/NU8lKDAqozme9SCXWyo9oAcQ==} dependencies: @@ -13911,6 +14270,19 @@ packages: zwitch: 1.0.5 dev: true + /mdast-util-to-markdown@1.5.0: + resolution: {integrity: sha512-bbv7TPv/WC49thZPg3jXuqzuvI45IL2EVAr/KxF0BSdHsU0ceFHOmwQn6evxAh1GaoK/6GQ1wp4R4oW2+LFL/A==} + dependencies: + '@types/mdast': 3.0.15 + '@types/unist': 2.0.10 + longest-streak: 3.1.0 + mdast-util-phrasing: 3.0.1 + mdast-util-to-string: 3.2.0 + micromark-util-decode-string: 1.1.0 + unist-util-visit: 4.1.2 + zwitch: 2.0.4 + dev: true + /mdast-util-to-string@1.1.0: resolution: {integrity: sha512-jVU0Nr2B9X3MU4tSK7JP1CMkSvOj7X5l/GboG1tKRw52lLF1x2Ju92Ms9tNetCcbfX3hzlM73zYo2NKkWSfF/A==} dev: true @@ -13919,6 +14291,12 @@ packages: resolution: {integrity: sha512-AW4DRS3QbBayY/jJmD8437V1Gombjf8RSOUCMFBuo5iHi58AGEgVCKQ+ezHkZZDpAQS75hcBMpLqjpJTjtUL7w==} dev: true + /mdast-util-to-string@3.2.0: + resolution: {integrity: sha512-V4Zn/ncyN1QNSqSBxTrMOLpjr+IKdHl2v3KVLoWmDPscP4r9GcCi71gjgvUV1SFSKh92AjAG4peFuBl2/YgCJg==} + dependencies: + '@types/mdast': 3.0.15 + dev: true + /mdast-util-toc@5.1.0: resolution: {integrity: sha512-csimbRIVkiqc+PpFeKDGQ/Ck2N4f9FYH3zzBMMJzcxoKL8m+cM0n94xXm0I9eaxHnKdY9n145SGTdyJC7i273g==} dependencies: @@ -13931,6 +14309,18 @@ packages: unist-util-visit: 2.0.3 dev: true + /mdast-util-toc@6.1.1: + resolution: {integrity: sha512-Er21728Kow8hehecK2GZtb7Ny3omcoPUVrmObiSUwmoRYVZaXLR751QROEFjR8W/vAQdHMLj49Lz20J55XaNpw==} + dependencies: + '@types/extend': 3.0.4 + '@types/mdast': 3.0.15 + extend: 3.0.2 + github-slugger: 2.0.0 + mdast-util-to-string: 3.2.0 + unist-util-is: 5.2.1 + unist-util-visit: 4.1.2 + dev: true + /mdurl@1.0.1: resolution: {integrity: sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==} dev: true @@ -13975,6 +14365,27 @@ packages: resolution: {integrity: sha512-awNbTOqCxK1DBGjalK3xqWIstBZgN6fxsMSiXLs9/spqWkF2pAhb2rrYCFSsr1/tT7PhcDGjZndG8SWYn0byYA==} dev: true + /micromark-core-commonmark@1.1.0: + resolution: {integrity: sha512-BgHO1aRbolh2hcrzL2d1La37V0Aoz73ymF8rAcKnohLy93titmv62E0gP8Hrx9PKcKrqCZ1BbLGbP3bEhoXYlw==} + dependencies: + decode-named-character-reference: 1.0.2 + micromark-factory-destination: 1.1.0 + micromark-factory-label: 1.1.0 + micromark-factory-space: 1.1.0 + micromark-factory-title: 1.1.0 + micromark-factory-whitespace: 1.1.0 + micromark-util-character: 1.2.0 + micromark-util-chunked: 1.1.0 + micromark-util-classify-character: 1.1.0 + micromark-util-html-tag-name: 1.2.0 + micromark-util-normalize-identifier: 1.1.0 + micromark-util-resolve-all: 1.1.0 + micromark-util-subtokenize: 1.1.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + uvu: 0.5.6 + dev: true + /micromark-extension-gfm-autolink-literal@0.5.7: resolution: {integrity: sha512-ePiDGH0/lhcngCe8FtH4ARFoxKTUelMp4L7Gg2pujYD5CSMb9PbblnyL+AAMud/SNMyusbS2XDSiPIRcQoNFAw==} dependencies: @@ -13983,6 +14394,28 @@ packages: - supports-color dev: true + /micromark-extension-gfm-autolink-literal@1.0.5: + resolution: {integrity: sha512-z3wJSLrDf8kRDOh2qBtoTRD53vJ+CWIyo7uyZuxf/JAbNJjiHsOpG1y5wxk8drtv3ETAHutCu6N3thkOOgueWg==} + dependencies: + micromark-util-character: 1.2.0 + micromark-util-sanitize-uri: 1.2.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + dev: true + + /micromark-extension-gfm-footnote@1.1.2: + resolution: {integrity: sha512-Yxn7z7SxgyGWRNa4wzf8AhYYWNrwl5q1Z8ii+CSTTIqVkmGZF1CElX2JI8g5yGoM3GAman9/PVCUFUSJ0kB/8Q==} + dependencies: + micromark-core-commonmark: 1.1.0 + micromark-factory-space: 1.1.0 + micromark-util-character: 1.2.0 + micromark-util-normalize-identifier: 1.1.0 + micromark-util-sanitize-uri: 1.2.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + uvu: 0.5.6 + dev: true + /micromark-extension-gfm-strikethrough@0.6.5: resolution: {integrity: sha512-PpOKlgokpQRwUesRwWEp+fHjGGkZEejj83k9gU5iXCbDG+XBA92BqnRKYJdfqfkrRcZRgGuPuXb7DaK/DmxOhw==} dependencies: @@ -13991,6 +14424,17 @@ packages: - supports-color dev: true + /micromark-extension-gfm-strikethrough@1.0.7: + resolution: {integrity: sha512-sX0FawVE1o3abGk3vRjOH50L5TTLr3b5XMqnP9YDRb34M0v5OoZhG+OHFz1OffZ9dlwgpTBKaT4XW/AsUVnSDw==} + dependencies: + micromark-util-chunked: 1.1.0 + micromark-util-classify-character: 1.1.0 + micromark-util-resolve-all: 1.1.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + uvu: 0.5.6 + dev: true + /micromark-extension-gfm-table@0.4.3: resolution: {integrity: sha512-hVGvESPq0fk6ALWtomcwmgLvH8ZSVpcPjzi0AjPclB9FsVRgMtGZkUcpE0zgjOCFAznKepF4z3hX8z6e3HODdA==} dependencies: @@ -13999,10 +14443,26 @@ packages: - supports-color dev: true + /micromark-extension-gfm-table@1.0.7: + resolution: {integrity: sha512-3ZORTHtcSnMQEKtAOsBQ9/oHp9096pI/UvdPtN7ehKvrmZZ2+bbWhi0ln+I9drmwXMt5boocn6OlwQzNXeVeqw==} + dependencies: + micromark-factory-space: 1.1.0 + micromark-util-character: 1.2.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + uvu: 0.5.6 + dev: true + /micromark-extension-gfm-tagfilter@0.3.0: resolution: {integrity: sha512-9GU0xBatryXifL//FJH+tAZ6i240xQuFrSL7mYi8f4oZSbc+NvXjkrHemeYP0+L4ZUT+Ptz3b95zhUZnMtoi/Q==} dev: true + /micromark-extension-gfm-tagfilter@1.0.2: + resolution: {integrity: sha512-5XWB9GbAUSHTn8VPU8/1DBXMuKYT5uOgEjJb8gN3mW0PNW5OPHpSdojoqf+iq1xo7vWzw/P8bAHY0n6ijpXF7g==} + dependencies: + micromark-util-types: 1.1.0 + dev: true + /micromark-extension-gfm-task-list-item@0.3.3: resolution: {integrity: sha512-0zvM5iSLKrc/NQl84pZSjGo66aTGd57C1idmlWmE87lkMcXrTxg1uXa/nXomxJytoje9trP0NDLvw4bZ/Z/XCQ==} dependencies: @@ -14011,6 +14471,16 @@ packages: - supports-color dev: true + /micromark-extension-gfm-task-list-item@1.0.5: + resolution: {integrity: sha512-RMFXl2uQ0pNQy6Lun2YBYT9g9INXtWJULgbt01D/x8/6yJ2qpKyzdZD3pi6UIkzF++Da49xAelVKUeUMqd5eIQ==} + dependencies: + micromark-factory-space: 1.1.0 + micromark-util-character: 1.2.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + uvu: 0.5.6 + dev: true + /micromark-extension-gfm@0.3.3: resolution: {integrity: sha512-oVN4zv5/tAIA+l3GbMi7lWeYpJ14oQyJ3uEim20ktYFAcfX1x3LNlFGGlmrZHt7u9YlKExmyJdDGaTt6cMSR/A==} dependencies: @@ -14024,6 +14494,149 @@ packages: - supports-color dev: true + /micromark-extension-gfm@2.0.3: + resolution: {integrity: sha512-vb9OoHqrhCmbRidQv/2+Bc6pkP0FrtlhurxZofvOEy5o8RtuuvTq+RQ1Vw5ZDNrVraQZu3HixESqbG+0iKk/MQ==} + dependencies: + micromark-extension-gfm-autolink-literal: 1.0.5 + micromark-extension-gfm-footnote: 1.1.2 + micromark-extension-gfm-strikethrough: 1.0.7 + micromark-extension-gfm-table: 1.0.7 + micromark-extension-gfm-tagfilter: 1.0.2 + micromark-extension-gfm-task-list-item: 1.0.5 + micromark-util-combine-extensions: 1.1.0 + micromark-util-types: 1.1.0 + dev: true + + /micromark-factory-destination@1.1.0: + resolution: {integrity: sha512-XaNDROBgx9SgSChd69pjiGKbV+nfHGDPVYFs5dOoDd7ZnMAE+Cuu91BCpsY8RT2NP9vo/B8pds2VQNCLiu0zhg==} + dependencies: + micromark-util-character: 1.2.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + dev: true + + /micromark-factory-label@1.1.0: + resolution: {integrity: sha512-OLtyez4vZo/1NjxGhcpDSbHQ+m0IIGnT8BoPamh+7jVlzLJBH98zzuCoUeMxvM6WsNeh8wx8cKvqLiPHEACn0w==} + dependencies: + micromark-util-character: 1.2.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + uvu: 0.5.6 + dev: true + + /micromark-factory-space@1.1.0: + resolution: {integrity: sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ==} + dependencies: + micromark-util-character: 1.2.0 + micromark-util-types: 1.1.0 + dev: true + + /micromark-factory-title@1.1.0: + resolution: {integrity: sha512-J7n9R3vMmgjDOCY8NPw55jiyaQnH5kBdV2/UXCtZIpnHH3P6nHUKaH7XXEYuWwx/xUJcawa8plLBEjMPU24HzQ==} + dependencies: + micromark-factory-space: 1.1.0 + micromark-util-character: 1.2.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + dev: true + + /micromark-factory-whitespace@1.1.0: + resolution: {integrity: sha512-v2WlmiymVSp5oMg+1Q0N1Lxmt6pMhIHD457whWM7/GUlEks1hI9xj5w3zbc4uuMKXGisksZk8DzP2UyGbGqNsQ==} + dependencies: + micromark-factory-space: 1.1.0 + micromark-util-character: 1.2.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + dev: true + + /micromark-util-character@1.2.0: + resolution: {integrity: sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg==} + dependencies: + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + dev: true + + /micromark-util-chunked@1.1.0: + resolution: {integrity: sha512-Ye01HXpkZPNcV6FiyoW2fGZDUw4Yc7vT0E9Sad83+bEDiCJ1uXu0S3mr8WLpsz3HaG3x2q0HM6CTuPdcZcluFQ==} + dependencies: + micromark-util-symbol: 1.1.0 + dev: true + + /micromark-util-classify-character@1.1.0: + resolution: {integrity: sha512-SL0wLxtKSnklKSUplok1WQFoGhUdWYKggKUiqhX+Swala+BtptGCu5iPRc+xvzJ4PXE/hwM3FNXsfEVgoZsWbw==} + dependencies: + micromark-util-character: 1.2.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + dev: true + + /micromark-util-combine-extensions@1.1.0: + resolution: {integrity: sha512-Q20sp4mfNf9yEqDL50WwuWZHUrCO4fEyeDCnMGmG5Pr0Cz15Uo7KBs6jq+dq0EgX4DPwwrh9m0X+zPV1ypFvUA==} + dependencies: + micromark-util-chunked: 1.1.0 + micromark-util-types: 1.1.0 + dev: true + + /micromark-util-decode-numeric-character-reference@1.1.0: + resolution: {integrity: sha512-m9V0ExGv0jB1OT21mrWcuf4QhP46pH1KkfWy9ZEezqHKAxkj4mPCy3nIH1rkbdMlChLHX531eOrymlwyZIf2iw==} + dependencies: + micromark-util-symbol: 1.1.0 + dev: true + + /micromark-util-decode-string@1.1.0: + resolution: {integrity: sha512-YphLGCK8gM1tG1bd54azwyrQRjCFcmgj2S2GoJDNnh4vYtnL38JS8M4gpxzOPNyHdNEpheyWXCTnnTDY3N+NVQ==} + dependencies: + decode-named-character-reference: 1.0.2 + micromark-util-character: 1.2.0 + micromark-util-decode-numeric-character-reference: 1.1.0 + micromark-util-symbol: 1.1.0 + dev: true + + /micromark-util-encode@1.1.0: + resolution: {integrity: sha512-EuEzTWSTAj9PA5GOAs992GzNh2dGQO52UvAbtSOMvXTxv3Criqb6IOzJUBCmEqrrXSblJIJBbFFv6zPxpreiJw==} + dev: true + + /micromark-util-html-tag-name@1.2.0: + resolution: {integrity: sha512-VTQzcuQgFUD7yYztuQFKXT49KghjtETQ+Wv/zUjGSGBioZnkA4P1XXZPT1FHeJA6RwRXSF47yvJ1tsJdoxwO+Q==} + dev: true + + /micromark-util-normalize-identifier@1.1.0: + resolution: {integrity: sha512-N+w5vhqrBihhjdpM8+5Xsxy71QWqGn7HYNUvch71iV2PM7+E3uWGox1Qp90loa1ephtCxG2ftRV/Conitc6P2Q==} + dependencies: + micromark-util-symbol: 1.1.0 + dev: true + + /micromark-util-resolve-all@1.1.0: + resolution: {integrity: sha512-b/G6BTMSg+bX+xVCshPTPyAu2tmA0E4X98NSR7eIbeC6ycCqCeE7wjfDIgzEbkzdEVJXRtOG4FbEm/uGbCRouA==} + dependencies: + micromark-util-types: 1.1.0 + dev: true + + /micromark-util-sanitize-uri@1.2.0: + resolution: {integrity: sha512-QO4GXv0XZfWey4pYFndLUKEAktKkG5kZTdUNaTAkzbuJxn2tNBOr+QtxR2XpWaMhbImT2dPzyLrPXLlPhph34A==} + dependencies: + micromark-util-character: 1.2.0 + micromark-util-encode: 1.1.0 + micromark-util-symbol: 1.1.0 + dev: true + + /micromark-util-subtokenize@1.1.0: + resolution: {integrity: sha512-kUQHyzRoxvZO2PuLzMt2P/dwVsTiivCK8icYTeR+3WgbuPqfHgPPy7nFKbeqRivBvn/3N3GBiNC+JRTMSxEC7A==} + dependencies: + micromark-util-chunked: 1.1.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + uvu: 0.5.6 + dev: true + + /micromark-util-symbol@1.1.0: + resolution: {integrity: sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag==} + dev: true + + /micromark-util-types@1.1.0: + resolution: {integrity: sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==} + dev: true + /micromark@2.11.4: resolution: {integrity: sha512-+WoovN/ppKolQOFIAajxi7Lu9kInbPxFuTBVEavFcL8eAfVstoc5MocPmqBeAdBOJV00uaVjegzH4+MA0DN/uA==} dependencies: @@ -14033,6 +14646,30 @@ packages: - supports-color dev: true + /micromark@3.2.0: + resolution: {integrity: sha512-uD66tJj54JLYq0De10AhWycZWGQNUvDI55xPgk2sQM5kn1JYlhbCMTtEeT27+vAhW2FBQxLlOmS3pmA7/2z4aA==} + dependencies: + '@types/debug': 4.1.12 + debug: 4.3.4 + decode-named-character-reference: 1.0.2 + micromark-core-commonmark: 1.1.0 + micromark-factory-space: 1.1.0 + micromark-util-character: 1.2.0 + micromark-util-chunked: 1.1.0 + micromark-util-combine-extensions: 1.1.0 + micromark-util-decode-numeric-character-reference: 1.1.0 + micromark-util-encode: 1.1.0 + micromark-util-normalize-identifier: 1.1.0 + micromark-util-resolve-all: 1.1.0 + micromark-util-sanitize-uri: 1.2.0 + micromark-util-subtokenize: 1.1.0 + micromark-util-symbol: 1.1.0 + micromark-util-types: 1.1.0 + uvu: 0.5.6 + transitivePeerDependencies: + - supports-color + dev: true + /micromatch@3.1.10: resolution: {integrity: sha512-MWikgl9n9M3w+bpsY3He8L+w9eF9338xRl8IAO5viDizwSzziFEyUzo2xrrloB64ADbTf8uA8vRqqttDTOmccg==} engines: {node: '>=0.10.0'} @@ -14316,6 +14953,11 @@ packages: - supports-color dev: true + /mri@1.2.0: + resolution: {integrity: sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA==} + engines: {node: '>=4'} + dev: true + /ms@2.0.0: resolution: {integrity: sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==} dev: true @@ -15124,6 +15766,10 @@ packages: parse-path: 7.0.0 dev: true + /parse5@6.0.1: + resolution: {integrity: sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==} + dev: true + /pascalcase@0.1.1: resolution: {integrity: sha512-XHXfu/yOQRy9vYOtUDVMN60OEJjW013GoObG1o+xwQTpB9eYJX/BjXMsdW13ZDPruFhYYn0AG22w0xgQMwl3Nw==} engines: {node: '>=0.10.0'} @@ -15244,6 +15890,11 @@ packages: engines: {node: '>=10'} dev: true + /pify@6.1.0: + resolution: {integrity: sha512-KocF8ve28eFjjuBKKGvzOBGzG8ew2OqOOSxTTZhirkzH7h3BI1vyzqlR0qbfcDBve1Yzo3FVlWUAtCRrbVN8Fw==} + engines: {node: '>=14.16'} + dev: true + /pirates@4.0.6: resolution: {integrity: sha512-saLsH7WeYYPiD25LDuLRRY/i+6HaPYr6G1OUlN39otzkSTxKnubR9RTxS3/Kk50s1g2JTgFwWQDQyplC5/SHZg==} engines: {node: '>= 6'} @@ -15284,22 +15935,6 @@ packages: engines: {node: '>=0.10.0'} dev: true - /postcss-load-config@4.0.2: - resolution: {integrity: sha512-bSVhyJGL00wMVoPUzAVAnbEoWyqRxkjv64tUl427SKnPrENtq6hJwUojroMz2VB+Q1edmi4IfrAPpami5VVgMQ==} - engines: {node: '>= 14'} - peerDependencies: - postcss: '>=8.0.9' - ts-node: '>=9.0.0' - peerDependenciesMeta: - postcss: - optional: true - ts-node: - optional: true - dependencies: - lilconfig: 3.0.0 - yaml: 2.3.4 - dev: true - /postcss-load-config@4.0.2(ts-node@9.1.1): resolution: {integrity: sha512-bSVhyJGL00wMVoPUzAVAnbEoWyqRxkjv64tUl427SKnPrENtq6hJwUojroMz2VB+Q1edmi4IfrAPpami5VVgMQ==} engines: {node: '>= 14'} @@ -15445,6 +16080,10 @@ packages: xtend: 4.0.2 dev: true + /property-information@6.5.0: + resolution: {integrity: sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig==} + dev: true + /protocols@1.4.8: resolution: {integrity: sha512-IgjKyaUSjsROSO8/D49Ab7hP8mJgTYcqApOqdPhLoPxAplXmkp+zRvsrSQjFn5by0rhm4VH0GAUELIPpx7B1yg==} dev: true @@ -15616,6 +16255,15 @@ packages: type-fest: 0.8.1 dev: true + /read-pkg-up@9.1.0: + resolution: {integrity: sha512-vaMRR1AC1nrd5CQM0PhlRsO5oc2AAigqr7cCrZ/MW/Rsaflz4RlgzkpL4qoU/z1F6wrbd85iFv1OQj/y5RdGvg==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + dependencies: + find-up: 6.3.0 + read-pkg: 7.1.0 + type-fest: 2.19.0 + dev: true + /read-pkg@3.0.0: resolution: {integrity: sha512-BLq/cCO9two+lBgiTYNqD6GdtK8s4NpaWrl6/rCO9w0TUS8oJl7cmToOZfRYllKTISY6nt1U7jQ53brmKqY6BA==} engines: {node: '>=4'} @@ -15635,6 +16283,16 @@ packages: type-fest: 0.6.0 dev: true + /read-pkg@7.1.0: + resolution: {integrity: sha512-5iOehe+WF75IccPc30bWTbpdDQLOCc3Uu8bi3Dte3Eueij81yx1Mrufk8qBx/YAbR4uL1FdUr+7BKXDwEtisXg==} + engines: {node: '>=12.20'} + dependencies: + '@types/normalize-package-data': 2.4.4 + normalize-package-data: 3.0.3 + parse-json: 5.2.0 + type-fest: 2.19.0 + dev: true + /read-yaml-file@2.1.0: resolution: {integrity: sha512-UkRNRIwnhG+y7hpqnycCL/xbTk7+ia9VuVTC0S+zVbwd65DI9eUpRMfsWIGrCWxTU/mi+JW8cHQCrv+zfCbEPQ==} engines: {node: '>=10.13'} @@ -15775,6 +16433,17 @@ packages: - supports-color dev: true + /remark-gfm@3.0.1: + resolution: {integrity: sha512-lEFDoi2PICJyNrACFOfDD3JlLkuSbOa5Wd8EPt06HUdptv8Gn0bxYTdbU/XXQ3swAPkEaGxxPN9cbnMHvVu1Ig==} + dependencies: + '@types/mdast': 3.0.15 + mdast-util-gfm: 2.0.2 + micromark-extension-gfm: 2.0.3 + unified: 10.1.2 + transitivePeerDependencies: + - supports-color + dev: true + /remark-html@13.0.2: resolution: {integrity: sha512-LhSRQ+3RKdBqB/RGesFWkNNfkGqprDUCwjq54SylfFeNyZby5kqOG8Dn/vYsRoM8htab6EWxFXCY6XIZvMoRiQ==} dependencies: @@ -15783,6 +16452,26 @@ packages: mdast-util-to-hast: 10.2.0 dev: true + /remark-html@15.0.2: + resolution: {integrity: sha512-/CIOI7wzHJzsh48AiuIyIe1clxVkUtreul73zcCXLub0FmnevQE0UMFDQm7NUx8/3rl/4zCshlMfqBdWScQthw==} + dependencies: + '@types/mdast': 3.0.15 + hast-util-sanitize: 4.1.0 + hast-util-to-html: 8.0.4 + mdast-util-to-hast: 12.3.0 + unified: 10.1.2 + dev: true + + /remark-parse@10.0.2: + resolution: {integrity: sha512-3ydxgHa/ZQzG8LvC7jTXccARYDcRld3VfcgIIFs7bI6vbRSxJJmzgLEIIoYKyrfhaY+ujuWaf/PJiMZXoiCXgw==} + dependencies: + '@types/mdast': 3.0.15 + mdast-util-from-markdown: 1.3.1 + unified: 10.1.2 + transitivePeerDependencies: + - supports-color + dev: true + /remark-parse@9.0.0: resolution: {integrity: sha512-geKatMwSzEXKHuzBNU1z676sGcDcFoChMK38TgdHJNAYfFtsfHDQG7MoJAjs6sgYMqyLduCYWDIWZIxiPeafEw==} dependencies: @@ -15797,6 +16486,22 @@ packages: unist-util-visit: 2.0.3 dev: true + /remark-reference-links@6.0.1: + resolution: {integrity: sha512-34wY2C6HXSuKVTRtyJJwefkUD8zBOZOSHFZ4aSTnU2F656gr9WeuQ2dL6IJDK3NPd2F6xKF2t4XXcQY9MygAXg==} + dependencies: + '@types/mdast': 3.0.15 + unified: 10.1.2 + unist-util-visit: 4.1.2 + dev: true + + /remark-stringify@10.0.3: + resolution: {integrity: sha512-koyOzCMYoUHudypbj4XpnAKFbkddRMYZHwghnxd7ue5210WzGw6kOBwauJTRUMq16jsovXx8dYNvSSWP89kZ3A==} + dependencies: + '@types/mdast': 3.0.15 + mdast-util-to-markdown: 1.5.0 + unified: 10.1.2 + dev: true + /remark-stringify@9.0.1: resolution: {integrity: sha512-mWmNg3ZtESvZS8fv5PTvaPckdL4iNlCHTt8/e/8oN08nArHRHjNZMKzA/YW3+p7/lYqIw4nx1XsjCBo/AxNChg==} dependencies: @@ -15810,6 +16515,14 @@ packages: mdast-util-toc: 5.1.0 dev: true + /remark-toc@8.0.1: + resolution: {integrity: sha512-7he2VOm/cy13zilnOTZcyAoyoolV26ULlon6XyCFU+vG54Z/LWJnwphj/xKIDLOt66QmJUgTyUvLVHi2aAElyg==} + dependencies: + '@types/mdast': 3.0.15 + mdast-util-toc: 6.1.1 + unified: 10.1.2 + dev: true + /remark@13.0.0: resolution: {integrity: sha512-HDz1+IKGtOyWN+QgBiAT0kn+2s6ovOxHyPAFGKVE81VSzJ+mq7RwHFledEvB5F1p4iJvOah/LOKdFuzvRnNLCA==} dependencies: @@ -15820,6 +16533,17 @@ packages: - supports-color dev: true + /remark@14.0.3: + resolution: {integrity: sha512-bfmJW1dmR2LvaMJuAnE88pZP9DktIFYXazkTfOIKZzi3Knk9lT0roItIA24ydOucI3bV/g/tXBA6hzqq3FV9Ew==} + dependencies: + '@types/mdast': 3.0.15 + remark-parse: 10.0.2 + remark-stringify: 10.0.3 + unified: 10.1.2 + transitivePeerDependencies: + - supports-color + dev: true + /remove-bom-buffer@3.0.0: resolution: {integrity: sha512-8v2rWhaakv18qcvNeli2mZ/TMTL2nEyAKRvzo1WtnZBl15SHyEhrCu2/xKlJyUFKHiHgfXIyuY6g2dObJJycXQ==} engines: {node: '>=0.10.0'} @@ -16057,6 +16781,13 @@ packages: tslib: 2.6.2 dev: true + /sade@1.8.1: + resolution: {integrity: sha512-xal3CZX1Xlo/k4ApwCFrHVACi9fBqJ7V+mwhBsuf/1IOKbBy098Fex+Wa/5QMubw09pSZ/u8EY8PWgevJsXp1A==} + engines: {node: '>=6'} + dependencies: + mri: 1.2.0 + dev: true + /safe-array-concat@1.0.1: resolution: {integrity: sha512-6XbUAseYE2KtOuGueyeobCySj9L4+66Tn6KQMOPQJrAJEowYKW/YR/MGJZl7FdydUdaFu4LYyDZjxf4/Nmo23Q==} engines: {node: '>=0.4'} @@ -16431,6 +17162,10 @@ packages: resolution: {integrity: sha512-q/JSVd1Lptzhf5bkYm4ob4iWPjx0KiRe3sRFBNrVqbJkFaBm5vbbowy1mymoPNLRa52+oadOhJ+K49wsSeSjTA==} dev: true + /space-separated-tokens@2.0.2: + resolution: {integrity: sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==} + dev: true + /spdx-correct@3.2.0: resolution: {integrity: sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==} dependencies: @@ -16647,6 +17382,13 @@ packages: xtend: 4.0.2 dev: true + /stringify-entities@4.0.4: + resolution: {integrity: sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==} + dependencies: + character-entities-html4: 2.1.0 + character-entities-legacy: 3.0.0 + dev: true + /stringify-object@3.3.0: resolution: {integrity: sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==} engines: {node: '>=4'} @@ -16716,6 +17458,11 @@ packages: engines: {node: '>=8'} dev: true + /strip-json-comments@5.0.1: + resolution: {integrity: sha512-0fk9zBqO67Nq5M/m45qHCJxylV/DhBlIOVExqgOMiCCrzrhU6tCibRXNqE3jwJLftzE9SNuZtYbpzcO+i9FiKw==} + engines: {node: '>=14.16'} + dev: true + /strong-log-transformer@2.1.0: resolution: {integrity: sha512-B3Hgul+z0L9a236FAUC9iZsL+nVHgoCJnqCbN588DjYxvGXaXaaFbfmQ/JhvKjZwsOukuR72XbHv71Qkug0HxA==} engines: {node: '>=4'} @@ -16785,6 +17532,11 @@ packages: has-flag: 4.0.0 dev: true + /supports-color@9.4.0: + resolution: {integrity: sha512-VL+lNrEoIXww1coLPOmiEmK/0sGigko5COxI09KzHc2VJXJsQ37UaQ+8quuxjDeA7+KnLGTWRyOXSLLR2Wb4jw==} + engines: {node: '>=12'} + dev: true + /supports-preserve-symlinks-flag@1.0.0: resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==} engines: {node: '>= 0.4'} @@ -17042,6 +17794,10 @@ packages: hasBin: true dev: true + /trim-lines@3.0.1: + resolution: {integrity: sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==} + dev: true + /trim-newlines@3.0.1: resolution: {integrity: sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==} engines: {node: '>=8'} @@ -17056,6 +17812,10 @@ packages: resolution: {integrity: sha512-rvuRbTarPXmMb79SmzEp8aqXNKcK+y0XaB298IXueQ8I2PsrATcPBCSPyK/dDNa2iWOhKlfNnOjdAOTBU/nkFA==} dev: true + /trough@2.2.0: + resolution: {integrity: sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw==} + dev: true + /ts-api-utils@1.0.3(typescript@5.3.3): resolution: {integrity: sha512-wNMeqtMz5NtwpT/UZGY5alT+VoKdSsOOP/kqHFcUW1P/VRhH2wJ48+DN2WwUliNbQ976ETwDL0Ifd2VVvgonvg==} engines: {node: '>=16.13.0'} @@ -17149,45 +17909,6 @@ packages: - ts-node dev: true - /tsup@8.0.1(typescript@5.3.3): - resolution: {integrity: sha512-hvW7gUSG96j53ZTSlT4j/KL0q1Q2l6TqGBFc6/mu/L46IoNWqLLUzLRLP1R8Q7xrJTmkDxxDoojV5uCVs1sVOg==} - engines: {node: '>=18'} - hasBin: true - peerDependencies: - '@microsoft/api-extractor': ^7.36.0 - '@swc/core': ^1 - postcss: ^8.4.12 - typescript: '>=4.5.0' - peerDependenciesMeta: - '@microsoft/api-extractor': - optional: true - '@swc/core': - optional: true - postcss: - optional: true - typescript: - optional: true - dependencies: - bundle-require: 4.0.2(esbuild@0.19.11) - cac: 6.7.14 - chokidar: 3.5.3 - debug: 4.3.4 - esbuild: 0.19.11 - execa: 5.1.1 - globby: 11.1.0 - joycon: 3.1.1 - postcss-load-config: 4.0.2 - resolve-from: 5.0.0 - rollup: 4.9.0 - source-map: 0.8.0-beta.0 - sucrase: 3.34.0 - tree-kill: 1.2.2 - typescript: 5.3.3 - transitivePeerDependencies: - - supports-color - - ts-node - dev: true - /tsutils@3.21.0(typescript@3.9.10): resolution: {integrity: sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==} engines: {node: '>= 6'} @@ -17268,6 +17989,11 @@ packages: engines: {node: '>=8'} dev: true + /type-fest@2.19.0: + resolution: {integrity: sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==} + engines: {node: '>=12.20'} + dev: true + /typed-array-buffer@1.0.0: resolution: {integrity: sha512-Y8KTSIglk9OZEr8zywiIHG/kmQ7KWyjseXs1CbSo8vC42w7hg2HgYTxSWwP0+is7bWDc1H+Fo026CpHFwm8tkw==} engines: {node: '>= 0.4'} @@ -17382,6 +18108,18 @@ packages: engines: {node: '>=18'} dev: true + /unified@10.1.2: + resolution: {integrity: sha512-pUSWAi/RAnVy1Pif2kAoeWNBa3JVrx0MId2LASj8G+7AiHWoKZNTomq6LG326T68U7/e263X6fTdcXIy7XnF7Q==} + dependencies: + '@types/unist': 2.0.10 + bail: 2.0.2 + extend: 3.0.2 + is-buffer: 2.0.5 + is-plain-obj: 4.1.0 + trough: 2.2.0 + vfile: 5.3.7 + dev: true + /unified@9.2.2: resolution: {integrity: sha512-Sg7j110mtefBD+qunSLO1lqOEKdrwBFBrR6Qd8f4uwkhWNlbkaqwHse6e7QvD3AP/MNoJdEDLaf8OxYyoWgorQ==} dependencies: @@ -17433,24 +18171,52 @@ packages: resolution: {integrity: sha512-f98yt5pnlMWlzP539tPc4grGMsFaQQlP/vM396b00jngsiINumNmsY8rkXjfoi1c6QaM8nQ3vaGDuoKWbe/1Uw==} dev: true + /unist-builder@3.0.1: + resolution: {integrity: sha512-gnpOw7DIpCA0vpr6NqdPvTWnlPTApCTRzr+38E6hCWx3rz/cjo83SsKIlS1Z+L5ttScQ2AwutNnb8+tAvpb6qQ==} + dependencies: + '@types/unist': 2.0.10 + dev: true + /unist-util-generated@1.1.6: resolution: {integrity: sha512-cln2Mm1/CZzN5ttGK7vkoGw+RZ8VcUH6BtGbq98DDtRGquAAOXig1mrBQYelOwMXYS8rK+vZDyyojSjp7JX+Lg==} dev: true + /unist-util-generated@2.0.1: + resolution: {integrity: sha512-qF72kLmPxAw0oN2fwpWIqbXAVyEqUzDHMsbtPvOudIlUzXYFIeQIuxXQCRCFh22B7cixvU0MG7m3MW8FTq/S+A==} + dev: true + /unist-util-is@4.1.0: resolution: {integrity: sha512-ZOQSsnce92GrxSqlnEEseX0gi7GH9zTJZ0p9dtu87WRb/37mMPO2Ilx1s/t9vBHrFhbgweUwb+t7cIn5dxPhZg==} dev: true + /unist-util-is@5.2.1: + resolution: {integrity: sha512-u9njyyfEh43npf1M+yGKDGVPbY/JWEemg5nH05ncKPfi+kBbKBJoTdsogMu33uhytuLlv9y0O7GH7fEdwLdLQw==} + dependencies: + '@types/unist': 2.0.10 + dev: true + /unist-util-position@3.1.0: resolution: {integrity: sha512-w+PkwCbYSFw8vpgWD0v7zRCl1FpY3fjDSQ3/N/wNd9Ffa4gPi8+4keqt99N3XW6F99t/mUzp2xAhNmfKWp95QA==} dev: true + /unist-util-position@4.0.4: + resolution: {integrity: sha512-kUBE91efOWfIVBo8xzh/uZQ7p9ffYRtUbMRZBNFYwf0RK8koUMx6dGUfwylLOKmaT2cs4wSW96QoYUSXAyEtpg==} + dependencies: + '@types/unist': 2.0.10 + dev: true + /unist-util-stringify-position@2.0.3: resolution: {integrity: sha512-3faScn5I+hy9VleOq/qNbAd6pAx7iH5jYBMS9I1HgQVijz/4mv5Bvw5iw1sC/90CODiKo81G/ps8AJrISn687g==} dependencies: '@types/unist': 2.0.10 dev: true + /unist-util-stringify-position@3.0.3: + resolution: {integrity: sha512-k5GzIBZ/QatR8N5X2y+drfpWG8IDBzdnVj6OInRNWm1oXrzydiaAT2OQiA8DPRRZyAKb9b6I2a6PxYklZD0gKg==} + dependencies: + '@types/unist': 2.0.10 + dev: true + /unist-util-visit-parents@3.1.1: resolution: {integrity: sha512-1KROIZWo6bcMrZEwiH2UrXDyalAa0uqzWCxCJj6lPOvTve2WkfgCytoDTPaMnodXh1WrXOq0haVYHj99ynJlsg==} dependencies: @@ -17458,6 +18224,13 @@ packages: unist-util-is: 4.1.0 dev: true + /unist-util-visit-parents@5.1.3: + resolution: {integrity: sha512-x6+y8g7wWMyQhL1iZfhIPhDAs7Xwbn9nRosDXl7qoPTSCy0yNxnKc+hWokFifWQIDGi154rdUqKvbCa4+1kLhg==} + dependencies: + '@types/unist': 2.0.10 + unist-util-is: 5.2.1 + dev: true + /unist-util-visit@2.0.3: resolution: {integrity: sha512-iJ4/RczbJMkD0712mGktuGpm/U4By4FfDonL7N/9tATGIF4imikjOuagyMY53tnZq3NP6BcmlrHhEKAfGWjh7Q==} dependencies: @@ -17466,6 +18239,14 @@ packages: unist-util-visit-parents: 3.1.1 dev: true + /unist-util-visit@4.1.2: + resolution: {integrity: sha512-MSd8OUGISqHdVvfY9TPhyK2VdUrPgxkUtWSuMHF6XAAFuL4LokseigBnZtPnJMu+FbynTkFNnFlyjxpVKujMRg==} + dependencies: + '@types/unist': 2.0.10 + unist-util-is: 5.2.1 + unist-util-visit-parents: 5.1.3 + dev: true + /universal-user-agent@6.0.1: resolution: {integrity: sha512-yCzhz6FN2wU1NiiQRogkTQszlQSlpWaw8SvVegAc+bDxbzHgh1vX8uIe8OYyMH6DwH+sdTJsgMl36+mSMdRJIQ==} dev: true @@ -17529,6 +18310,17 @@ packages: hasBin: true dev: true + /uvu@0.5.6: + resolution: {integrity: sha512-+g8ENReyr8YsOc6fv/NVJs2vFdHBnBNdfE49rshrTzDWOlUx4Gq7KOS2GD8eqhy2j+Ejq29+SbKH8yjkAqXqoA==} + engines: {node: '>=8'} + hasBin: true + dependencies: + dequal: 2.0.3 + diff: 5.2.0 + kleur: 4.1.5 + sade: 1.8.1 + dev: true + /validate-npm-package-license@3.0.4: resolution: {integrity: sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==} dependencies: @@ -17554,6 +18346,13 @@ packages: engines: {node: '>= 0.10'} dev: true + /vfile-location@4.1.0: + resolution: {integrity: sha512-YF23YMyASIIJXpktBa4vIGLJ5Gs88UB/XePgqPmTa7cDA+JeO3yclbpheQYCHjVHBn/yePzrXuygIL+xbvRYHw==} + dependencies: + '@types/unist': 2.0.10 + vfile: 5.3.7 + dev: true + /vfile-message@2.0.4: resolution: {integrity: sha512-DjssxRGkMvifUOJre00juHoP9DPWuzjxKuMDrhNbk2TdaYYBNMStsNhEOt3idrtI12VQYM/1+iM0KOzXi4pxwQ==} dependencies: @@ -17561,6 +18360,13 @@ packages: unist-util-stringify-position: 2.0.3 dev: true + /vfile-message@3.1.4: + resolution: {integrity: sha512-fa0Z6P8HUrQN4BZaX05SIVXic+7kE3b05PWAtPuYP9QLHsLKYR7/AlLW3NtOrpXRLeawpDLMsVkmk5DG0NXgWw==} + dependencies: + '@types/unist': 2.0.10 + unist-util-stringify-position: 3.0.3 + dev: true + /vfile-reporter@6.0.2: resolution: {integrity: sha512-GN2bH2gs4eLnw/4jPSgfBjo+XCuvnX9elHICJZjVD4+NM0nsUrMTvdjGY5Sc/XG69XVTgLwj7hknQVc6M9FukA==} dependencies: @@ -17572,14 +18378,41 @@ packages: vfile-statistics: 1.1.4 dev: true + /vfile-reporter@7.0.5: + resolution: {integrity: sha512-NdWWXkv6gcd7AZMvDomlQbK3MqFWL1RlGzMn++/O2TI+68+nqxCPTvLugdOtfSzXmjh+xUyhp07HhlrbJjT+mw==} + dependencies: + '@types/supports-color': 8.1.3 + string-width: 5.1.2 + supports-color: 9.4.0 + unist-util-stringify-position: 3.0.3 + vfile: 5.3.7 + vfile-message: 3.1.4 + vfile-sort: 3.0.1 + vfile-statistics: 2.0.1 + dev: true + /vfile-sort@2.2.2: resolution: {integrity: sha512-tAyUqD2R1l/7Rn7ixdGkhXLD3zsg+XLAeUDUhXearjfIcpL1Hcsj5hHpCoy/gvfK/Ws61+e972fm0F7up7hfYA==} dev: true + /vfile-sort@3.0.1: + resolution: {integrity: sha512-1os1733XY6y0D5x0ugqSeaVJm9lYgj0j5qdcZQFyxlZOSy1jYarL77lLyb5gK4Wqr1d5OxmuyflSO3zKyFnTFw==} + dependencies: + vfile: 5.3.7 + vfile-message: 3.1.4 + dev: true + /vfile-statistics@1.1.4: resolution: {integrity: sha512-lXhElVO0Rq3frgPvFBwahmed3X03vjPF8OcjKMy8+F1xU/3Q3QU3tKEDp743SFtb74PdF0UWpxPvtOP0GCLheA==} dev: true + /vfile-statistics@2.0.1: + resolution: {integrity: sha512-W6dkECZmP32EG/l+dp2jCLdYzmnDBIw6jwiLZSER81oR5AHRcVqL+k3Z+pfH1R73le6ayDkJRMk0sutj1bMVeg==} + dependencies: + vfile: 5.3.7 + vfile-message: 3.1.4 + dev: true + /vfile@4.2.1: resolution: {integrity: sha512-O6AE4OskCG5S1emQ/4gl8zK586RqA3srz3nfK/Viy0UPToBc5Trp9BVFb1u0CjsKrAWwnpr4ifM/KBXPWwJbCA==} dependencies: @@ -17589,6 +18422,15 @@ packages: vfile-message: 2.0.4 dev: true + /vfile@5.3.7: + resolution: {integrity: sha512-r7qlzkgErKjobAmyNIkkSpizsFPYiUPuJb5pNW1RB4JcYVZhs4lIbVqk8XPk033CV/1z8ss5pkax8SuhGpcG8g==} + dependencies: + '@types/unist': 2.0.10 + is-buffer: 2.0.5 + unist-util-stringify-position: 3.0.3 + vfile-message: 3.1.4 + dev: true + /vinyl-fs@3.0.3: resolution: {integrity: sha512-vIu34EkyNyJxmP0jscNzWBSygh7VWhqun6RmqVfXePrOwi9lhvRs//dOaGOTRUQr4tx7/zd26Tk5WeSVZitgng==} engines: {node: '>= 0.10'} @@ -17652,6 +18494,10 @@ packages: defaults: 1.0.4 dev: true + /web-namespaces@2.0.1: + resolution: {integrity: sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ==} + dev: true + /webidl-conversions@3.0.1: resolution: {integrity: sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==} dev: true @@ -18000,3 +18846,7 @@ packages: /zwitch@1.0.5: resolution: {integrity: sha512-V50KMwwzqJV0NpZIZFwfOD5/lyny3WlSzRiXgA0G7VUnRlqttta1L6UQIHzd6EuBY/cHGfwTIck7w1yH6Q5zUw==} dev: true + + /zwitch@2.0.4: + resolution: {integrity: sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==} + dev: true