@turf/bbox-polygon 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -6,14 +6,15 @@
 
 Takes a bbox and returns an equivalent [polygon][1].
 
-**Parameters**
+### Parameters
 
--   `bbox` **[BBox][2]** extent in [minX, minY, maxX, maxY] order
--   `options` **[Object][3]** Optional parameters (optional, default `{}`)
-    -   `options.properties` **Properties** Translate properties to Polygon (optional, default `{}`)
-    -   `options.id` **([string][4] \| [number][5])** Translate Id to Polygon (optional, default `{}`)
+*   `bbox` **[BBox][2]** extent in \[minX, minY, maxX, maxY] order
+*   `options` **[Object][3]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.properties` **Properties** Translate properties to Polygon (optional, default `{}`)
+    *   `options.id` **([string][4] | [number][5])** Translate Id to Polygon (optional, default `{}`)
+
+### Examples
 
 ```javascript
 var bbox = [0, 0, 10, 10];
@@ -24,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][7]>** a Polygon representation of the bounding box
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.6
 

package/dist/es/index.js

@@ -16,21 +16,20 @@ import { polygon } from "@turf/helpers";
  * //addToMap
  * var addToMap = [poly]
  */
-export default function bboxPolygon(bbox, options) {
-    if (options === void 0) { options = {}; }
+export default function bboxPolygon(bbox, options = {}) {
     // Convert BBox positions to Numbers
     // No performance loss for including Number()
     // https://github.com/Turfjs/turf/issues/1119
-    var west = Number(bbox[0]);
-    var south = Number(bbox[1]);
-    var east = Number(bbox[2]);
-    var north = Number(bbox[3]);
+    const west = Number(bbox[0]);
+    const south = Number(bbox[1]);
+    const east = Number(bbox[2]);
+    const north = Number(bbox[3]);
     if (bbox.length === 6) {
         throw new Error("@turf/bbox-polygon does not support BBox with 6 positions");
     }
-    var lowLeft = [west, south];
-    var topLeft = [west, north];
-    var topRight = [east, north];
-    var lowRight = [east, south];
-    return polygon([[lowLeft, lowRight, topRight, topLeft, lowLeft]], options.properties, { bbox: bbox, id: options.id });
+    const lowLeft = [west, south];
+    const topLeft = [west, north];
+    const topRight = [east, north];
+    const lowRight = [east, south];
+    return polygon([[lowLeft, lowRight, topRight, topLeft, lowLeft]], options.properties, { bbox, id: options.id });
 }

package/dist/js/index.d.ts

@@ -1,4 +1,5 @@
-import { BBox, Feature, Id, Polygon, Properties } from "@turf/helpers";
+import { BBox, Feature, Polygon, GeoJsonProperties } from "geojson";
+import { Id } from "@turf/helpers";
 /**
  * Takes a bbox and returns an equivalent {@link Polygon|polygon}.
  *
@@ -16,7 +17,7 @@ import { BBox, Feature, Id, Polygon, Properties } from "@turf/helpers";
  * //addToMap
  * var addToMap = [poly]
  */
-export default function bboxPolygon<P = Properties>(bbox: BBox, options?: {
+export default function bboxPolygon<P = GeoJsonProperties>(bbox: BBox, options?: {
     properties?: P;
     id?: Id;
 }): Feature<Polygon, P>;

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");
 /**
  * Takes a bbox and returns an equivalent {@link Polygon|polygon}.
  *
@@ -18,22 +18,21 @@ var helpers_1 = require("@turf/helpers");
  * //addToMap
  * var addToMap = [poly]
  */
-function bboxPolygon(bbox, options) {
-    if (options === void 0) { options = {}; }
+function bboxPolygon(bbox, options = {}) {
     // Convert BBox positions to Numbers
     // No performance loss for including Number()
     // https://github.com/Turfjs/turf/issues/1119
-    var west = Number(bbox[0]);
-    var south = Number(bbox[1]);
-    var east = Number(bbox[2]);
-    var north = Number(bbox[3]);
+    const west = Number(bbox[0]);
+    const south = Number(bbox[1]);
+    const east = Number(bbox[2]);
+    const north = Number(bbox[3]);
     if (bbox.length === 6) {
         throw new Error("@turf/bbox-polygon does not support BBox with 6 positions");
     }
-    var lowLeft = [west, south];
-    var topLeft = [west, north];
-    var topRight = [east, north];
-    var lowRight = [east, south];
-    return helpers_1.polygon([[lowLeft, lowRight, topRight, topLeft, lowLeft]], options.properties, { bbox: bbox, id: options.id });
+    const lowLeft = [west, south];
+    const topLeft = [west, north];
+    const topRight = [east, north];
+    const lowRight = [east, south];
+    return helpers_1.polygon([[lowLeft, lowRight, topRight, topLeft, lowLeft]], options.properties, { bbox, id: options.id });
 }
 exports.default = bboxPolygon;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/bbox-polygon",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf bbox-polygon module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -28,6 +28,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -38,25 +39,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:tape": "tsx test.js"
   },
   "devDependencies": {
     "@types/tape": "*",
     "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"
 }