@turf/helpers 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -2,35 +2,42 @@
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-## earthRadius
+## helpers
+
+### earthRadius
 
 Earth Radius used with the Harvesine formula and approximates using a spherical (non-ellipsoid) Earth.
 
-## factors
+Type: [number][1]
+
+### factors
 
 Unit of measurement factors using a spherical (non-ellipsoid) earth radius.
 
-## unitsFactors
+Keys are the name of the unit, values are the number of that unit in a single radian
 
-Units of measurement factors based on 1 meter.
+Type: [Object][2]
 
-## areaFactors
+### areaFactors
 
 Area of measurement factors based on 1 square meter.
 
+Type: [Object][2]
+
 ## feature
 
-Wraps a GeoJSON [Geometry][1] in a GeoJSON [Feature][2].
+Wraps a GeoJSON [Geometry][3] in a GeoJSON [Feature][4].
 
-**Parameters**
+### Parameters
 
--   `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
+*   `geometry` **[Geometry][5]** input geometry
+*   `properties` **[Object][2]** an Object of key-value pairs to add as properties (optional, default `{}`)
+*   `options` **[Object][2]** Optional Parameters (optional, default `{}`)
 
-**Examples**
+    *   `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
+
+### Examples
 
 ```javascript
 var geometry = {
@@ -47,42 +54,40 @@ Returns **[Feature][8]** a GeoJSON Feature
 
 ## geometry
 
-Creates a GeoJSON [Geometry][1] from a Geometry string type & coordinates.
+Creates a GeoJSON [Geometry][3] 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][7]** Geometry Type
+*   `coordinates` **[Array][6]\<any>** Coordinates
+*   `options` **[Object][2]** 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][4] from a Position.
+
+### Parameters
 
-**Parameters**
+*   `coordinates` **[Array][6]<[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 `{}`)
 
--   `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][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
 
-**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][8]<[Point][10]>** a Point feature
 
 ## points
 
 Creates a [Point][9] [FeatureCollection][11] from an Array of Point coordinates.
 
-**Parameters**
+### Parameters
+
+*   `coordinates` **[Array][6]<[Array][6]<[number][1]>>** an array of Points
+*   `properties` **[Object][2]** Translate these properties to each Feature (optional, default `{}`)
+*   `options` **[Object][2]** Optional Parameters (optional, default `{}`)
 
--   `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
+    *   `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north]
+        associated with the FeatureCollection
+    *   `options.id` **([string][7] | [number][1])?** Identifier associated with the FeatureCollection
 
-**Examples**
+### 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][12]<[Point][10]>** Point Feature
 
 ## polygon
 
-Creates a [Polygon][13] [Feature][2] from an Array of LinearRings.
+Creates a [Polygon][13] [Feature][4] from an Array of LinearRings.
 
-**Parameters**
+### Parameters
 
--   `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
+*   `coordinates` **[Array][6]<[Array][6]<[Array][6]<[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 `{}`)
 
-**Examples**
+    *   `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
+
+### 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][8]<[Polygon][14]>** Polygon Feature
 
 ## polygons
 
 Creates a [Polygon][13] [FeatureCollection][11] from an Array of Polygon coordinates.
 
-**Parameters**
+### Parameters
+
+*   `coordinates` **[Array][6]<[Array][6]<[Array][6]<[Array][6]<[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 `{}`)
 
--   `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
+    *   `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
 
-**Examples**
+### 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][12]<[Polygon][14]>** Polygon FeatureCollection
 
 ## lineString
 
-Creates a [LineString][15] [Feature][2] from an Array of Positions.
+Creates a [LineString][15] [Feature][4] from an Array of Positions.
 
-**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][6]<[Array][6]<[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 `{}`)
 
-**Examples**
+    *   `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
+
+### 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][8]<[LineString][16]>** LineString Feature
 
 ## lineStrings
 
 Creates a [LineString][15] [FeatureCollection][11] from an Array of LineString coordinates.
 
-**Parameters**
+### Parameters
+
+*   `coordinates` **[Array][6]<[Array][6]<[Array][6]<[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 `{}`)
 
--   `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
+    *   `options.bbox` **[Array][6]<[number][1]>?** Bounding Box Array \[west, south, east, north]
+        associated with the FeatureCollection
+    *   `options.id` **([string][7] | [number][1])?** Identifier associated with the FeatureCollection
 
-**Examples**
+### 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][12]<[LineString][16]>** LineString FeatureCollection
 
 ## featureCollection
 
-Takes one or more [Features][2] and creates a [FeatureCollection][11].
+Takes one or more [Features][4] and creates a [FeatureCollection][11].
+
+### Parameters
 
-**Parameters**
+*   `features` **[Array][6]<[Feature][8]>** input features
+*   `options` **[Object][2]** 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][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
 
-**Examples**
+### Examples
 
 ```javascript
 var locationA = turf.point([-75.343, 39.984], {name: 'Location A'});
@@ -245,18 +258,19 @@ Returns **[FeatureCollection][12]** FeatureCollection of Features
 
 ## multiLineString
 
-Creates a [Feature&lt;MultiLineString>][17] based on a
+Creates a [Feature\<MultiLineString>][17] based on a
 coordinate array. Properties can be added optionally.
 
-**Parameters**
+### Parameters
 
--   `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
+*   `coordinates` **[Array][6]<[Array][6]<[Array][6]<[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 `{}`)
 
-**Examples**
+    *   `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
+
+### 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][18]** if no coordinates are passed
 
-Returns **[Feature][8]&lt;[MultiLineString][19]>** a MultiLineString feature
+Returns **[Feature][8]<[MultiLineString][19]>** a MultiLineString feature
 
 ## multiPoint
 
-Creates a [Feature&lt;MultiPoint>][20] based on a
+Creates a [Feature\<MultiPoint>][20] based on a
 coordinate array. Properties can be added optionally.
 
-**Parameters**
+### Parameters
+
+*   `coordinates` **[Array][6]<[Array][6]<[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 `{}`)
 
--   `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][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
 
-**Examples**
+### 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][18]** if no coordinates are passed
 
-Returns **[Feature][8]&lt;[MultiPoint][21]>** a MultiPoint feature
+Returns **[Feature][8]<[MultiPoint][21]>** a MultiPoint feature
 
 ## multiPolygon
 
-Creates a [Feature&lt;MultiPolygon>][22] based on a
+Creates a [Feature\<MultiPolygon>][22] based on a
 coordinate array. Properties can be added optionally.
 
-**Parameters**
+### Parameters
 
--   `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
+*   `coordinates` **[Array][6]<[Array][6]<[Array][6]<[Array][6]<[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 `{}`)
 
-**Examples**
+    *   `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
+
+### 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][18]** if no coordinates are passed
 
-Returns **[Feature][8]&lt;[MultiPolygon][23]>** a multipolygon feature
+Returns **[Feature][8]<[MultiPolygon][23]>** a multipolygon feature
 
 ## geometryCollection
 
-Creates a [Feature&lt;GeometryCollection>][24] based on a
+Creates a [Feature\<GeometryCollection>][24] based on a
 coordinate array. Properties can be added optionally.
 
-**Parameters**
+### Parameters
+
+*   `geometries` **[Array][6]<[Geometry][5]>** 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 `{}`)
 
--   `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
+    *   `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
 
-**Examples**
+### 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][8]<[GeometryCollection][25]>** a GeoJSON GeometryCollection Feature
 
 ## round
 
 Round number to precision
 
-**Parameters**
+### Parameters
 
--   `num` **[number][6]** Number
--   `precision` **[number][6]** Precision (optional, default `0`)
+*   `num` **[number][1]** Number
+*   `precision` **[number][1]** Precision (optional, default `0`)
 
-**Examples**
+### Examples
 
 ```javascript
 turf.round(120.4321)
@@ -368,110 +379,113 @@ turf.round(120.4321, 2)
 //=120.43
 ```
 
-Returns **[number][6]** rounded number
+Returns **[number][1]** 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][1]** in radians across the sphere
+*   `units` **[string][7]** can be degrees, radians, miles, inches, yards, metres,
+    meters, kilometres, kilometers. (optional, default `"kilometers"`)
 
-Returns **[number][6]** distance
+Returns **[number][1]** 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][1]** in real units
+*   `units` **[string][7]** can be degrees, radians, miles, inches, yards, metres,
+    meters, kilometres, kilometers. (optional, default `"kilometers"`)
 
-Returns **[number][6]** radians
+Returns **[number][1]** 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][1]** in real units
+*   `units` **[string][7]** can be degrees, radians, miles, inches, yards, metres,
+    meters, kilometres, kilometers. (optional, default `"kilometers"`)
 
-Returns **[number][6]** degrees
+Returns **[number][1]** 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][6]** angle, between -180 and +180 degrees
+*   `bearing` **[number][1]** angle, between -180 and +180 degrees
 
-Returns **[number][6]** angle between 0 and 360 degrees
+Returns **[number][1]** angle between 0 and 360 degrees
 
 ## radiansToDegrees
 
 Converts an angle in radians to degrees
 
-**Parameters**
+### Parameters
 
--   `radians` **[number][6]** angle in radians
+*   `radians` **[number][1]** angle in radians
 
-Returns **[number][6]** degrees between 0 and 360 degrees
+Returns **[number][1]** 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][1]** angle between 0 and 360 degrees
 
-Returns **[number][6]** angle in radians
+Returns **[number][1]** 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][1]** 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][1]** 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][1]** 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][1]** the converted area
 
 ## isNumber
 
 isNumber
 
-**Parameters**
+### Parameters
 
--   `num` **any** Number to validate
+*   `num` **any** Number to validate
 
-**Examples**
+### Examples
 
 ```javascript
 turf.isNumber(123)
@@ -486,11 +500,11 @@ Returns **[boolean][26]** true/false
 
 isObject
 
-**Parameters**
+### Parameters
 
--   `input` **any** variable to validate
+*   `input` **any** variable to validate
 
-**Examples**
+### Examples
 
 ```javascript
 turf.isObject({elevation: 10})
@@ -499,19 +513,19 @@ turf.isObject('foo')
 //=false
 ```
 
-Returns **[boolean][26]** true/false
+Returns **[boolean][26]** true/false, including false for Arrays and Functions
 
-[1]: https://tools.ietf.org/html/rfc7946#section-3.1
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[2]: https://tools.ietf.org/html/rfc7946#section-3.2
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
 [3]: https://tools.ietf.org/html/rfc7946#section-3.1
 
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[4]: https://tools.ietf.org/html/rfc7946#section-3.2
 
-[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://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
 [7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String