node-red-contrib-web-worldmap 4.8.1 → 5.0.0

package/node_modules/@turf/helpers/README.md

@@ -2,35 +2,42 @@
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-## earthRadius
+## helpers
 
-Earth Radius used with the Harvesine formula and approximates using a spherical (non-ellipsoid) Earth.
+### earthRadius
 
-## factors
+The Earth radius in kilometers. Used by Turf modules that model the Earth as a sphere. The [mean radius][1] was selected because it is [recommended ][2] by the Haversine formula (used by turf/distance) to reduce error.
 
-Unit of measurement factors using a spherical (non-ellipsoid) earth radius.
+Type: [number][3]
 
-## unitsFactors
+### factors
 
-Units of measurement factors based on 1 meter.
+Unit of measurement factors based on earthRadius.
 
-## areaFactors
+Keys are the name of the unit, values are the number of that unit in a single radian
+
+Type: [Object][4]
+
+### areaFactors
 
 Area of measurement factors based on 1 square meter.
 
+Type: [Object][4]
+
 ## feature
 
-Wraps a GeoJSON [Geometry][1] in a GeoJSON [Feature][2].
+Wraps a GeoJSON [Geometry][5] in a GeoJSON [Feature][6].
+
+### Parameters
 
-**Parameters**
+*   `geometry` **[Geometry][5]** input geometry
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
--   `geometry` **[Geometry][3]** input geometry
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the Feature
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the Feature
 
-**Examples**
+### Examples
 
 ```javascript
 var geometry = {
@@ -43,46 +50,44 @@ var feature = turf.feature(geometry);
 //=feature
 ```
 
-Returns **[Feature][8]** a GeoJSON Feature
+Returns **[Feature][6]** a GeoJSON Feature
 
 ## geometry
 
-Creates a GeoJSON [Geometry][1] from a Geometry string type & coordinates.
+Creates a GeoJSON [Geometry][5] from a Geometry string type & coordinates.
 For GeometryCollection type use `helpers.geometryCollection`
 
-**Parameters**
+### Parameters
 
--   `type` **[string][7]** Geometry Type
--   `coordinates` **[Array][5]&lt;[number][6]>** Coordinates
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Geometry
+*   `type` **[string][8]** Geometry Type
+*   `coordinates` **[Array][7]\<any>** Coordinates
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+### Examples
 
 ```javascript
-var type = 'Point';
+var type = "Point";
 var coordinates = [110, 50];
-
 var geometry = turf.geometry(type, coordinates);
-
-//=geometry
+// => geometry
 ```
 
-Returns **[Geometry][3]** a GeoJSON Geometry
+Returns **[Geometry][5]** a GeoJSON Geometry
 
 ## point
 
-Creates a [Point][9] [Feature][2] from a Position.
+Creates a [Point][9] [Feature][6] from a Position.
+
+### Parameters
 
-**Parameters**
+*   `coordinates` **[Array][7]<[number][3]>** longitude, latitude position (each in decimal degrees)
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
--   `coordinates` **[Array][5]&lt;[number][6]>** longitude, latitude position (each in decimal degrees)
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the Feature
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the Feature
 
-**Examples**
+### Examples
 
 ```javascript
 var point = turf.point([-75.343, 39.984]);
@@ -90,21 +95,23 @@ var point = turf.point([-75.343, 39.984]);
 //=point
 ```
 
-Returns **[Feature][8]&lt;[Point][10]>** a Point feature
+Returns **[Feature][6]<[Point][9]>** a Point feature
 
 ## points
 
-Creates a [Point][9] [FeatureCollection][11] from an Array of Point coordinates.
+Creates a [Point][9] [FeatureCollection][10] from an Array of Point coordinates.
 
-**Parameters**
+### Parameters
 
--   `coordinates` **[Array][5]&lt;[Array][5]&lt;[number][6]>>** an array of Points
--   `properties` **[Object][4]** Translate these properties to each Feature (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the FeatureCollection
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the FeatureCollection
+*   `coordinates` **[Array][7]<[Array][7]<[number][3]>>** an array of Points
+*   `properties` **[Object][4]** Translate these properties to each Feature (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north]
+        associated with the FeatureCollection
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the FeatureCollection
+
+### Examples
 
 ```javascript
 var points = turf.points([
@@ -116,21 +123,22 @@ var points = turf.points([
 //=points
 ```
 
-Returns **[FeatureCollection][12]&lt;[Point][10]>** Point Feature
+Returns **[FeatureCollection][10]<[Point][9]>** Point Feature
 
 ## polygon
 
-Creates a [Polygon][13] [Feature][2] from an Array of LinearRings.
+Creates a [Polygon][11] [Feature][6] from an Array of LinearRings.
+
+### Parameters
 
-**Parameters**
+*   `coordinates` **[Array][7]<[Array][7]<[Array][7]<[number][3]>>>** an array of LinearRings
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
--   `coordinates` **[Array][5]&lt;[Array][5]&lt;[Array][5]&lt;[number][6]>>>** an array of LinearRings
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the Feature
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the Feature
 
-**Examples**
+### Examples
 
 ```javascript
 var polygon = turf.polygon([[[-5, 52], [-4, 56], [-2, 51], [-7, 54], [-5, 52]]], { name: 'poly1' });
@@ -138,21 +146,22 @@ var polygon = turf.polygon([[[-5, 52], [-4, 56], [-2, 51], [-7, 54], [-5, 52]]],
 //=polygon
 ```
 
-Returns **[Feature][8]&lt;[Polygon][14]>** Polygon Feature
+Returns **[Feature][6]<[Polygon][11]>** Polygon Feature
 
 ## polygons
 
-Creates a [Polygon][13] [FeatureCollection][11] from an Array of Polygon coordinates.
+Creates a [Polygon][11] [FeatureCollection][10] from an Array of Polygon coordinates.
 
-**Parameters**
+### Parameters
 
--   `coordinates` **[Array][5]&lt;[Array][5]&lt;[Array][5]&lt;[Array][5]&lt;[number][6]>>>>** an array of Polygon coordinates
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the FeatureCollection
+*   `coordinates` **[Array][7]<[Array][7]<[Array][7]<[Array][7]<[number][3]>>>>** an array of Polygon coordinates
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the FeatureCollection
+
+### Examples
 
 ```javascript
 var polygons = turf.polygons([
@@ -163,21 +172,22 @@ var polygons = turf.polygons([
 //=polygons
 ```
 
-Returns **[FeatureCollection][12]&lt;[Polygon][14]>** Polygon FeatureCollection
+Returns **[FeatureCollection][10]<[Polygon][11]>** Polygon FeatureCollection
 
 ## lineString
 
-Creates a [LineString][15] [Feature][2] from an Array of Positions.
+Creates a [LineString][12] [Feature][6] from an Array of Positions.
+
+### Parameters
 
-**Parameters**
+*   `coordinates` **[Array][7]<[Array][7]<[number][3]>>** an array of Positions
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
--   `coordinates` **[Array][5]&lt;[Array][5]&lt;[number][6]>>** an array of Positions
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the Feature
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the Feature
 
-**Examples**
+### Examples
 
 ```javascript
 var linestring1 = turf.lineString([[-24, 63], [-23, 60], [-25, 65], [-20, 69]], {name: 'line 1'});
@@ -187,21 +197,23 @@ var linestring2 = turf.lineString([[-14, 43], [-13, 40], [-15, 45], [-10, 49]],
 //=linestring2
 ```
 
-Returns **[Feature][8]&lt;[LineString][16]>** LineString Feature
+Returns **[Feature][6]<[LineString][12]>** LineString Feature
 
 ## lineStrings
 
-Creates a [LineString][15] [FeatureCollection][11] from an Array of LineString coordinates.
+Creates a [LineString][12] [FeatureCollection][10] from an Array of LineString coordinates.
 
-**Parameters**
+### Parameters
 
--   `coordinates` **[Array][5]&lt;[Array][5]&lt;[number][6]>>** an array of LinearRings
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the FeatureCollection
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the FeatureCollection
+*   `coordinates` **[Array][7]<[Array][7]<[Array][7]<[number][3]>>>** an array of LinearRings
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north]
+        associated with the FeatureCollection
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the FeatureCollection
+
+### Examples
 
 ```javascript
 var linestrings = turf.lineStrings([
@@ -212,20 +224,21 @@ var linestrings = turf.lineStrings([
 //=linestrings
 ```
 
-Returns **[FeatureCollection][12]&lt;[LineString][16]>** LineString FeatureCollection
+Returns **[FeatureCollection][10]<[LineString][12]>** LineString FeatureCollection
 
 ## featureCollection
 
-Takes one or more [Features][2] and creates a [FeatureCollection][11].
+Takes one or more [Features][6] and creates a [FeatureCollection][10].
+
+### Parameters
 
-**Parameters**
+*   `features` **[Array][7]<[Feature][6]>** input features
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
--   `features` **[Array][5]&lt;[Feature][8]>** input features
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the Feature
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the Feature
 
-**Examples**
+### Examples
 
 ```javascript
 var locationA = turf.point([-75.343, 39.984], {name: 'Location A'});
@@ -241,22 +254,23 @@ var collection = turf.featureCollection([
 //=collection
 ```
 
-Returns **[FeatureCollection][12]** FeatureCollection of Features
+Returns **[FeatureCollection][10]** FeatureCollection of Features
 
 ## multiLineString
 
-Creates a [Feature&lt;MultiLineString>][17] based on a
+Creates a [Feature\<MultiLineString>][13] based on a
 coordinate array. Properties can be added optionally.
 
-**Parameters**
+### Parameters
+
+*   `coordinates` **[Array][7]<[Array][7]<[Array][7]<[number][3]>>>** an array of LineStrings
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
--   `coordinates` **[Array][5]&lt;[Array][5]&lt;[Array][5]&lt;[number][6]>>>** an array of LineStrings
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the Feature
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the Feature
 
-**Examples**
+### Examples
 
 ```javascript
 var multiLine = turf.multiLineString([[[0,0],[10,10]]]);
@@ -264,24 +278,25 @@ var multiLine = turf.multiLineString([[[0,0],[10,10]]]);
 //=multiLine
 ```
 
--   Throws **[Error][18]** if no coordinates are passed
+*   Throws **[Error][14]** if no coordinates are passed
 
-Returns **[Feature][8]&lt;[MultiLineString][19]>** a MultiLineString feature
+Returns **[Feature][6]<[MultiLineString][15]>** a MultiLineString feature
 
 ## multiPoint
 
-Creates a [Feature&lt;MultiPoint>][20] based on a
+Creates a [Feature\<MultiPoint>][16] based on a
 coordinate array. Properties can be added optionally.
 
-**Parameters**
+### Parameters
 
--   `coordinates` **[Array][5]&lt;[Array][5]&lt;[number][6]>>** an array of Positions
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the Feature
+*   `coordinates` **[Array][7]<[Array][7]<[number][3]>>** an array of Positions
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the Feature
+
+### Examples
 
 ```javascript
 var multiPt = turf.multiPoint([[0,0],[10,10]]);
@@ -289,24 +304,25 @@ var multiPt = turf.multiPoint([[0,0],[10,10]]);
 //=multiPt
 ```
 
--   Throws **[Error][18]** if no coordinates are passed
+*   Throws **[Error][14]** if no coordinates are passed
 
-Returns **[Feature][8]&lt;[MultiPoint][21]>** a MultiPoint feature
+Returns **[Feature][6]<[MultiPoint][17]>** a MultiPoint feature
 
 ## multiPolygon
 
-Creates a [Feature&lt;MultiPolygon>][22] based on a
+Creates a [Feature\<MultiPolygon>][18] based on a
 coordinate array. Properties can be added optionally.
 
-**Parameters**
+### Parameters
+
+*   `coordinates` **[Array][7]<[Array][7]<[Array][7]<[Array][7]<[number][3]>>>>** an array of Polygons
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
--   `coordinates` **[Array][5]&lt;[Array][5]&lt;[Array][5]&lt;[Array][5]&lt;[number][6]>>>>** an array of Polygons
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the Feature
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the Feature
 
-**Examples**
+### Examples
 
 ```javascript
 var multiPoly = turf.multiPolygon([[[[0,0],[0,10],[10,10],[10,0],[0,0]]]]);
@@ -314,51 +330,46 @@ 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][14]** if no coordinates are passed
 
-Returns **[Feature][8]&lt;[MultiPolygon][23]>** a multipolygon feature
+Returns **[Feature][6]<[MultiPolygon][19]>** a multipolygon feature
 
 ## geometryCollection
 
-Creates a [Feature&lt;GeometryCollection>][24] based on a
+Creates a [Feature\<GeometryCollection>][20] based on a
 coordinate array. Properties can be added optionally.
 
-**Parameters**
+### Parameters
 
--   `geometries` **[Array][5]&lt;[Geometry][3]>** an array of GeoJSON Geometries
--   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
--   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
-    -   `options.bbox` **[Array][5]&lt;[number][6]>?** Bounding Box Array [west, south, east, north] associated with the Feature
-    -   `options.id` **([string][7] \| [number][6])?** Identifier associated with the Feature
+*   `geometries` **[Array][7]<[Geometry][5]>** an array of GeoJSON Geometries
+*   `properties` **[Object][4]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][4]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.bbox` **[Array][7]<[number][3]>?** Bounding Box Array \[west, south, east, north] associated with the Feature
+    *   `options.id` **([string][8] | [number][3])?** Identifier associated with the Feature
+
+### Examples
 
 ```javascript
-var pt = {
-    "type": "Point",
-      "coordinates": [100, 0]
-    };
-var line = {
-    "type": "LineString",
-    "coordinates": [ [101, 0], [102, 1] ]
-  };
+var pt = turf.geometry("Point", [100, 0]);
+var line = turf.geometry("LineString", [[101, 0], [102, 1]]);
 var collection = turf.geometryCollection([pt, line]);
 
-//=collection
+// => collection
 ```
 
-Returns **[Feature][8]&lt;[GeometryCollection][25]>** a GeoJSON GeometryCollection Feature
+Returns **[Feature][6]<[GeometryCollection][21]>** a GeoJSON GeometryCollection Feature
 
 ## round
 
 Round number to precision
 
-**Parameters**
+### Parameters
 
--   `num` **[number][6]** Number
--   `precision` **[number][6]** Precision (optional, default `0`)
+*   `num` **[number][3]** Number
+*   `precision` **[number][3]** Precision (optional, default `0`)
 
-**Examples**
+### Examples
 
 ```javascript
 turf.round(120.4321)
@@ -368,110 +379,124 @@ turf.round(120.4321, 2)
 //=120.43
 ```
 
-Returns **[number][6]** rounded number
+Returns **[number][3]** rounded number
 
 ## radiansToLength
 
 Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.
 Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet
 
-**Parameters**
+### Parameters
 
--   `radians` **[number][6]** in radians across the sphere
--   `units` **[string][7]** can be degrees, radians, miles, or kilometers inches, yards, metres, meters, kilometres, kilometers. (optional, default `'kilometers'`)
+*   `radians` **[number][3]** in radians across the sphere
+*   `units` **[string][8]** can be degrees, radians, miles, inches, yards, metres,
+    meters, kilometres, kilometers. (optional, default `"kilometers"`)
 
-Returns **[number][6]** distance
+Returns **[number][3]** distance
 
 ## lengthToRadians
 
 Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians
 Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet
 
-**Parameters**
+### Parameters
 
--   `distance` **[number][6]** in real units
--   `units` **[string][7]** can be degrees, radians, miles, or kilometers inches, yards, metres, meters, kilometres, kilometers. (optional, default `'kilometers'`)
+*   `distance` **[number][3]** in real units
+*   `units` **[string][8]** can be degrees, radians, miles, inches, yards, metres,
+    meters, kilometres, kilometers. (optional, default `"kilometers"`)
 
-Returns **[number][6]** radians
+Returns **[number][3]** radians
 
 ## lengthToDegrees
 
 Convert a distance measurement (assuming a spherical Earth) from a real-world unit into degrees
 Valid units: miles, nauticalmiles, inches, yards, meters, metres, centimeters, kilometres, feet
 
-**Parameters**
+### Parameters
 
--   `distance` **[number][6]** in real units
--   `units` **[string][7]** can be degrees, radians, miles, or kilometers inches, yards, metres, meters, kilometres, kilometers. (optional, default `'kilometers'`)
+*   `distance` **[number][3]** in real units
+*   `units` **[string][8]** can be degrees, radians, miles, inches, yards, metres,
+    meters, kilometres, kilometers. (optional, default `"kilometers"`)
 
-Returns **[number][6]** degrees
+Returns **[number][3]** degrees
 
 ## bearingToAzimuth
 
 Converts any bearing angle from the north line direction (positive clockwise)
 and returns an angle between 0-360 degrees (positive clockwise), 0 being the north line
 
-**Parameters**
+### Parameters
+
+*   `bearing` **[number][3]** angle, between -180 and +180 degrees
+
+Returns **[number][3]** angle between 0 and 360 degrees
+
+## azimuthToBearing
 
--   `bearing` **[number][6]** angle, between -180 and +180 degrees
+Converts any azimuth angle from the north line direction (positive clockwise)
+and returns an angle between -180 and +180 degrees (positive clockwise), 0 being the north line
 
-Returns **[number][6]** angle between 0 and 360 degrees
+### Parameters
+
+*   `angle` **[number][3]** between 0 and 360 degrees
+
+Returns **[number][3]** bearing between -180 and +180 degrees
 
 ## radiansToDegrees
 
 Converts an angle in radians to degrees
 
-**Parameters**
+### Parameters
 
--   `radians` **[number][6]** angle in radians
+*   `radians` **[number][3]** angle in radians
 
-Returns **[number][6]** degrees between 0 and 360 degrees
+Returns **[number][3]** degrees between 0 and 360 degrees
 
 ## degreesToRadians
 
 Converts an angle in degrees to radians
 
-**Parameters**
+### Parameters
 
--   `degrees` **[number][6]** angle between 0 and 360 degrees
+*   `degrees` **[number][3]** angle between 0 and 360 degrees
 
-Returns **[number][6]** angle in radians
+Returns **[number][3]** angle in radians
 
 ## convertLength
 
 Converts a length to the requested unit.
 Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet
 
-**Parameters**
+### Parameters
 
--   `length` **[number][6]** to be converted
--   `originalUnit` **[string][7]** of the length
--   `finalUnit` **[string][7]** returned unit (optional, default `'kilometers'`)
+*   `length` **[number][3]** to be converted
+*   `originalUnit` **Units** of the length (optional, default `"kilometers"`)
+*   `finalUnit` **Units** returned unit (optional, default `"kilometers"`)
 
-Returns **[number][6]** the converted length
+Returns **[number][3]** the converted length
 
 ## convertArea
 
 Converts a area to the requested unit.
 Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches, hectares
 
-**Parameters**
+### Parameters
 
--   `area` **[number][6]** to be converted
--   `originalUnit` **[string][7]** of the distance (optional, default `'meters'`)
--   `finalUnit` **[string][7]** returned unit (optional, default `'kilometers'`)
+*   `area` **[number][3]** to be converted
+*   `originalUnit` **Units** of the distance (optional, default `"meters"`)
+*   `finalUnit` **Units** returned unit (optional, default `"kilometers"`)
 
-Returns **[number][6]** the converted distance
+Returns **[number][3]** the converted area
 
 ## isNumber
 
 isNumber
 
-**Parameters**
+### Parameters
 
--   `num` **any** Number to validate
+*   `num` **any** Number to validate
 
-**Examples**
+### Examples
 
 ```javascript
 turf.isNumber(123)
@@ -480,17 +505,17 @@ turf.isNumber('foo')
 //=false
 ```
 
-Returns **[boolean][26]** true/false
+Returns **[boolean][22]** true/false
 
 ## isObject
 
 isObject
 
-**Parameters**
+### Parameters
 
--   `input` **any** variable to validate
+*   `input` **any** variable to validate
 
-**Examples**
+### Examples
 
 ```javascript
 turf.isObject({elevation: 10})
@@ -499,80 +524,67 @@ turf.isObject('foo')
 //=false
 ```
 
-Returns **[boolean][26]** true/false
+Returns **[boolean][22]** true/false, including false for Arrays and Functions
 
-[1]: https://tools.ietf.org/html/rfc7946#section-3.1
+[1]: https://en.wikipedia.org/wiki/Earth_radius#Arithmetic_mean_radius
 
-[2]: https://tools.ietf.org/html/rfc7946#section-3.2
+[2]: https://rosettacode.org/wiki/Haversine_formula#:~:text=This%20value%20is%20recommended
 
-[3]: https://tools.ietf.org/html/rfc7946#section-3.1
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
 [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[5]: https://tools.ietf.org/html/rfc7946#section-3.1
 
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[6]: https://tools.ietf.org/html/rfc7946#section-3.2
 
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[8]: https://tools.ietf.org/html/rfc7946#section-3.2
+[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
 [9]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 
-[10]: https://tools.ietf.org/html/rfc7946#section-3.1.2
-
-[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.1.6
-
-[14]: https://tools.ietf.org/html/rfc7946#section-3.1.6
+[10]: https://tools.ietf.org/html/rfc7946#section-3.3
 
-[15]: https://tools.ietf.org/html/rfc7946#section-3.1.4
+[11]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 
-[16]: https://tools.ietf.org/html/rfc7946#section-3.1.4
+[12]: https://tools.ietf.org/html/rfc7946#section-3.1.4
 
-[17]: Feature<MultiLineString>
+[13]: Feature<MultiLineString>
 
-[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
+[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
 
-[19]: https://tools.ietf.org/html/rfc7946#section-3.1.5
+[15]: https://tools.ietf.org/html/rfc7946#section-3.1.5
 
-[20]: Feature<MultiPoint>
+[16]: Feature<MultiPoint>
 
-[21]: https://tools.ietf.org/html/rfc7946#section-3.1.3
+[17]: https://tools.ietf.org/html/rfc7946#section-3.1.3
 
-[22]: Feature<MultiPolygon>
+[18]: Feature<MultiPolygon>
 
-[23]: https://tools.ietf.org/html/rfc7946#section-3.1.7
+[19]: https://tools.ietf.org/html/rfc7946#section-3.1.7
 
-[24]: Feature<GeometryCollection>
+[20]: Feature<GeometryCollection>
 
-[25]: https://tools.ietf.org/html/rfc7946#section-3.1.8
+[21]: https://tools.ietf.org/html/rfc7946#section-3.1.8
 
-[26]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[22]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-<!-- This file is automatically generated. Please don't edit it directly:
-if you find an error, edit the source file (likely index.js), and re-run
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-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