@turf/buffer 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -12,15 +12,16 @@ FeatureCollection, only valid members will be returned in the output
 FeatureCollection - i.e., the output collection may have fewer members than
 the input, or even be empty.
 
-**Parameters**
+### Parameters
 
--   `geojson` **([FeatureCollection][1] \| [Geometry][2] \| [Feature][3]<any>)** input to be buffered
--   `radius` **[number][4]** distance to draw the buffer (negative values are allowed)
--   `options` **[Object][5]** Optional parameters (optional, default `{}`)
-    -   `options.units` **[string][6]** any of the options supported by turf units (optional, default `"kilometers"`)
-    -   `options.steps` **[number][4]** number of steps (optional, default `8`)
+*   `geojson` **([FeatureCollection][1] | [Geometry][2] | [Feature][3]\<any>)** input to be buffered
+*   `radius` **[number][4]** distance to draw the buffer (negative values are allowed)
+*   `options` **[Object][5]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.units` **[string][6]** any of the options supported by turf units (optional, default `"kilometers"`)
+    *   `options.steps` **[number][4]** number of steps (optional, default `8`)
+
+### Examples
 
 ```javascript
 var point = turf.point([-90.548630, 14.616599]);
@@ -30,7 +31,7 @@ var buffered = turf.buffer(point, 500, {units: 'miles'});
 var addToMap = [point, buffered]
 ```
 
-Returns **([FeatureCollection][1] \| [Feature][3]&lt;([Polygon][7] \| [MultiPolygon][8])> | [undefined][9])** buffered features
+Returns **([FeatureCollection][1] | [Feature][3]<([Polygon][7] | [MultiPolygon][8])> | [undefined][9])** buffered features
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.3
 

package/dist/es/index.js

@@ -1,5 +1,5 @@
 import center from '@turf/center';
-import { GeoJSONReader, BufferOp, GeoJSONWriter } from 'turf-jsts';
+import { GeoJSONReader, BufferOp, GeoJSONWriter } from '@turf/jsts';
 import { featureEach, geomEach } from '@turf/meta';
 import { geoAzimuthalEquidistant } from 'd3-geo';
 import { featureCollection, earthRadius, radiansToLength, lengthToRadians, feature } from '@turf/helpers';

package/dist/js/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var center = require('@turf/center');
-var turfJsts = require('turf-jsts');
+var jsts = require('@turf/jsts');
 var meta = require('@turf/meta');
 var d3Geo = require('d3-geo');
 var helpers = require('@turf/helpers');
@@ -104,11 +104,11 @@ function bufferFeature(geojson, radius, units, steps) {
   };
 
   // JSTS buffer operation
-  var reader = new turfJsts.GeoJSONReader();
+  var reader = new jsts.GeoJSONReader();
   var geom = reader.read(projected);
   var distance = helpers.radiansToLength(helpers.lengthToRadians(radius, units), "meters");
-  var buffered = turfJsts.BufferOp.bufferOp(geom, distance, steps);
-  var writer = new turfJsts.GeoJSONWriter();
+  var buffered = jsts.BufferOp.bufferOp(geom, distance, steps);
+  var writer = new jsts.GeoJSONWriter();
   buffered = writer.write(buffered);
 
   // Detect if empty geometries

package/index.d.ts

@@ -9,8 +9,8 @@ import {
   GeometryCollection,
   Feature,
   FeatureCollection,
-  Units,
-} from "@turf/helpers";
+} from "geojson";
+import { Units } from "@turf/helpers";
 
 interface Options {
   units?: Units;
@@ -20,42 +20,22 @@ interface Options {
 /**
  * http://turfjs.org/docs/#buffer
  */
-declare function buffer<Geom extends Point | LineString | Polygon>(
-  feature: Feature<Geom> | Geom,
-  radius?: number,
-  options?: Options
-): Feature<Polygon>;
-declare function buffer<
-  Geom extends MultiPoint | MultiLineString | MultiPolygon
->(
-  feature: Feature<Geom> | Geom,
-  radius?: number,
-  options?: Options
-): Feature<MultiPolygon>;
-declare function buffer<Geom extends Point | LineString | Polygon>(
-  feature: FeatureCollection<Geom>,
-  radius?: number,
-  options?: Options
-): FeatureCollection<Polygon>;
-declare function buffer<
-  Geom extends MultiPoint | MultiLineString | MultiPolygon
->(
-  feature: FeatureCollection<Geom>,
-  radius?: number,
-  options?: Options
-): FeatureCollection<MultiPolygon>;
 declare function buffer(
   feature:
-    | FeatureCollection<any>
-    | Feature<GeometryCollection>
-    | GeometryCollection,
+    | Feature<GeometryObject>
+    | Point
+    | LineString
+    | Polygon
+    | MultiPoint
+    | MultiLineString
+    | MultiPolygon,
   radius?: number,
   options?: Options
-): FeatureCollection<Polygon | MultiPolygon>;
+): Feature<Polygon | MultiPolygon>;
 declare function buffer(
-  feature: Feature<any> | GeometryObject,
+  feature: FeatureCollection<GeometryObject> | GeometryCollection,
   radius?: number,
   options?: Options
-): Feature<Polygon | MultiPolygon>;
+): FeatureCollection<Polygon | MultiPolygon>;
 
 export default buffer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/buffer",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf buffer module",
   "author": "Turf Authors",
   "contributors": [
@@ -35,6 +35,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -46,30 +47,31 @@
     "index.d.ts"
   ],
   "scripts": {
-    "bench": "node -r esm bench.js",
+    "bench": "tsx bench.js",
     "build": "rollup -c ../../rollup.config.js && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "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": {
-    "@turf/truncate": "^6.5.0",
+    "@turf/truncate": "^7.0.0-alpha.1",
     "benchmark": "*",
     "load-json-file": "*",
     "npm-run-all": "*",
     "rollup": "*",
     "tape": "*",
+    "tsx": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/bbox": "^6.5.0",
-    "@turf/center": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/meta": "^6.5.0",
-    "@turf/projection": "^6.5.0",
-    "d3-geo": "1.7.1",
-    "turf-jsts": "*"
+    "@turf/bbox": "^7.0.0-alpha.1",
+    "@turf/center": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/jsts": "^2.7.1",
+    "@turf/meta": "^7.0.0-alpha.1",
+    "@turf/projection": "^7.0.0-alpha.1",
+    "d3-geo": "1.7.1"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }