@turf/bbox 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -4,13 +4,17 @@
 
 ## bbox
 
-Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
+Calculates the bounding box for any GeoJSON object, including FeatureCollection.
+Uses geojson.bbox if available and options.recompute is not set.
 
-**Parameters**
+### Parameters
 
--   `geojson` **[GeoJSON][1]** any GeoJSON object
+*   `geojson` **[GeoJSON][1]** any GeoJSON object
+*   `options` **[Object][2]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.recompute` **[boolean][3]?** Whether to ignore an existing bbox property on geojson
+
+### Examples
 
 ```javascript
 var line = turf.lineString([[-74, 40], [-78, 42], [-82, 35]]);
@@ -21,11 +25,15 @@ var bboxPolygon = turf.bboxPolygon(bbox);
 var addToMap = [line, bboxPolygon]
 ```
 
-Returns **[BBox][2]** bbox extent in [minX, minY, maxX, maxY] order
+Returns **[BBox][4]** bbox extent in \[minX, minY, maxX, maxY] order
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3
 
-[2]: https://tools.ietf.org/html/rfc7946#section-5
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[4]: https://tools.ietf.org/html/rfc7946#section-5
 
 <!-- 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

package/dist/es/index.js

@@ -1,9 +1,12 @@
 import { coordEach } from "@turf/meta";
 /**
- * Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
+ * Calculates the bounding box for any GeoJSON object, including FeatureCollection.
+ * Uses geojson.bbox if available and options.recompute is not set.
  *
  * @name bbox
  * @param {GeoJSON} geojson any GeoJSON object
+ * @param {Object} [options={}] Optional parameters
+ * @param {boolean} [options.recompute] Whether to ignore an existing bbox property on geojson
  * @returns {BBox} bbox extent in [minX, minY, maxX, maxY] order
  * @example
  * var line = turf.lineString([[-74, 40], [-78, 42], [-82, 35]]);
@@ -13,9 +16,12 @@ import { coordEach } from "@turf/meta";
  * //addToMap
  * var addToMap = [line, bboxPolygon]
  */
-function bbox(geojson) {
-    var result = [Infinity, Infinity, -Infinity, -Infinity];
-    coordEach(geojson, function (coord) {
+function bbox(geojson, options = {}) {
+    if (geojson.bbox != null && true !== options.recompute) {
+        return geojson.bbox;
+    }
+    const result = [Infinity, Infinity, -Infinity, -Infinity];
+    coordEach(geojson, (coord) => {
         if (result[0] > coord[0]) {
             result[0] = coord[0];
         }

package/dist/js/index.d.ts

@@ -1,9 +1,13 @@
-import { BBox } from "@turf/helpers";
+import { BBox } from "geojson";
+import { AllGeoJSON } from "@turf/helpers";
 /**
- * Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
+ * Calculates the bounding box for any GeoJSON object, including FeatureCollection.
+ * Uses geojson.bbox if available and options.recompute is not set.
  *
  * @name bbox
  * @param {GeoJSON} geojson any GeoJSON object
+ * @param {Object} [options={}] Optional parameters
+ * @param {boolean} [options.recompute] Whether to ignore an existing bbox property on geojson
  * @returns {BBox} bbox extent in [minX, minY, maxX, maxY] order
  * @example
  * var line = turf.lineString([[-74, 40], [-78, 42], [-82, 35]]);
@@ -13,5 +17,7 @@ import { BBox } from "@turf/helpers";
  * //addToMap
  * var addToMap = [line, bboxPolygon]
  */
-declare function bbox(geojson: any): BBox;
+declare function bbox(geojson: AllGeoJSON, options?: {
+    recompute?: boolean;
+}): BBox;
 export default bbox;

package/dist/js/index.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var meta_1 = require("@turf/meta");
+const meta_1 = require("@turf/meta");
 /**
- * Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
+ * Calculates the bounding box for any GeoJSON object, including FeatureCollection.
+ * Uses geojson.bbox if available and options.recompute is not set.
  *
  * @name bbox
  * @param {GeoJSON} geojson any GeoJSON object
+ * @param {Object} [options={}] Optional parameters
+ * @param {boolean} [options.recompute] Whether to ignore an existing bbox property on geojson
  * @returns {BBox} bbox extent in [minX, minY, maxX, maxY] order
  * @example
  * var line = turf.lineString([[-74, 40], [-78, 42], [-82, 35]]);
@@ -15,9 +18,12 @@ var meta_1 = require("@turf/meta");
  * //addToMap
  * var addToMap = [line, bboxPolygon]
  */
-function bbox(geojson) {
-    var result = [Infinity, Infinity, -Infinity, -Infinity];
-    meta_1.coordEach(geojson, function (coord) {
+function bbox(geojson, options = {}) {
+    if (geojson.bbox != null && true !== options.recompute) {
+        return geojson.bbox;
+    }
+    const result = [Infinity, Infinity, -Infinity, -Infinity];
+    meta_1.coordEach(geojson, (coord) => {
         if (result[0] > coord[0]) {
             result[0] = coord[0];
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/bbox",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf bbox module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -56,8 +57,9 @@
     "typescript": "*"
   },
   "dependencies": {
-    "@turf/helpers": "^6.4.0",
-    "@turf/meta": "^6.4.0"
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }