@turf/clusters-dbscan 6.5.0 → 7.0.0-alpha.1

package/README.md

@@ -6,17 +6,18 @@
 
 Takes a set of [points][1] and partition them into clusters according to [https://en.wikipedia.org/wiki/DBSCAN][2] data clustering algorithm.
 
-**Parameters**
-
--   `points` **[FeatureCollection][3]<[Point][4]>** to be clustered
--   `maxDistance` **[number][5]** Maximum Distance between any point of the cluster to generate the clusters (kilometers only)
--   `options` **[Object][6]** Optional parameters (optional, default `{}`)
-    -   `options.units` **[string][7]** in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
-    -   `options.mutate` **[boolean][8]** Allows GeoJSON input to be mutated (optional, default `false`)
-    -   `options.minPoints` **[number][5]** Minimum number of points to generate a single cluster,
+### Parameters
+
+*   `points` **[FeatureCollection][3]<[Point][4]>** to be clustered
+*   `maxDistance` **[number][5]** Maximum Distance between any point of the cluster to generate the clusters (kilometers only)
+*   `options` **[Object][6]** Optional parameters (optional, default `{}`)
+
+    *   `options.units` **[string][7]** in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)
+    *   `options.mutate` **[boolean][8]** Allows GeoJSON input to be mutated (optional, default `false`)
+    *   `options.minPoints` **[number][5]** Minimum number of points to generate a single cluster,
         points which do not meet this requirement will be classified as an 'edge' or 'noise'. (optional, default `3`)
 
-**Examples**
+### Examples
 
 ```javascript
 // create random points with random z-values in their properties
@@ -28,8 +29,8 @@ var clustered = turf.clustersDbscan(points, maxDistance);
 var addToMap = [clustered];
 ```
 
-Returns **[FeatureCollection][3]&lt;[Point][4]>** Clustered Points with an additional two properties associated to each Feature:-   {number} cluster - the associated clusterId
--   {string} dbscan - type of point it has been classified as ('core'|'edge'|'noise')
+Returns **[FeatureCollection][3]<[Point][4]>** Clustered Points with an additional two properties associated to each Feature:*   {number} cluster - the associated clusterId
+*   {string} dbscan - type of point it has been classified as ('core'|'edge'|'noise')
 
 [1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
 

package/dist/es/index.js

@@ -1,7 +1,7 @@
 import clone from "@turf/clone";
 import distance from "@turf/distance";
 import { coordAll } from "@turf/meta";
-import { convertLength, } from "@turf/helpers";
+import { convertLength } from "@turf/helpers";
 import clustering from "density-clustering";
 /**
  * Takes a set of {@link Point|points} and partition them into clusters according to {@link DBSCAN's|https://en.wikipedia.org/wiki/DBSCAN} data clustering algorithm.
@@ -26,13 +26,12 @@ import clustering from "density-clustering";
  * //addToMap
  * var addToMap = [clustered];
  */
-function clustersDbscan(points, maxDistance, options) {
+function clustersDbscan(points, maxDistance, options = {}) {
     // Input validation being handled by Typescript
     // collectionOf(points, 'Point', 'points must consist of a FeatureCollection of only Points');
     // if (maxDistance === null || maxDistance === undefined) throw new Error('maxDistance is required');
     // if (!(Math.sign(maxDistance) > 0)) throw new Error('maxDistance is invalid');
     // if (!(minPoints === undefined || minPoints === null || Math.sign(minPoints) > 0)) throw new Error('options.minPoints is invalid');
-    if (options === void 0) { options = {}; }
     // Clone points to prevent any mutations
     if (options.mutate !== true)
         points = clone(points);

package/dist/js/index.d.ts

@@ -1,6 +1,7 @@
-import { Properties, Units, FeatureCollection, Point } from "@turf/helpers";
+import { GeoJsonProperties, FeatureCollection, Point } from "geojson";
+import { Units } from "@turf/helpers";
 export declare type Dbscan = "core" | "edge" | "noise";
-export declare type DbscanProps = Properties & {
+export declare type DbscanProps = GeoJsonProperties & {
     dbscan?: Dbscan;
     cluster?: number;
 };

package/dist/js/index.js

@@ -1,13 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var clone_1 = __importDefault(require("@turf/clone"));
-var distance_1 = __importDefault(require("@turf/distance"));
-var meta_1 = require("@turf/meta");
-var helpers_1 = require("@turf/helpers");
-var density_clustering_1 = __importDefault(require("density-clustering"));
+const tslib_1 = require("tslib");
+const clone_1 = tslib_1.__importDefault(require("@turf/clone"));
+const distance_1 = tslib_1.__importDefault(require("@turf/distance"));
+const meta_1 = require("@turf/meta");
+const helpers_1 = require("@turf/helpers");
+const density_clustering_1 = tslib_1.__importDefault(require("density-clustering"));
 /**
  * Takes a set of {@link Point|points} and partition them into clusters according to {@link DBSCAN's|https://en.wikipedia.org/wiki/DBSCAN} data clustering algorithm.
  *
@@ -31,13 +29,12 @@ var density_clustering_1 = __importDefault(require("density-clustering"));
  * //addToMap
  * var addToMap = [clustered];
  */
-function clustersDbscan(points, maxDistance, options) {
+function clustersDbscan(points, maxDistance, options = {}) {
     // Input validation being handled by Typescript
     // collectionOf(points, 'Point', 'points must consist of a FeatureCollection of only Points');
     // if (maxDistance === null || maxDistance === undefined) throw new Error('maxDistance is required');
     // if (!(Math.sign(maxDistance) > 0)) throw new Error('maxDistance is invalid');
     // if (!(minPoints === undefined || minPoints === null || Math.sign(minPoints) > 0)) throw new Error('options.minPoints is invalid');
-    if (options === void 0) { options = {}; }
     // Clone points to prevent any mutations
     if (options.mutate !== true)
         points = clone_1.default(points);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/clusters-dbscan",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf clusters-dbscan module",
   "author": "Turf Authors",
   "contributors": [
@@ -35,6 +35,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -45,37 +46,38 @@
     "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": {
-    "@turf/centroid": "^6.5.0",
-    "@turf/clusters": "^6.5.0",
+    "@turf/centroid": "^7.0.0-alpha.1",
+    "@turf/clusters": "^7.0.0-alpha.1",
     "@types/density-clustering": "^1.3.0",
     "@types/tape": "*",
     "benchmark": "*",
     "chromatism": "*",
-    "concaveman": "*",
+    "concaveman": "^1.2.1",
     "load-json-file": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*",
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/clone": "^6.5.0",
-    "@turf/distance": "^6.5.0",
-    "@turf/helpers": "^6.5.0",
-    "@turf/meta": "^6.5.0",
-    "density-clustering": "1.3.0"
+    "@turf/clone": "^7.0.0-alpha.1",
+    "@turf/distance": "^7.0.0-alpha.1",
+    "@turf/helpers": "^7.0.0-alpha.1",
+    "@turf/meta": "^7.0.0-alpha.1",
+    "density-clustering": "1.3.0",
+    "tslib": "^2.3.0"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }