@turf/invariant 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -6,11 +6,11 @@
 
 Unwrap a coordinate from a Point Feature, Geometry or a single coordinate.
 
-**Parameters**
+### Parameters
 
--   `coord` **([Array][1]<[number][2]> | [Geometry][3]<[Point][4]> | [Feature][5]<[Point][4]>)** GeoJSON Point or an Array of numbers
+*   `coord` **([Array][1]<[number][2]> | [Geometry][3]<[Point][4]> | [Feature][5]<[Point][4]>)** GeoJSON Point or an Array of numbers
 
-**Examples**
+### Examples
 
 ```javascript
 var pt = turf.point([10, 10]);
@@ -19,17 +19,17 @@ var coord = turf.getCoord(pt);
 //= [10, 10]
 ```
 
-Returns **[Array][1]&lt;[number][2]>** coordinates
+Returns **[Array][1]<[number][2]>** coordinates
 
 ## getCoords
 
 Unwrap coordinates from a Feature, Geometry Object or an Array
 
-**Parameters**
+### Parameters
 
--   `coords` **([Array][1]&lt;any> | [Geometry][3] \| [Feature][5])** Feature, Geometry Object or an Array
+*   `coords` **([Array][1]\<any> | [Geometry][3] | [Feature][5])** Feature, Geometry Object or an Array
 
-**Examples**
+### Examples
 
 ```javascript
 var poly = turf.polygon([[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]);
@@ -38,15 +38,15 @@ var coords = turf.getCoords(poly);
 //= [[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]
 ```
 
-Returns **[Array][1]&lt;any>** coordinates
+Returns **[Array][1]\<any>** coordinates
 
 ## containsNumber
 
 Checks if coordinates contains a number
 
-**Parameters**
+### Parameters
 
--   `coordinates` **[Array][1]&lt;any>** GeoJSON Coordinates
+*   `coordinates` **[Array][1]\<any>** GeoJSON Coordinates
 
 Returns **[boolean][6]** true if Array contains a number
 
@@ -54,52 +54,55 @@ Returns **[boolean][6]** true if Array contains a number
 
 Enforce expectations about types of GeoJSON objects for Turf.
 
-**Parameters**
+### Parameters
 
--   `value` **[GeoJSON][7]** any GeoJSON object
--   `type` **[string][8]** expected GeoJSON type
--   `name` **[string][8]** name of calling function
+*   `value` **[GeoJSON][7]** any GeoJSON object
+*   `type` **[string][8]** expected GeoJSON type
+*   `name` **[string][8]** name of calling function
 
+<!---->
 
--   Throws **[Error][9]** if value is not the expected type.
+*   Throws **[Error][9]** if value is not the expected type.
 
 ## featureOf
 
 Enforce expectations about types of [Feature][10] inputs for Turf.
 Internally this uses [geojsonType][11] to judge geometry types.
 
-**Parameters**
+### Parameters
 
--   `feature` **[Feature][5]** a feature with an expected geometry type
--   `type` **[string][8]** expected GeoJSON type
--   `name` **[string][8]** name of calling function
+*   `feature` **[Feature][5]** a feature with an expected geometry type
+*   `type` **[string][8]** expected GeoJSON type
+*   `name` **[string][8]** name of calling function
 
+<!---->
 
--   Throws **[Error][9]** error if value is not the expected type.
+*   Throws **[Error][9]** error if value is not the expected type.
 
 ## collectionOf
 
 Enforce expectations about types of [FeatureCollection][12] inputs for Turf.
 Internally this uses [geojsonType][11] to judge geometry types.
 
-**Parameters**
+### Parameters
 
--   `featureCollection` **[FeatureCollection][13]** a FeatureCollection for which features will be judged
--   `type` **[string][8]** expected GeoJSON type
--   `name` **[string][8]** name of calling function
+*   `featureCollection` **[FeatureCollection][13]** a FeatureCollection for which features will be judged
+*   `type` **[string][8]** expected GeoJSON type
+*   `name` **[string][8]** name of calling function
 
+<!---->
 
--   Throws **[Error][9]** if value is not the expected type.
+*   Throws **[Error][9]** if value is not the expected type.
 
 ## getGeom
 
 Get Geometry from Feature or Geometry Object
 
-**Parameters**
+### Parameters
 
--   `geojson` **([Feature][5] \| [Geometry][3])** GeoJSON Feature or Geometry Object
+*   `geojson` **([Feature][5] | [Geometry][3])** GeoJSON Feature or Geometry Object
 
-**Examples**
+### Examples
 
 ```javascript
 var point = {
@@ -114,26 +117,21 @@ var geom = turf.getGeom(point)
 //={"type": "Point", "coordinates": [110, 40]}
 ```
 
--   Throws **[Error][9]** if geojson is not a Feature or Geometry Object
+*   Throws **[Error][9]** if geojson is not a Feature or Geometry Object
 
 Returns **([Geometry][3] | null)** GeoJSON Geometry Object
 
-## getGeomType
-
-Get Geometry Type from Feature or Geometry Object
-
--   Throws **[Error][9]** **DEPRECATED** in v5.0.0 in favor of getType
-
 ## getType
 
 Get GeoJSON object's type, Geometry type is prioritize.
 
-**Parameters**
+### Parameters
 
--   `geojson` **[GeoJSON][7]** GeoJSON object
--   `name` **[string][8]** name of the variable to display in error message (optional, default `"geojson"`)
+*   `geojson` **[GeoJSON][7]** GeoJSON object
+*   `_name` **[string][8]?** 
+*   `name` **[string][8]** name of the variable to display in error message (unused) (optional, default `"geojson"`)
 
-**Examples**
+### Examples
 
 ```javascript
 var point = {

package/dist/es/index.js

@@ -1,4 +1,4 @@
-import { isNumber, } from "@turf/helpers";
+import { isNumber } from "@turf/helpers";
 /**
  * Unwrap a coordinate from a Point Feature, Geometry or a single coordinate.
  *
@@ -19,17 +19,17 @@ export function getCoord(coord) {
         if (coord.type === "Feature" &&
             coord.geometry !== null &&
             coord.geometry.type === "Point") {
-            return coord.geometry.coordinates;
+            return [...coord.geometry.coordinates];
         }
         if (coord.type === "Point") {
-            return coord.coordinates;
+            return [...coord.coordinates];
         }
     }
     if (Array.isArray(coord) &&
         coord.length >= 2 &&
         !Array.isArray(coord[0]) &&
         !Array.isArray(coord[1])) {
-        return coord;
+        return [...coord];
     }
     throw new Error("coord must be GeoJSON Point or an Array of numbers");
 }
@@ -152,8 +152,7 @@ export function collectionOf(featureCollection, type, name) {
     if (!featureCollection || featureCollection.type !== "FeatureCollection") {
         throw new Error("Invalid input to " + name + ", FeatureCollection required");
     }
-    for (var _i = 0, _a = featureCollection.features; _i < _a.length; _i++) {
-        var feature = _a[_i];
+    for (const feature of featureCollection.features) {
         if (!feature || feature.type !== "Feature" || !feature.geometry) {
             throw new Error("Invalid input to " + name + ", Feature with geometry required");
         }

package/dist/js/index.d.ts

@@ -1,4 +1,4 @@
-import { Feature, FeatureCollection, Geometries, GeometryCollection, Point } from "@turf/helpers";
+import { Feature, FeatureCollection, Geometry, LineString, MultiPoint, MultiLineString, MultiPolygon, Point, Polygon } from "geojson";
 /**
  * Unwrap a coordinate from a Point Feature, Geometry or a single coordinate.
  *
@@ -24,7 +24,7 @@ export declare function getCoord(coord: Feature<Point> | Point | number[]): numb
  * var coords = turf.getCoords(poly);
  * //= [[[119.32, -8.7], [119.55, -8.69], [119.51, -8.54], [119.32, -8.7]]]
  */
-export declare function getCoords<G extends Geometries>(coords: any[] | Feature<G> | G): any[];
+export declare function getCoords<G extends Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon>(coords: any[] | Feature<G> | G): any[];
 /**
  * Checks if coordinates contains a number
  *
@@ -83,7 +83,7 @@ export declare function collectionOf(featureCollection: FeatureCollection<any>,
  * var geom = turf.getGeom(point)
  * //={"type": "Point", "coordinates": [110, 40]}
  */
-export declare function getGeom<G extends Geometries | GeometryCollection>(geojson: Feature<G> | G): G;
+export declare function getGeom<G extends Geometry>(geojson: Feature<G> | G): G;
 /**
  * Get GeoJSON object's type, Geometry type is prioritize.
  *
@@ -102,4 +102,4 @@ export declare function getGeom<G extends Geometries | GeometryCollection>(geojs
  * var geom = turf.getType(point)
  * //="Point"
  */
-export declare function getType(geojson: Feature<any> | FeatureCollection<any> | Geometries | GeometryCollection, _name?: string): string;
+export declare function getType(geojson: Feature<any> | FeatureCollection<any> | Geometry, _name?: string): string;

package/dist/js/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var helpers_1 = require("@turf/helpers");
+const helpers_1 = require("@turf/helpers");
 /**
  * Unwrap a coordinate from a Point Feature, Geometry or a single coordinate.
  *
@@ -21,17 +21,17 @@ function getCoord(coord) {
         if (coord.type === "Feature" &&
             coord.geometry !== null &&
             coord.geometry.type === "Point") {
-            return coord.geometry.coordinates;
+            return [...coord.geometry.coordinates];
         }
         if (coord.type === "Point") {
-            return coord.coordinates;
+            return [...coord.coordinates];
         }
     }
     if (Array.isArray(coord) &&
         coord.length >= 2 &&
         !Array.isArray(coord[0]) &&
         !Array.isArray(coord[1])) {
-        return coord;
+        return [...coord];
     }
     throw new Error("coord must be GeoJSON Point or an Array of numbers");
 }
@@ -159,8 +159,7 @@ function collectionOf(featureCollection, type, name) {
     if (!featureCollection || featureCollection.type !== "FeatureCollection") {
         throw new Error("Invalid input to " + name + ", FeatureCollection required");
     }
-    for (var _i = 0, _a = featureCollection.features; _i < _a.length; _i++) {
-        var feature = _a[_i];
+    for (const feature of featureCollection.features) {
         if (!feature || feature.type !== "Feature" || !feature.geometry) {
             throw new Error("Invalid input to " + name + ", Feature with geometry required");
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/invariant",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf invariant module",
   "author": "Turf Authors",
   "contributors": [
@@ -30,6 +30,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -40,25 +41,26 @@
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
+    "bench": "tsx bench.js",
     "build": "npm-run-all build:*",
     "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
     "build:js": "tsc",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:tape": "tsx test.js",
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
     "benchmark": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.5.0"
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }