@turf/invariant 4.5.2 → 4.7.3

package/README.md

@@ -6,7 +6,16 @@ Unwrap a coordinate from a Point Feature, Geometry or a single coordinate.
 
 **Parameters**
 
--   `obj` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<any> | [Geometry](http://geojson.org/geojson-spec.html#geometry) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>)** any value
+-   `obj` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> | [Geometry](http://geojson.org/geojson-spec.html#geometry)<[Point](http://geojson.org/geojson-spec.html#point)> | [Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>)** Object
+
+**Examples**
+
+```javascript
+var pt = turf.point([10, 10]);
+
+var coord = turf.getCoord(pt);
+//= [10, 10]
+```
 
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** coordinates
 
@@ -16,9 +25,18 @@ Unwrap coordinates from a Feature, Geometry Object or an Array of numbers
 
 **Parameters**
 
--   `obj` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<any> | [Geometry](http://geojson.org/geojson-spec.html#geometry) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<any>)** any value
+-   `obj` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> | [Geometry](http://geojson.org/geojson-spec.html#geometry) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects))** Object
 
-Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<any>** coordinates
+**Examples**
+
+```javascript
+var poly = turf.polygon([[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]);
+
+var coord = turf.getCoords(poly);
+//= [[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]
+```
+
+Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** coordinates
 
 # containsNumber
 
@@ -77,7 +95,7 @@ Get Geometry from Feature or Geometry Object
 
 **Parameters**
 
--   `geojson` **([Feature](http://geojson.org/geojson-spec.html#feature-objects)<any> | [Geometry](http://geojson.org/geojson-spec.html#geometry)<any>)** GeoJSON Feature or Geometry Object
+-   `geojson` **([Feature](http://geojson.org/geojson-spec.html#feature-objects) \| [Geometry](http://geojson.org/geojson-spec.html#geometry))** GeoJSON Feature or Geometry Object
 
 **Examples**
 
@@ -90,13 +108,13 @@ var point = {
     "coordinates": [110, 40]
   }
 }
-var geom = invariant.getGeom(point)
+var geom = turf.getGeom(point)
 //={"type": "Point", "coordinates": [110, 40]}
 ```
 
 -   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** if geojson is not a Feature or Geometry Object
 
-Returns **[Geometry](http://geojson.org/geojson-spec.html#geometry)<any>** GeoJSON Geometry Object
+Returns **([Geometry](http://geojson.org/geojson-spec.html#geometry) | null)** GeoJSON Geometry Object
 
 # getGeomType
 
@@ -104,7 +122,7 @@ Get Geometry Type from Feature or Geometry Object
 
 **Parameters**
 
--   `geojson` **([Feature](http://geojson.org/geojson-spec.html#feature-objects)<any> | [Geometry](http://geojson.org/geojson-spec.html#geometry)<any>)** GeoJSON Feature or Geometry Object
+-   `geojson` **([Feature](http://geojson.org/geojson-spec.html#feature-objects) \| [Geometry](http://geojson.org/geojson-spec.html#geometry))** GeoJSON Feature or Geometry Object
 
 **Examples**
 
@@ -117,7 +135,7 @@ var point = {
     "coordinates": [110, 40]
   }
 }
-var geom = invariant.getGeom(point)
+var geom = turf.getGeomType(point)
 //="Point"
 ```
 

package/index.d.ts

@@ -38,7 +38,7 @@ export function containsNumber(coordinates: any[]): boolean;
 /**
  * http://turfjs.org/docs/
  */
-export function getGeom(geojson: GeometryCollection | GeometryObject | Feature<any>): boolean;
+export function getGeom(geojson: GeometryCollection | GeometryObject | Feature<any>): GeometryObject;
 
 /**
  * http://turfjs.org/docs/

package/index.js

@@ -2,11 +2,16 @@
  * Unwrap a coordinate from a Point Feature, Geometry or a single coordinate.
  *
  * @name getCoord
- * @param {Array<any>|Geometry|Feature<Point>} obj any value
+ * @param {Array<number>|Geometry<Point>|Feature<Point>} obj Object
  * @returns {Array<number>} coordinates
+ * @example
+ * var pt = turf.point([10, 10]);
+ *
+ * var coord = turf.getCoord(pt);
+ * //= [10, 10]
  */
 function getCoord(obj) {
-    if (!obj) throw new Error('No obj passed');
+    if (!obj) throw new Error('obj is required');
 
     var coordinates = getCoords(obj);
 
@@ -24,11 +29,16 @@ function getCoord(obj) {
  * Unwrap coordinates from a Feature, Geometry Object or an Array of numbers
  *
  * @name getCoords
- * @param {Array<any>|Geometry|Feature<any>} obj any value
- * @returns {Array<any>} coordinates
+ * @param {Array<number>|Geometry|Feature} obj Object
+ * @returns {Array<number>} coordinates
+ * @example
+ * var poly = turf.polygon([[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]);
+ *
+ * var coord = turf.getCoords(poly);
+ * //= [[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]
  */
 function getCoords(obj) {
-    if (!obj) throw new Error('No obj passed');
+    if (!obj) throw new Error('obj is required');
     var coordinates;
 
     // Array of numbers
@@ -139,8 +149,8 @@ function collectionOf(featureCollection, type, name) {
 /**
  * Get Geometry from Feature or Geometry Object
  *
- * @param {Feature<any>|Geometry<any>} geojson GeoJSON Feature or Geometry Object
- * @returns {Geometry<any>} GeoJSON Geometry Object
+ * @param {Feature|Geometry} geojson GeoJSON Feature or Geometry Object
+ * @returns {Geometry|null} GeoJSON Geometry Object
  * @throws {Error} if geojson is not a Feature or Geometry Object
  * @example
  * var point = {
@@ -151,20 +161,20 @@ function collectionOf(featureCollection, type, name) {
  *     "coordinates": [110, 40]
  *   }
  * }
- * var geom = invariant.getGeom(point)
+ * var geom = turf.getGeom(point)
  * //={"type": "Point", "coordinates": [110, 40]}
  */
 function getGeom(geojson) {
-    if (!geojson) throw new Error('<geojson> is required');
-    if (geojson.geometry) return geojson.geometry;
+    if (!geojson) throw new Error('geojson is required');
+    if (geojson.geometry !== undefined) return geojson.geometry;
     if (geojson.coordinates || geojson.geometries) return geojson;
-    throw new Error('<geojson> must be a Feature or Geometry Object');
+    throw new Error('geojson must be a valid Feature or Geometry Object');
 }
 
 /**
  * Get Geometry Type from Feature or Geometry Object
  *
- * @param {Feature<any>|Geometry<any>} geojson GeoJSON Feature or Geometry Object
+ * @param {Feature|Geometry} geojson GeoJSON Feature or Geometry Object
  * @returns {string} GeoJSON Geometry Type
  * @throws {Error} if geojson is not a Feature or Geometry Object
  * @example
@@ -176,11 +186,13 @@ function getGeom(geojson) {
  *     "coordinates": [110, 40]
  *   }
  * }
- * var geom = invariant.getGeom(point)
+ * var geom = turf.getGeomType(point)
  * //="Point"
  */
 function getGeomType(geojson) {
-    return getGeom(geojson).type;
+    if (!geojson) throw new Error('geojson is required');
+    var geom = getGeom(geojson);
+    if (geom) return geom.type;
 }
 
 module.exports = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/invariant",
-  "version": "4.5.2",
+  "version": "4.7.3",
   "description": "turf invariant module",
   "main": "index.js",
   "types": "index.d.ts",
@@ -28,8 +28,8 @@
     "url": "https://github.com/Turfjs/turf/issues"
   },
   "devDependencies": {
-    "@turf/helpers": "^4.5.2",
-    "benchmark": "^2.1.4",
-    "tape": "^4.6.3"
+    "@turf/helpers": "^4.7.3",
+    "benchmark": "2.1.4",
+    "tape": "4.8.0"
   }
 }