@turf/clusters 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -6,12 +6,12 @@
 
 Get Cluster
 
-**Parameters**
+### Parameters
 
--   `geojson` **[FeatureCollection][1]** GeoJSON Features
--   `filter` **any** Filter used on GeoJSON properties to get Cluster
+*   `geojson` **[FeatureCollection][1]** GeoJSON Features
+*   `filter` **any** Filter used on GeoJSON properties to get Cluster
 
-**Examples**
+### Examples
 
 ```javascript
 var geojson = turf.featureCollection([
@@ -44,11 +44,11 @@ Callback for clusterEach
 
 Type: [Function][2]
 
-**Parameters**
+### Parameters
 
--   `cluster` **[FeatureCollection][1]?** The current cluster being processed.
--   `clusterValue` **any?** Value used to create cluster being processed.
--   `currentIndex` **[number][3]?** The index of the current element being processed in the array.Starts at index 0
+*   `cluster` **[FeatureCollection][1]?** The current cluster being processed.
+*   `clusterValue` **any?** Value used to create cluster being processed.
+*   `currentIndex` **[number][3]?** The index of the current element being processed in the array.Starts at index 0
 
 Returns **void** 
 
@@ -56,13 +56,13 @@ Returns **void**
 
 clusterEach
 
-**Parameters**
+### Parameters
 
--   `geojson` **[FeatureCollection][1]** GeoJSON Features
--   `property` **([string][4] \| [number][3])** GeoJSON property key/value used to create clusters
--   `callback` **[Function][2]** a method that takes (cluster, clusterValue, currentIndex)
+*   `geojson` **[FeatureCollection][1]** GeoJSON Features
+*   `property` **([string][4] | [number][3])** GeoJSON property key/value used to create clusters
+*   `callback` **[Function][2]** a method that takes (cluster, clusterValue, currentIndex)
 
-**Examples**
+### Examples
 
 ```javascript
 var geojson = turf.featureCollection([
@@ -107,37 +107,37 @@ on whether the reduce method has an initialValue argument.
 
 If an initialValue is provided to the reduce method:
 
--   The previousValue argument is initialValue.
--   The currentValue argument is the value of the first element present in the array.
+*   The previousValue argument is initialValue.
+*   The currentValue argument is the value of the first element present in the array.
 
 If an initialValue is not provided:
 
--   The previousValue argument is the value of the first element present in the array.
--   The currentValue argument is the value of the second element present in the array.
+*   The previousValue argument is the value of the first element present in the array.
+*   The currentValue argument is the value of the second element present in the array.
 
 Type: [Function][2]
 
-**Parameters**
+### Parameters
 
--   `previousValue` **any?** The accumulated value previously returned in the last invocation
+*   `previousValue` **any?** The accumulated value previously returned in the last invocation
     of the callback, or initialValue, if supplied.
--   `cluster` **[FeatureCollection][1]?** The current cluster being processed.
--   `clusterValue` **any?** Value used to create cluster being processed.
--   `currentIndex` **[number][3]?** The index of the current element being processed in the
+*   `cluster` **[FeatureCollection][1]?** The current cluster being processed.
+*   `clusterValue` **any?** Value used to create cluster being processed.
+*   `currentIndex` **[number][3]?** The index of the current element being processed in the
     array. Starts at index 0, if an initialValue is provided, and at index 1 otherwise.
 
 ## clusterReduce
 
 Reduce clusters in GeoJSON Features, similar to Array.reduce()
 
-**Parameters**
+### Parameters
 
--   `geojson` **[FeatureCollection][1]** GeoJSON Features
--   `property` **([string][4] \| [number][3])** GeoJSON property key/value used to create clusters
--   `callback` **[Function][2]** a method that takes (previousValue, cluster, clusterValue, currentIndex)
--   `initialValue` **any?** Value to use as the first argument to the first call of the callback.
+*   `geojson` **[FeatureCollection][1]** GeoJSON Features
+*   `property` **([string][4] | [number][3])** GeoJSON property key/value used to create clusters
+*   `callback` **[Function][2]** a method that takes (previousValue, cluster, clusterValue, currentIndex)
+*   `initialValue` **any?** Value to use as the first argument to the first call of the callback.
 
-**Examples**
+### Examples
 
 ```javascript
 var geojson = turf.featureCollection([

package/dist/es/index.js

@@ -208,9 +208,9 @@ export function createBins(geojson, property) {
     var bins = {};
     featureEach(geojson, function (feature, i) {
         var properties = feature.properties || {};
-        if (properties.hasOwnProperty(String(property))) {
+        if (Object.prototype.hasOwnProperty.call(properties, String(property))) {
             var value = properties[property];
-            if (bins.hasOwnProperty(value))
+            if (Object.prototype.hasOwnProperty.call(bins, value))
                 bins[value].push(i);
             else
                 bins[value] = [i];
@@ -232,7 +232,7 @@ export function applyFilter(properties, filter) {
     var filterType = typeof filter;
     // String & Number
     if (filterType === "number" || filterType === "string")
-        return properties.hasOwnProperty(filter);
+        return Object.prototype.hasOwnProperty.call(properties, filter);
     // Array
     else if (Array.isArray(filter)) {
         for (var i = 0; i < filter.length; i++) {
@@ -287,7 +287,7 @@ export function filterProperties(properties, keys) {
     var newProperties = {};
     for (var i = 0; i < keys.length; i++) {
         var key = keys[i];
-        if (properties.hasOwnProperty(key))
+        if (Object.prototype.hasOwnProperty.call(properties, key))
             newProperties[key] = properties[key];
     }
     return newProperties;

package/dist/js/index.d.ts

@@ -1,4 +1,4 @@
-import { FeatureCollection } from "@turf/helpers";
+import { FeatureCollection, GeometryObject } from "geojson";
 /**
  * Get Cluster
  *
@@ -28,7 +28,7 @@ import { FeatureCollection } from "@turf/helpers";
  * turf.getCluster(clustered, {'marker-symbol': 'square'}).length;
  * //= 1
  */
-export declare function getCluster<G extends any, P = any>(geojson: FeatureCollection<G, P>, filter: any): FeatureCollection<G, P>;
+export declare function getCluster<G extends GeometryObject, P = any>(geojson: FeatureCollection<G, P>, filter: any): FeatureCollection<G, P>;
 /**
  * Callback for clusterEach
  *
@@ -77,7 +77,7 @@ export declare function getCluster<G extends any, P = any>(geojson: FeatureColle
  *     values.push(clusterValue);
  * });
  */
-export declare function clusterEach<G = any, P = any>(geojson: FeatureCollection<G, P>, property: number | string, callback: (cluster?: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void): void;
+export declare function clusterEach<G extends GeometryObject, P = any>(geojson: FeatureCollection<G, P>, property: number | string, callback: (cluster: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void): void;
 /**
  * Callback for clusterReduce
  *
@@ -141,7 +141,7 @@ export declare function clusterEach<G = any, P = any>(geojson: FeatureCollection
  *     return previousValue.concat(clusterValue);
  * }, []);
  */
-export declare function clusterReduce<G = any, P = any>(geojson: FeatureCollection<G, P>, property: number | string, callback: (previousValue?: any, cluster?: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void, initialValue?: any): void;
+export declare function clusterReduce<G extends GeometryObject, P = any>(geojson: FeatureCollection<G, P>, property: number | string, callback: (previousValue: any | undefined, cluster: FeatureCollection<G, P>, clusterValue?: any, currentIndex?: number) => void, initialValue?: any): void;
 /**
  * Create Bins
  *
@@ -168,7 +168,7 @@ export declare function createBins(geojson: FeatureCollection<any>, property: st
  * @param {*} filter Filter
  * @returns {boolean} applied Filter to properties
  */
-export declare function applyFilter(properties: any, filter: any): any;
+export declare function applyFilter(properties: any, filter: any): boolean;
 /**
  * Properties contains filter (does not apply deepEqual operations)
  *

package/dist/js/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var meta_1 = require("@turf/meta");
-var helpers_1 = require("@turf/helpers");
+const meta_1 = require("@turf/meta");
+const helpers_1 = require("@turf/helpers");
 /**
  * Get Cluster
  *
@@ -213,9 +213,9 @@ function createBins(geojson, property) {
     var bins = {};
     meta_1.featureEach(geojson, function (feature, i) {
         var properties = feature.properties || {};
-        if (properties.hasOwnProperty(String(property))) {
+        if (Object.prototype.hasOwnProperty.call(properties, String(property))) {
             var value = properties[property];
-            if (bins.hasOwnProperty(value))
+            if (Object.prototype.hasOwnProperty.call(bins, value))
                 bins[value].push(i);
             else
                 bins[value] = [i];
@@ -238,7 +238,7 @@ function applyFilter(properties, filter) {
     var filterType = typeof filter;
     // String & Number
     if (filterType === "number" || filterType === "string")
-        return properties.hasOwnProperty(filter);
+        return Object.prototype.hasOwnProperty.call(properties, filter);
     // Array
     else if (Array.isArray(filter)) {
         for (var i = 0; i < filter.length; i++) {
@@ -295,7 +295,7 @@ function filterProperties(properties, keys) {
     var newProperties = {};
     for (var i = 0; i < keys.length; i++) {
         var key = keys[i];
-        if (properties.hasOwnProperty(key))
+        if (Object.prototype.hasOwnProperty.call(properties, key))
             newProperties[key] = properties[key];
     }
     return newProperties;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/clusters",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf clusters module",
   "author": "Turf Authors",
   "contributors": [
@@ -15,6 +15,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -47,7 +48,7 @@
     "docs": "node ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
     "test:tape": "ts-node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
     "@types/tape": "*",
@@ -59,8 +60,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"
 }