diff --git a/packages/turf-along/README.md b/packages/turf-along/README.md index 932e62a521..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,36 +34,27 @@ 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 +[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.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/along ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-angle/README.md b/packages/turf-angle/README.md index dbdab3407f..90d49f5904 100644 --- a/packages/turf-angle/README.md +++ b/packages/turf-angle/README.md @@ -34,26 +34,21 @@ Returns **[number][4]** Angle between the provided points, or its explementary. [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/angle ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-area/README.md b/packages/turf-area/README.md index 1fd5318182..aeba55da93 100644 --- a/packages/turf-area/README.md +++ b/packages/turf-area/README.md @@ -28,26 +28,21 @@ Returns **[number][2]** area in square meters [2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/area ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-bbox-clip/README.md b/packages/turf-bbox-clip/README.md index 612dba7e96..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,44 +25,37 @@ 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 +[7]: https://tools.ietf.org/html/rfc7946#section-5 -[8]: https://tools.ietf.org/html/rfc7946#section-5 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/bbox-clip ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-bbox-polygon/README.md b/packages/turf-bbox-polygon/README.md index ab76e842b7..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,28 +39,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/bbox-polygon ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-bbox/README.md b/packages/turf-bbox/README.md index 3db27b65a1..807ed34aa1 100644 --- a/packages/turf-bbox/README.md +++ b/packages/turf-bbox/README.md @@ -35,26 +35,21 @@ Returns **[BBox][4]** bbox extent in \[minX, minY, maxX, maxY] order [4]: https://tools.ietf.org/html/rfc7946#section-5 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/bbox ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-bearing/README.md b/packages/turf-bearing/README.md index 52e870b63e..3be05a6590 100644 --- a/packages/turf-bearing/README.md +++ b/packages/turf-bearing/README.md @@ -42,26 +42,21 @@ Returns **[number][5]** bearing in decimal degrees, between -180 and 180 degrees [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/bearing ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-bezier-spline/README.md b/packages/turf-bezier-spline/README.md index 7e8b24c3e0..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,32 +48,25 @@ 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 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/bezier-spline ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-clockwise/README.md b/packages/turf-boolean-clockwise/README.md index 03be0903f4..8bbecfd8be 100755 --- a/packages/turf-boolean-clockwise/README.md +++ b/packages/turf-boolean-clockwise/README.md @@ -34,26 +34,21 @@ Returns **[boolean][5]** true/false [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-clockwise ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-concave/README.md b/packages/turf-boolean-concave/README.md index 1cfdc46f17..b2a41f40ae 100644 --- a/packages/turf-boolean-concave/README.md +++ b/packages/turf-boolean-concave/README.md @@ -27,26 +27,21 @@ Returns **[boolean][3]** true/false [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-concave ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-contains/README.md b/packages/turf-boolean-contains/README.md index e0cc33bf71..cffaf92905 100644 --- a/packages/turf-boolean-contains/README.md +++ b/packages/turf-boolean-contains/README.md @@ -32,26 +32,21 @@ Returns **[boolean][3]** true/false [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-contains ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-crosses/README.md b/packages/turf-boolean-crosses/README.md index 09ba9f361e..f7350b6944 100644 --- a/packages/turf-boolean-crosses/README.md +++ b/packages/turf-boolean-crosses/README.md @@ -34,26 +34,21 @@ Returns **[boolean][3]** true/false [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-crosses ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-disjoint/README.md b/packages/turf-boolean-disjoint/README.md index 99dab9d9d0..6247dba534 100644 --- a/packages/turf-boolean-disjoint/README.md +++ b/packages/turf-boolean-disjoint/README.md @@ -29,26 +29,21 @@ Returns **[boolean][3]** true/false [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-disjoint ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-equal/README.md b/packages/turf-boolean-equal/README.md index 63bfab9783..912a42388c 100644 --- a/packages/turf-boolean-equal/README.md +++ b/packages/turf-boolean-equal/README.md @@ -4,8 +4,8 @@ ## booleanEqual -Determines whether two geometries or features of the same type have identical X,Y coordinate values and properties. -See [http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relations.htm][1] +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] ### Parameters @@ -21,17 +21,11 @@ See [http://edndoc.esri.com/arcsde/9.0/general_topics/understand_spatial_relatio var pt1 = turf.point([0, 0]); var pt2 = turf.point([0, 0]); var pt3 = turf.point([1, 1]); -var pt4 = turf.point([0, 0], {prop: 'A'}); -var pt5 = turf.point([0, 0], {prop: 'B'}); turf.booleanEqual(pt1, pt2); //= true turf.booleanEqual(pt2, pt3); //= false -turf.booleanEqual(pt4, pt5); -//= false -turf.booleanEqual(pt4.geometry, pt5.geometry); -//= true ``` Returns **[boolean][6]** true if the objects are equal, false otherwise @@ -48,26 +42,21 @@ Returns **[boolean][6]** true if the objects are equal, false otherwise [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-equal ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf @@ -76,4 +65,4 @@ $ npm install @turf/turf ### Diagrams -![esri-equals](diagrams/esri-equals.gif) +![esri-equals](diagrams/esri-equals.gif) \ No newline at end of file diff --git a/packages/turf-boolean-intersects/README.md b/packages/turf-boolean-intersects/README.md index 26985afd97..b6f0c74fd1 100644 --- a/packages/turf-boolean-intersects/README.md +++ b/packages/turf-boolean-intersects/README.md @@ -14,7 +14,7 @@ Boolean-intersects returns (TRUE) two geometries intersect. ### Examples ```javascript -var point = turf.point([1, 2]); +var point = turf.point([2, 2]); var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]); turf.booleanIntersects(line, point); @@ -29,26 +29,21 @@ Returns **[boolean][3]** true/false [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-intersects ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-overlap/README.md b/packages/turf-boolean-overlap/README.md index 02d476b61e..21ee8a5a5c 100755 --- a/packages/turf-boolean-overlap/README.md +++ b/packages/turf-boolean-overlap/README.md @@ -44,26 +44,21 @@ Returns **[boolean][7]** true/false [7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-overlap ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-parallel/README.md b/packages/turf-boolean-parallel/README.md index 51d6fa5861..595ef33f79 100644 --- a/packages/turf-boolean-parallel/README.md +++ b/packages/turf-boolean-parallel/README.md @@ -31,26 +31,21 @@ Returns **[boolean][4]** true/false if the lines are parallel [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-parallel ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-point-in-polygon/README.md b/packages/turf-boolean-point-in-polygon/README.md index cee211fc84..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,34 +44,25 @@ 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 +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-point-in-polygon ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-point-on-line/README.md b/packages/turf-boolean-point-on-line/README.md index 7a36556630..7269c566a5 100644 --- a/packages/turf-boolean-point-on-line/README.md +++ b/packages/turf-boolean-point-on-line/README.md @@ -39,26 +39,21 @@ Returns **[boolean][5]** true/false [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-point-on-line ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-touches/README.md b/packages/turf-boolean-touches/README.md index 7d765d0be2..f6c9c5e326 100644 --- a/packages/turf-boolean-touches/README.md +++ b/packages/turf-boolean-touches/README.md @@ -30,26 +30,21 @@ Returns **[boolean][3]** true/false [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-touches ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-valid/README.md b/packages/turf-boolean-valid/README.md index 73b052c3ac..211d58d803 100644 --- a/packages/turf-boolean-valid/README.md +++ b/packages/turf-boolean-valid/README.md @@ -27,26 +27,21 @@ Returns **[boolean][3]** true/false [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-valid ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-boolean-within/README.md b/packages/turf-boolean-within/README.md index c7f933cdbf..be7f813401 100644 --- a/packages/turf-boolean-within/README.md +++ b/packages/turf-boolean-within/README.md @@ -32,26 +32,21 @@ Returns **[boolean][3]** true/false [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/boolean-within ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-buffer/README.md b/packages/turf-buffer/README.md index 64469fb907..664fbd028f 100644 --- a/packages/turf-buffer/README.md +++ b/packages/turf-buffer/README.md @@ -51,26 +51,21 @@ Returns **([FeatureCollection][1] | [Feature][3]<([Polygon][7] | [MultiPolygon][ [9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/buffer ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-center-mean/README.md b/packages/turf-center-mean/README.md index 04b5498ccb..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,30 +46,23 @@ 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 +[6]: https://tools.ietf.org/html/rfc7946#section-3.1.2 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/center-mean ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-center-median/README.md b/packages/turf-center-median/README.md index 10ecdf3665..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,44 +60,37 @@ 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 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/center-median ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-center-of-mass/README.md b/packages/turf-center-of-mass/README.md index 4f11dfb4a4..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,30 +38,23 @@ 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 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/center-of-mass ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-center/README.md b/packages/turf-center/README.md index 1f520a480d..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,30 +42,23 @@ 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 +[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/center ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-centroid/README.md b/packages/turf-centroid/README.md index 574c7a52bc..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,30 +32,23 @@ 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 +[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/centroid ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-circle/README.md b/packages/turf-circle/README.md index 25cbd3ce0d..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,44 +28,37 @@ 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 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/circle ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-clean-coords/README.md b/packages/turf-clean-coords/README.md index 25cf1295bb..4552217d6d 100644 --- a/packages/turf-clean-coords/README.md +++ b/packages/turf-clean-coords/README.md @@ -36,26 +36,21 @@ Returns **([Geometry][1] | [Feature][2])** the cleaned input Feature/Geometry [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/clean-coords ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-clone/README.md b/packages/turf-clone/README.md index c650346c29..37185c482a 100644 --- a/packages/turf-clone/README.md +++ b/packages/turf-clone/README.md @@ -23,26 +23,21 @@ Returns **[GeoJSON][1]** cloned GeoJSON Object [1]: https://tools.ietf.org/html/rfc7946#section-3 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/clone ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-clusters-dbscan/README.md b/packages/turf-clusters-dbscan/README.md index 88949c1569..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,36 +38,29 @@ 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 +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/clusters-dbscan ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-clusters-kmeans/README.md b/packages/turf-clusters-kmeans/README.md index 391de1b5c5..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,34 +36,27 @@ 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 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/clusters-kmeans ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-clusters/README.md b/packages/turf-clusters/README.md index e41d2a90ff..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 @@ -182,26 +182,21 @@ Returns **any** The value that results from the reduction. [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/clusters ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-collect/README.md b/packages/turf-collect/README.md index 9e17a367b7..79e277a92d 100644 --- a/packages/turf-collect/README.md +++ b/packages/turf-collect/README.md @@ -47,26 +47,21 @@ Returns **[FeatureCollection][1]<[Polygon][2]>** polygons with properties listed [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/collect ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-combine/README.md b/packages/turf-combine/README.md index a302661746..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,40 +41,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/combine ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-concave/README.md b/packages/turf-concave/README.md index f4f7485d97..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,40 +43,33 @@ 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 +[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/concave ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-convex/README.md b/packages/turf-convex/README.md index 4376e19e9b..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,30 +54,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/convex ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-destination/README.md b/packages/turf-destination/README.md index e8a5b074f4..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,28 +50,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/destination ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-difference/README.md b/packages/turf-difference/README.md index 71d8fbdb3b..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,38 +40,31 @@ 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 +[4]: https://tools.ietf.org/html/rfc7946#section-3.2 -[5]: https://tools.ietf.org/html/rfc7946#section-3.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/difference ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-directional-mean/README.md b/packages/turf-directional-mean/README.md index a3f0e13df5..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`) @@ -56,26 +56,21 @@ Returns **[DirectionalMeanLine][6]** Directional Mean Line [6]: #directionalmeanline - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/directional-mean ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-dissolve/README.md b/packages/turf-dissolve/README.md index 3a6ab50783..803ecf10d0 100644 --- a/packages/turf-dissolve/README.md +++ b/packages/turf-dissolve/README.md @@ -43,26 +43,21 @@ Returns **[FeatureCollection][3]<[Polygon][4]>** a FeatureCollection containing [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/dissolve ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-distance-weight/README.md b/packages/turf-distance-weight/README.md index a8f7b872e6..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=\>** distance weight matrix. [7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/distance-weight ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-distance/README.md b/packages/turf-distance/README.md index 1c3c3b8d13..68c6e14472 100644 --- a/packages/turf-distance/README.md +++ b/packages/turf-distance/README.md @@ -9,11 +9,11 @@ This uses the [Haversine formula][2] to account for global curvature. ### Parameters -* `from` **([Coord][3] | [Point][4])** origin point or coordinate -* `to` **([Coord][3] | [Point][4])** destination point or coordinate -* `options` **[Object][5]** Optional parameters (optional, default `{}`) +* `from` **([Coord][3] | [Point][1])** origin point or coordinate +* `to` **([Coord][3] | [Point][1])** destination point or coordinate +* `options` **[Object][4]** Optional parameters (optional, default `{}`) - * `options.units` **[string][6]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) + * `options.units` **[string][5]** can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`) ### Examples @@ -30,7 +30,7 @@ from.properties.distance = distance; to.properties.distance = distance; ``` -Returns **[number][7]** distance between the two points +Returns **[number][6]** distance between the two points [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -38,34 +38,27 @@ Returns **[number][7]** distance between the two points [3]: https://tools.ietf.org/html/rfc7946#section-3.1.1 -[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 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/distance ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-ellipse/README.md b/packages/turf-ellipse/README.md index 3a45a8b512..7a013993f0 100644 --- a/packages/turf-ellipse/README.md +++ b/packages/turf-ellipse/README.md @@ -47,26 +47,21 @@ Returns **[Feature][6]<[Polygon][7]>** ellipse polygon [7]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/ellipse ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-envelope/README.md b/packages/turf-envelope/README.md index c44c730dc6..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,28 +33,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/envelope ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-explode/README.md b/packages/turf-explode/README.md index 2951996ba0..029b8ab177 100644 --- a/packages/turf-explode/README.md +++ b/packages/turf-explode/README.md @@ -33,26 +33,21 @@ Returns **[FeatureCollection][4]\** points representing the exploded inpu [4]: https://tools.ietf.org/html/rfc7946#section-3.3 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/explode ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-flatten/README.md b/packages/turf-flatten/README.md index 900e62d519..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,30 +33,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/flatten ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-flip/README.md b/packages/turf-flip/README.md index fed1b79d1f..5cf9d9b7ff 100644 --- a/packages/turf-flip/README.md +++ b/packages/turf-flip/README.md @@ -32,26 +32,21 @@ Returns **[GeoJSON][1]** a feature or set of features of the same type as `input [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/flip ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-great-circle/README.md b/packages/turf-great-circle/README.md index ca1d8dee4d..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,30 +45,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/great-circle ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-helpers/README.md b/packages/turf-helpers/README.md index 0e1b956ff6..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,70 +523,53 @@ 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 +[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/helpers ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-hex-grid/README.md b/packages/turf-hex-grid/README.md index f9c3d865a2..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,32 +51,23 @@ 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 +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - -[11]: https://tools.ietf.org/html/rfc7946#section-3.3 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/hex-grid ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-interpolate/README.md b/packages/turf-interpolate/README.md index 0c976df49f..6959ec9fe4 100644 --- a/packages/turf-interpolate/README.md +++ b/packages/turf-interpolate/README.md @@ -49,26 +49,21 @@ Returns **[FeatureCollection][2]<([Point][3] | [Polygon][7])>** grid of points o [7]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/interpolate ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-intersect/README.md b/packages/turf-intersect/README.md index 0d78c84512..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,34 +51,25 @@ 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 +[5]: https://tools.ietf.org/html/rfc7946#section-3.2 -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[7]: https://tools.ietf.org/html/rfc7946#section-3.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/intersect ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-invariant/README.md b/packages/turf-invariant/README.md index 5652bdeaa9..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,34 +166,25 @@ 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 +[11]: https://tools.ietf.org/html/rfc7946#section-3.3 -[12]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[13]: https://tools.ietf.org/html/rfc7946#section-3.3 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/invariant ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-isobands/README.md b/packages/turf-isobands/README.md index 9544a6c281..a2397c4d19 100644 --- a/packages/turf-isobands/README.md +++ b/packages/turf-isobands/README.md @@ -9,56 +9,45 @@ 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 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/isobands ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-isolines/README.md b/packages/turf-isolines/README.md index e5b620bc48..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,42 +45,31 @@ 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 +[8]: https://tools.ietf.org/html/rfc7946#section-3.1.5 -[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/isolines ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-kinks/README.md b/packages/turf-kinks/README.md index a8569d856d..28316dce36 100644 --- a/packages/turf-kinks/README.md +++ b/packages/turf-kinks/README.md @@ -10,62 +10,56 @@ 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 ```javascript -var poly = turf.polygon([ - [ - [-12.034835, 8.901183], - [-12.060413, 8.899826], - [-12.03638, 8.873199], - [-12.059383, 8.871418], - [-12.034835, 8.901183], - ], -]); +var poly = turf.polygon([[ + [-12.034835, 8.901183], + [-12.060413, 8.899826], + [-12.03638, 8.873199], + [-12.059383, 8.871418], + [-12.034835, 8.901183] +]]); var kinks = turf.kinks(poly); //addToMap -var addToMap = [poly, kinks]; +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 + [2]: https://tools.ietf.org/html/rfc7946#section-3.1.5 + [3]: https://tools.ietf.org/html/rfc7946#section-3.1.7 + [4]: https://tools.ietf.org/html/rfc7946#section-3.1.6 + [5]: https://tools.ietf.org/html/rfc7946#section-3.1.2 + [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 + + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/kinks ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-length/README.md b/packages/turf-length/README.md index 883417ab34..6a280be539 100644 --- a/packages/turf-length/README.md +++ b/packages/turf-length/README.md @@ -42,26 +42,21 @@ Returns **[number][8]** length of GeoJSON [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/length ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-arc/README.md b/packages/turf-line-arc/README.md index 9accf27802..0a8327926e 100644 --- a/packages/turf-line-arc/README.md +++ b/packages/turf-line-arc/README.md @@ -15,7 +15,7 @@ Creates a circular arc, of a circle of the given radius and center point, betwee * `bearing2` **[number][2]** angle, in decimal degrees, of the second radius of the arc * `options` **[Object][3]** Optional parameters (optional, default `{}`) - * `options.steps` **[number][2]** number of steps (optional, default `64`) + * `options.steps` **[number][2]** number of steps (straight segments) that will constitute the arc (optional, default `64`) * `options.units` **[string][4]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`) ### Examples @@ -46,26 +46,21 @@ Returns **[Feature][5]<[LineString][6]>** line arc [6]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-arc ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-chunk/README.md b/packages/turf-line-chunk/README.md index 3d7872e0cf..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,38 +37,31 @@ 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 +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-chunk ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-intersect/README.md b/packages/turf-line-intersect/README.md index 83704c5020..2c9881046f 100644 --- a/packages/turf-line-intersect/README.md +++ b/packages/turf-line-intersect/README.md @@ -10,6 +10,10 @@ Takes any LineString or Polygon GeoJSON and returns the intersecting point(s). * `line1` **[GeoJSON][1]** any LineString or Polygon * `line2` **[GeoJSON][1]** any LineString or Polygon +* `options` **[Object][2]** Optional parameters (optional, default `{}`) + + * `options.removeDuplicates` **[boolean][3]** remove duplicate intersections (optional, default `true`) + * `options.ignoreSelfIntersections` **[boolean][3]** ignores self-intersections on input features (optional, default `false`) ### Examples @@ -22,34 +26,33 @@ var intersects = turf.lineIntersect(line1, line2); var addToMap = [line1, line2, intersects] ``` -Returns **[FeatureCollection][2]<[Point][3]>** point(s) that intersect both +Returns **[FeatureCollection][4]<[Point][5]>** point(s) that intersect both [1]: https://tools.ietf.org/html/rfc7946#section-3 -[2]: https://tools.ietf.org/html/rfc7946#section-3.3 +[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object + +[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean + +[4]: https://tools.ietf.org/html/rfc7946#section-3.3 -[3]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[5]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-intersect ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-offset/README.md b/packages/turf-line-offset/README.md index 6149ba4860..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,36 +34,29 @@ 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 +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-offset ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-overlap/README.md b/packages/turf-line-overlap/README.md index 47c2d38255..c5be721f70 100644 --- a/packages/turf-line-overlap/README.md +++ b/packages/turf-line-overlap/README.md @@ -46,26 +46,21 @@ Returns **[FeatureCollection][9]<[LineString][3]>** lines(s) that are overlappin [9]: https://tools.ietf.org/html/rfc7946#section-3.3 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-overlap ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-segment/README.md b/packages/turf-line-segment/README.md index 731ef8ac1f..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,30 +31,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-segment ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-slice-along/README.md b/packages/turf-line-slice-along/README.md index 5174154ee0..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,34 +39,27 @@ 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 +[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-slice-along ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-slice/README.md b/packages/turf-line-slice/README.md index 808fb68b15..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,28 +46,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-slice ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-split/README.md b/packages/turf-line-split/README.md index 4f3e9d8f77..7ed01cbccd 100644 --- a/packages/turf-line-split/README.md +++ b/packages/turf-line-split/README.md @@ -31,26 +31,21 @@ Returns **[FeatureCollection][3]<[LineString][2]>** Split LineStrings [3]: https://tools.ietf.org/html/rfc7946#section-3.3 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-split ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-line-to-polygon/README.md b/packages/turf-line-to-polygon/README.md index c7b0992a50..93e53f3a13 100644 --- a/packages/turf-line-to-polygon/README.md +++ b/packages/turf-line-to-polygon/README.md @@ -45,26 +45,21 @@ Returns **[Feature][2]<([Polygon][7] | [MultiPolygon][8])>** converted to Polygo [8]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/line-to-polygon ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-mask/README.md b/packages/turf-mask/README.md index 2c105ac48e..7b369d93ba 100644 --- a/packages/turf-mask/README.md +++ b/packages/turf-mask/README.md @@ -8,8 +8,8 @@ Takes any type of [polygon][1] and an optional mask and returns a [polygon][1] e ### Parameters -* `polygon` **([FeatureCollection][2] | [Feature][3]<([Polygon][4] | [MultiPolygon][5])>)** GeoJSON Polygon used as interior rings or holes. -* `mask` **[Feature][3]<[Polygon][4]>?** GeoJSON Polygon used as the exterior ring (if undefined, the world extent is used) +* `polygon` **([FeatureCollection][2] | [Feature][3]<([Polygon][1] | [MultiPolygon][4])>)** GeoJSON Polygon used as interior rings or holes. +* `mask` **[Feature][3]<[Polygon][1]>?** GeoJSON Polygon used as the exterior ring (if undefined, the world extent is used) ### Examples @@ -23,7 +23,7 @@ var masked = turf.mask(polygon, mask); var addToMap = [masked] ``` -Returns **[Feature][3]<[Polygon][4]>** Masked Polygon (exterior ring with holes). +Returns **[Feature][3]<[Polygon][1]>** Masked Polygon (exterior ring with holes). [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -31,30 +31,23 @@ Returns **[Feature][3]<[Polygon][4]>** Masked Polygon (exterior ring with holes) [3]: https://tools.ietf.org/html/rfc7946#section-3.2 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[4]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/mask ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-meta/README.md b/packages/turf-meta/README.md index 88b497b318..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 @@ -834,26 +834,21 @@ Returns **[Feature][5]<[Point][15]>** 2-vertex GeoJSON Feature Point [15]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/meta ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-midpoint/README.md b/packages/turf-midpoint/README.md index e2b8fca688..23c524cd1d 100644 --- a/packages/turf-midpoint/README.md +++ b/packages/turf-midpoint/README.md @@ -25,7 +25,7 @@ var addToMap = [point1, point2, midpoint]; midpoint.properties['marker-color'] = '#f00'; ``` -Returns **[Feature][3]<[Point][4]>** a point midway between `pt1` and `pt2` +Returns **[Feature][3]<[Point][1]>** a point midway between `pt1` and `pt2` [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2 @@ -33,28 +33,21 @@ Returns **[Feature][3]<[Point][4]>** a point midway between `pt1` and `pt2` [3]: https://tools.ietf.org/html/rfc7946#section-3.2 -[4]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/midpoint ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-moran-index/README.md b/packages/turf-moran-index/README.md index faf065f59f..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 @@ -100,26 +100,21 @@ Type: [Object][4] [9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/moran-index ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-nearest-neighbor-analysis/README.md b/packages/turf-nearest-neighbor-analysis/README.md index bc4b634d8c..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,36 +71,29 @@ 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 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/nearest-neighbor-analysis ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-nearest-point-on-line/README.md b/packages/turf-nearest-point-on-line/README.md index ca6190635e..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,40 +44,31 @@ 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 +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - -[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/nearest-point-on-line ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-nearest-point-to-line/README.md b/packages/turf-nearest-point-to-line/README.md index 744785b2f8..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,42 +47,31 @@ 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 +[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/nearest-point-to-line ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-nearest-point/README.md b/packages/turf-nearest-point/README.md index 1d9002c0b1..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,34 +42,27 @@ 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 +[6]: https://tools.ietf.org/html/rfc7946#section-3.2 -[7]: https://tools.ietf.org/html/rfc7946#section-3.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/nearest-point ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-planepoint/README.md b/packages/turf-planepoint/README.md index 97ce72c9e9..b4f85afee6 100644 --- a/packages/turf-planepoint/README.md +++ b/packages/turf-planepoint/README.md @@ -14,7 +14,7 @@ if their values are not provided as properties. ### Parameters * `point` **[Coord][3]** the Point for which a z-value will be calculated -* `triangle` **[Feature][4]<[Polygon][5]>** a Polygon feature with three vertices +* `triangle` **[Feature][4]<[Polygon][1]>** a Polygon feature with three vertices ### Examples @@ -39,7 +39,7 @@ point.properties.zValue = zValue; var addToMap = [triangle, point]; ``` -Returns **[number][6]** the z-value for `interpolatedPoint` +Returns **[number][5]** the z-value for `interpolatedPoint` [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -49,30 +49,23 @@ Returns **[number][6]** the z-value for `interpolatedPoint` [4]: https://tools.ietf.org/html/rfc7946#section-3.2 -[5]: https://tools.ietf.org/html/rfc7946#section-3.1.6 +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/planepoint ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-point-grid/README.md b/packages/turf-point-grid/README.md index 557c19d967..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,36 +45,25 @@ 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 +[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/point-grid ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-point-on-feature/README.md b/packages/turf-point-on-feature/README.md index 64f3d88f3f..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,28 +45,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/point-on-feature ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-point-to-line-distance/README.md b/packages/turf-point-to-line-distance/README.md index 2edebc6445..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,38 +36,29 @@ 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 +[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/point-to-line-distance ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-points-within-polygon/README.md b/packages/turf-points-within-polygon/README.md index dcd94dcd4f..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,36 +54,25 @@ 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 +[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/points-within-polygon ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-polygon-smooth/README.md b/packages/turf-polygon-smooth/README.md index 091153055b..62da5fb0b4 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] | [Feature][5]<([Polygon][6] | [MultiPolygon][7])>)** (Multi)Polygon(s) to smooth -* `options` **[Object][8]** Optional parameters (optional, default `{}`) +* `inputPolys` **([FeatureCollection][4] | [Feature][5]<([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][6]>** FeatureCollection containing the smoothed polygon/poylgons +Returns **[FeatureCollection][4]<[Polygon][1]>** FeatureCollection containing the smoothed polygon/poylgons [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6 @@ -37,34 +37,25 @@ Returns **[FeatureCollection][4]<[Polygon][6]>** FeatureCollection containing th [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 +[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/polygon-smooth ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-polygon-tangents/README.md b/packages/turf-polygon-tangents/README.md index 706d36a21d..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,34 +33,25 @@ 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 +[6]: https://tools.ietf.org/html/rfc7946#section-3.3 -[7]: https://tools.ietf.org/html/rfc7946#section-3.3 - -[8]: https://tools.ietf.org/html/rfc7946#section-3.1.2 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/polygon-tangents ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-polygon-to-line/README.md b/packages/turf-polygon-to-line/README.md index b007a399a2..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,36 +37,23 @@ 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 +[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://tools.ietf.org/html/rfc7946#section-3.3 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/polygon-to-line ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-polygonize/README.md b/packages/turf-polygonize/README.md index 48902fb0fc..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,34 +36,25 @@ 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 +[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error -[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error - -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/polygonize ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-projection/README.md b/packages/turf-projection/README.md index ad44d712b0..1c59858952 100644 --- a/packages/turf-projection/README.md +++ b/packages/turf-projection/README.md @@ -8,10 +8,10 @@ Converts a WGS84 GeoJSON object into Mercator (EPSG:900913) projection ### Parameters -* `geojson` **([GeoJSON][1] | Position)** WGS84 GeoJSON object -* `options` **[Object][2]?** Optional parameters +* `geojson` **([GeoJSON][1] | [Position][2])** WGS84 GeoJSON object +* `options` **[Object][3]?** Optional parameters - * `options.mutate` **[boolean][3]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`) + * `options.mutate` **[boolean][4]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`) ### Examples @@ -31,10 +31,10 @@ Converts a Mercator (EPSG:900913) GeoJSON object into WGS84 projection ### Parameters -* `geojson` **([GeoJSON][1] | Position)** Mercator GeoJSON object -* `options` **[Object][2]?** Optional parameters +* `geojson` **([GeoJSON][1] | [Position][2])** Mercator GeoJSON object +* `options` **[Object][3]?** Optional parameters - * `options.mutate` **[boolean][3]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`) + * `options.mutate` **[boolean][4]** allows GeoJSON input to be mutated (significant performance increase if true) (optional, default `false`) ### Examples @@ -50,30 +50,27 @@ Returns **[GeoJSON][1]** Projected GeoJSON [1]: https://tools.ietf.org/html/rfc7946#section-3 -[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object +[2]: https://developer.mozilla.org/docs/Web/API/Position -[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean +[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - +[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean + + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/projection ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-quadrat-analysis/README.md b/packages/turf-quadrat-analysis/README.md index 60cf0f3f05..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. @@ -93,26 +93,21 @@ Type: [Object][3] [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/quadrat-analysis ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-random/README.md b/packages/turf-random/README.md index 19df7d90e1..53af241fef 100644 --- a/packages/turf-random/README.md +++ b/packages/turf-random/README.md @@ -119,26 +119,21 @@ Returns **[FeatureCollection][7]<[LineString][12]>** GeoJSON FeatureCollection o [12]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/random ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-rectangle-grid/README.md b/packages/turf-rectangle-grid/README.md index ec2ef55bad..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,34 +47,25 @@ 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 +[8]: https://tools.ietf.org/html/rfc7946#section-3.1.7 -[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - -[10]: https://tools.ietf.org/html/rfc7946#section-3.3 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/rectangle-grid ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-rewind/README.md b/packages/turf-rewind/README.md index 571e2676e7..6679a5bf6c 100644 --- a/packages/turf-rewind/README.md +++ b/packages/turf-rewind/README.md @@ -39,26 +39,21 @@ Returns **[GeoJSON][4]** rewind Polygon [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/rewind ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-rhumb-bearing/README.md b/packages/turf-rhumb-bearing/README.md index f1e4649dd2..a8be86d3fb 100644 --- a/packages/turf-rhumb-bearing/README.md +++ b/packages/turf-rhumb-bearing/README.md @@ -41,26 +41,21 @@ Returns **[number][5]** bearing from north in decimal degrees, between -180 and [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/rhumb-bearing ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-rhumb-destination/README.md b/packages/turf-rhumb-destination/README.md index 11943e71e0..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,28 +46,21 @@ 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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/rhumb-destination ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-rhumb-distance/README.md b/packages/turf-rhumb-distance/README.md index 8f616f9e28..17b6308490 100644 --- a/packages/turf-rhumb-distance/README.md +++ b/packages/turf-rhumb-distance/README.md @@ -42,26 +42,21 @@ Returns **[number][5]** distance between the two points [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/rhumb-distance ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-sample/README.md b/packages/turf-sample/README.md index 2fc0ab8fff..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,36 +26,29 @@ 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 +[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/sample ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-sector/README.md b/packages/turf-sector/README.md index 01e544b462..6e86c00828 100644 --- a/packages/turf-sector/README.md +++ b/packages/turf-sector/README.md @@ -49,26 +49,21 @@ Returns **[Feature][6]<[Polygon][7]>** sector polygon [7]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/sector ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-shortest-path/README.md b/packages/turf-shortest-path/README.md index 94921a8b5d..94047f4246 100644 --- a/packages/turf-shortest-path/README.md +++ b/packages/turf-shortest-path/README.md @@ -13,10 +13,10 @@ 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.minDistance` **[number][11]?** minimum distance between shortest path and obstacles - * `options.units` **[string][12]** 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`) + * `options.obstacles` **([Geometry][7] | [Feature][3] | [FeatureCollection][8]<[Polygon][9]>)?** areas which path cannot travel + * `options.minDistance` **[number][10]?** minimum distance between shortest path and obstacles + * `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][10]** distance between matrix points on which the path will be calculated (optional, default `100`) ### Examples @@ -33,7 +33,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 @@ -49,38 +49,29 @@ 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/Number -[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - -[13]: https://tools.ietf.org/html/rfc7946#section-3.1.4 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/shortest-path ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-simplify/README.md b/packages/turf-simplify/README.md index cbed6b5067..d071781c5d 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 ### 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,40 +48,33 @@ 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 +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean -[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/simplify ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-square-grid/README.md b/packages/turf-square-grid/README.md index 959fa7df01..0a04b35359 100644 --- a/packages/turf-square-grid/README.md +++ b/packages/turf-square-grid/README.md @@ -49,26 +49,21 @@ Returns **[FeatureCollection][8]<[Polygon][6]>** grid a grid of polygons [8]: https://tools.ietf.org/html/rfc7946#section-3.3 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/square-grid ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-square/README.md b/packages/turf-square/README.md index f0e563f6d8..2dc95eabd0 100644 --- a/packages/turf-square/README.md +++ b/packages/turf-square/README.md @@ -25,26 +25,21 @@ Returns **[BBox][1]** a square surrounding `bbox` [1]: https://tools.ietf.org/html/rfc7946#section-5 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/square ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-standard-deviational-ellipse/README.md b/packages/turf-standard-deviational-ellipse/README.md index a079f5bf64..b56b3583bf 100644 --- a/packages/turf-standard-deviational-ellipse/README.md +++ b/packages/turf-standard-deviational-ellipse/README.md @@ -25,12 +25,12 @@ doi:{@link [https://doi.org/10.1086/214336|10.1086/214336}][5]. ### Parameters -* `points` **[FeatureCollection][6]<[Point][7]>** GeoJSON points -* `options` **[Object][8]** Optional parameters (optional, default `{}`) +* `points` **[FeatureCollection][1]<[Point][6]>** GeoJSON points +* `options` **[Object][7]** Optional parameters (optional, default `{}`) - * `options.weight` **[string][9]?** the property name used to weight the center - * `options.steps` **[number][10]** number of steps for the polygon (optional, default `64`) - * `options.properties` **[Object][8]** properties to pass to the resulting ellipse (optional, default `{}`) + * `options.weight` **[string][8]?** the property name used to weight the center + * `options.steps` **[number][9]** number of steps for the polygon (optional, default `64`) + * `options.properties` **[Object][7]** properties to pass to the resulting ellipse (optional, default `{}`) ### Examples @@ -43,7 +43,7 @@ var sdEllipse = turf.standardDeviationalEllipse(points); var addToMap = [points, sdEllipse]; ``` -Returns **[Feature][11]<[Polygon][12]>** an elliptical Polygon that includes approximately 1 SD of the dataset within it. +Returns **[Feature][10]<[Polygon][11]>** an elliptical Polygon that includes approximately 1 SD of the dataset within it. [1]: https://tools.ietf.org/html/rfc7946#section-3.3 @@ -55,40 +55,33 @@ Returns **[Feature][11]<[Polygon][12]>** an elliptical Polygon that includes app [5]: https://doi.org/10.1086/214336|10.1086/214336} -[6]: https://tools.ietf.org/html/rfc7946#section-3.3 +[6]: https://tools.ietf.org/html/rfc7946#section-3.1.2 -[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2 +[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 +[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[10]: https://tools.ietf.org/html/rfc7946#section-3.2 -[11]: https://tools.ietf.org/html/rfc7946#section-3.2 +[11]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[12]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/standard-deviational-ellipse ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-tag/README.md b/packages/turf-tag/README.md index 796da6cddd..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,34 +52,23 @@ 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 +[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String -[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/tag ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-tesselate/README.md b/packages/turf-tesselate/README.md index d8e2ff5646..dd2b056c3e 100644 --- a/packages/turf-tesselate/README.md +++ b/packages/turf-tesselate/README.md @@ -35,26 +35,21 @@ Returns **[FeatureCollection][6]<[Polygon][5]>** a geometrycollection feature [6]: https://tools.ietf.org/html/rfc7946#section-3.3 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/tesselate ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-tin/README.md b/packages/turf-tin/README.md index f2e45cbf58..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,32 +47,25 @@ 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 +[5]: https://tools.ietf.org/html/rfc7946#section-3.1.6 -[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/tin ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-transform-rotate/README.md b/packages/turf-transform-rotate/README.md index cde8f17603..78a223c429 100644 --- a/packages/turf-transform-rotate/README.md +++ b/packages/turf-transform-rotate/README.md @@ -39,26 +39,21 @@ Returns **[GeoJSON][1]** the rotated GeoJSON feature [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/transform-rotate ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-transform-scale/README.md b/packages/turf-transform-scale/README.md index ef224cc627..8578cd2345 100644 --- a/packages/turf-transform-scale/README.md +++ b/packages/turf-transform-scale/README.md @@ -41,26 +41,21 @@ Returns **[GeoJSON][1]** scaled GeoJSON [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/transform-scale ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-transform-translate/README.md b/packages/turf-transform-translate/README.md index aa59e4a8a7..ece861a910 100644 --- a/packages/turf-transform-translate/README.md +++ b/packages/turf-transform-translate/README.md @@ -41,26 +41,21 @@ Returns **[GeoJSON][1]** the translated GeoJSON object [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/transform-translate ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-triangle-grid/README.md b/packages/turf-triangle-grid/README.md index a6f43b585c..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,30 +43,23 @@ 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 +[7]: https://tools.ietf.org/html/rfc7946#section-3.3 -[8]: https://tools.ietf.org/html/rfc7946#section-3.3 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/triangle-grid ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-truncate/README.md b/packages/turf-truncate/README.md index a5d56b5c10..592c6d4bbe 100644 --- a/packages/turf-truncate/README.md +++ b/packages/turf-truncate/README.md @@ -41,26 +41,21 @@ Returns **[GeoJSON][1]** layer with truncated geometry [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/truncate ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-union/README.md b/packages/turf-union/README.md index 1433de0ae7..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,32 +45,23 @@ 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 +[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 - - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/union ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-unkink-polygon/README.md b/packages/turf-unkink-polygon/README.md index ae5152d66d..f3f3a6c121 100644 --- a/packages/turf-unkink-polygon/README.md +++ b/packages/turf-unkink-polygon/README.md @@ -34,26 +34,21 @@ Returns **[FeatureCollection][2]<[Polygon][4]>** Unkinked polygons [5]: https://tools.ietf.org/html/rfc7946#section-3.1.7 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/unkink-polygon ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf diff --git a/packages/turf-voronoi/README.md b/packages/turf-voronoi/README.md index e8d5298030..f1d18d2a84 100644 --- a/packages/turf-voronoi/README.md +++ b/packages/turf-voronoi/README.md @@ -43,26 +43,21 @@ Returns **[FeatureCollection][1]<[Polygon][6]>** a set of polygons, one per inpu [6]: https://tools.ietf.org/html/rfc7946#section-3.1.6 - + --- -This module is part of the [Turfjs project](http://turfjs.org/), an open source -module collection dedicated to geographic algorithms. It is maintained in the -[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create -PRs and issues. +This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation -Install this module individually: +Install this single module individually: ```sh $ npm install @turf/voronoi ``` -Or install the Turf module that includes it as a function: +Or install the all-encompassing @turf/turf module that includes all modules as functions: ```sh $ npm install @turf/turf