@turf/sample 7.0.0-alpha.2 → 7.0.0

package/README.md

@@ -36,26 +36,21 @@ Returns **[FeatureCollection][3]** a FeatureCollection with `n` features
 
 [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-<!-- 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
-./scripts/generate-readmes in the turf project. -->
+<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
 
 ---
 
-This module is part of the [Turfjs project](http://turfjs.org/), an open source
-module collection dedicated to geographic algorithms. It is maintained in the
-[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
-PRs and issues.
+This module is part of the [Turfjs project](https://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues.
 
 ### Installation
 
-Install this module individually:
+Install this single module individually:
 
 ```sh
 $ npm install @turf/sample
 ```
 
-Or install the Turf module that includes it as a function:
+Or install the all-encompassing @turf/turf module that includes all modules as functions:
 
 ```sh
 $ npm install @turf/turf

package/dist/cjs/index.cjs

@@ -0,0 +1,33 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+var _helpers = require('@turf/helpers');
+function sample(fc, num) {
+  if (!fc)
+    throw new Error("fc is required");
+  if (num === null || num === void 0)
+    throw new Error("num is required");
+  if (typeof num !== "number")
+    throw new Error("num must be a number");
+  var outFC = _helpers.featureCollection.call(void 0, getRandomSubarray(fc.features, num));
+  return outFC;
+}
+__name(sample, "sample");
+function getRandomSubarray(arr, size) {
+  var shuffled = arr.slice(0), i = arr.length, min = i - size, temp, index;
+  while (i-- > min) {
+    index = Math.floor((i + 1) * Math.random());
+    temp = shuffled[index];
+    shuffled[index] = shuffled[i];
+    shuffled[i] = temp;
+  }
+  return shuffled.slice(min);
+}
+__name(getRandomSubarray, "getRandomSubarray");
+var turf_sample_default = sample;
+
+
+
+exports.default = turf_sample_default; exports.sample = sample;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";;;;AAEA,SAAS,yBAAyB;AAqBlC,SAAS,OACP,IACA,KACsB;AACtB,MAAI,CAAC;AAAI,UAAM,IAAI,MAAM,gBAAgB;AACzC,MAAI,QAAQ,QAAQ,QAAQ;AAAW,UAAM,IAAI,MAAM,iBAAiB;AACxE,MAAI,OAAO,QAAQ;AAAU,UAAM,IAAI,MAAM,sBAAsB;AACnE,MAAI,QAAQ,kBAAkB,kBAAkB,GAAG,UAAU,GAAG,CAAC;AACjE,SAAO;AACT;AATS;AAWT,SAAS,kBACP,KACA,MACA;AACA,MAAI,WAAW,IAAI,MAAM,CAAC,GACxB,IAAI,IAAI,QACR,MAAM,IAAI,MACV,MACA;AACF,SAAO,MAAM,KAAK;AAChB,YAAQ,KAAK,OAAO,IAAI,KAAK,KAAK,OAAO,CAAC;AAC1C,WAAO,SAAS,KAAK;AACrB,aAAS,KAAK,IAAI,SAAS,CAAC;AAC5B,aAAS,CAAC,IAAI;AAAA,EAChB;AACA,SAAO,SAAS,MAAM,GAAG;AAC3B;AAhBS;AAmBT,IAAO,sBAAQ","sourcesContent":["// http://stackoverflow.com/questions/11935175/sampling-a-random-subset-from-an-array\nimport { Feature, FeatureCollection, Geometry, GeometryObject } from \"geojson\";\nimport { featureCollection } from \"@turf/helpers\";\n\n/**\n * Takes a {@link FeatureCollection} and returns a FeatureCollection with given number of {@link Feature|features} at random.\n *\n * @name sample\n * @param {FeatureCollection} featurecollection set of input features\n * @param {number} num number of features to select\n * @returns {FeatureCollection} a FeatureCollection with `n` features\n * @example\n * var points = turf.randomPoint(100, {bbox: [-80, 30, -60, 60]});\n *\n * var sample = turf.sample(points, 5);\n *\n * //addToMap\n * var addToMap = [points, sample]\n * turf.featureEach(sample, function (currentFeature) {\n *   currentFeature.properties['marker-size'] = 'large';\n *   currentFeature.properties['marker-color'] = '#000';\n * });\n */\nfunction sample<T extends GeometryObject>(\n  fc: FeatureCollection<T>,\n  num: number\n): FeatureCollection<T> {\n  if (!fc) throw new Error(\"fc is required\");\n  if (num === null || num === undefined) throw new Error(\"num is required\");\n  if (typeof num !== \"number\") throw new Error(\"num must be a number\");\n  var outFC = featureCollection(getRandomSubarray(fc.features, num));\n  return outFC;\n}\n\nfunction getRandomSubarray<T extends Geometry>(\n  arr: Feature<T>[],\n  size: number\n) {\n  var shuffled = arr.slice(0),\n    i = arr.length,\n    min = i - size,\n    temp,\n    index;\n  while (i-- > min) {\n    index = Math.floor((i + 1) * Math.random());\n    temp = shuffled[index];\n    shuffled[index] = shuffled[i];\n    shuffled[i] = temp;\n  }\n  return shuffled.slice(min);\n}\n\nexport { sample };\nexport default sample;\n"]}

package/dist/cjs/index.d.cts

@@ -0,0 +1,24 @@
+import { GeometryObject, FeatureCollection } from 'geojson';
+
+/**
+ * Takes a {@link FeatureCollection} and returns a FeatureCollection with given number of {@link Feature|features} at random.
+ *
+ * @name sample
+ * @param {FeatureCollection} featurecollection set of input features
+ * @param {number} num number of features to select
+ * @returns {FeatureCollection} a FeatureCollection with `n` features
+ * @example
+ * var points = turf.randomPoint(100, {bbox: [-80, 30, -60, 60]});
+ *
+ * var sample = turf.sample(points, 5);
+ *
+ * //addToMap
+ * var addToMap = [points, sample]
+ * turf.featureEach(sample, function (currentFeature) {
+ *   currentFeature.properties['marker-size'] = 'large';
+ *   currentFeature.properties['marker-color'] = '#000';
+ * });
+ */
+declare function sample<T extends GeometryObject>(fc: FeatureCollection<T>, num: number): FeatureCollection<T>;
+
+export { sample as default, sample };

package/dist/esm/index.d.ts

@@ -0,0 +1,24 @@
+import { GeometryObject, FeatureCollection } from 'geojson';
+
+/**
+ * Takes a {@link FeatureCollection} and returns a FeatureCollection with given number of {@link Feature|features} at random.
+ *
+ * @name sample
+ * @param {FeatureCollection} featurecollection set of input features
+ * @param {number} num number of features to select
+ * @returns {FeatureCollection} a FeatureCollection with `n` features
+ * @example
+ * var points = turf.randomPoint(100, {bbox: [-80, 30, -60, 60]});
+ *
+ * var sample = turf.sample(points, 5);
+ *
+ * //addToMap
+ * var addToMap = [points, sample]
+ * turf.featureEach(sample, function (currentFeature) {
+ *   currentFeature.properties['marker-size'] = 'large';
+ *   currentFeature.properties['marker-color'] = '#000';
+ * });
+ */
+declare function sample<T extends GeometryObject>(fc: FeatureCollection<T>, num: number): FeatureCollection<T>;
+
+export { sample as default, sample };

package/dist/esm/index.js

@@ -0,0 +1,33 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// index.ts
+import { featureCollection } from "@turf/helpers";
+function sample(fc, num) {
+  if (!fc)
+    throw new Error("fc is required");
+  if (num === null || num === void 0)
+    throw new Error("num is required");
+  if (typeof num !== "number")
+    throw new Error("num must be a number");
+  var outFC = featureCollection(getRandomSubarray(fc.features, num));
+  return outFC;
+}
+__name(sample, "sample");
+function getRandomSubarray(arr, size) {
+  var shuffled = arr.slice(0), i = arr.length, min = i - size, temp, index;
+  while (i-- > min) {
+    index = Math.floor((i + 1) * Math.random());
+    temp = shuffled[index];
+    shuffled[index] = shuffled[i];
+    shuffled[i] = temp;
+  }
+  return shuffled.slice(min);
+}
+__name(getRandomSubarray, "getRandomSubarray");
+var turf_sample_default = sample;
+export {
+  turf_sample_default as default,
+  sample
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts"],"sourcesContent":["// http://stackoverflow.com/questions/11935175/sampling-a-random-subset-from-an-array\nimport { Feature, FeatureCollection, Geometry, GeometryObject } from \"geojson\";\nimport { featureCollection } from \"@turf/helpers\";\n\n/**\n * Takes a {@link FeatureCollection} and returns a FeatureCollection with given number of {@link Feature|features} at random.\n *\n * @name sample\n * @param {FeatureCollection} featurecollection set of input features\n * @param {number} num number of features to select\n * @returns {FeatureCollection} a FeatureCollection with `n` features\n * @example\n * var points = turf.randomPoint(100, {bbox: [-80, 30, -60, 60]});\n *\n * var sample = turf.sample(points, 5);\n *\n * //addToMap\n * var addToMap = [points, sample]\n * turf.featureEach(sample, function (currentFeature) {\n *   currentFeature.properties['marker-size'] = 'large';\n *   currentFeature.properties['marker-color'] = '#000';\n * });\n */\nfunction sample<T extends GeometryObject>(\n  fc: FeatureCollection<T>,\n  num: number\n): FeatureCollection<T> {\n  if (!fc) throw new Error(\"fc is required\");\n  if (num === null || num === undefined) throw new Error(\"num is required\");\n  if (typeof num !== \"number\") throw new Error(\"num must be a number\");\n  var outFC = featureCollection(getRandomSubarray(fc.features, num));\n  return outFC;\n}\n\nfunction getRandomSubarray<T extends Geometry>(\n  arr: Feature<T>[],\n  size: number\n) {\n  var shuffled = arr.slice(0),\n    i = arr.length,\n    min = i - size,\n    temp,\n    index;\n  while (i-- > min) {\n    index = Math.floor((i + 1) * Math.random());\n    temp = shuffled[index];\n    shuffled[index] = shuffled[i];\n    shuffled[i] = temp;\n  }\n  return shuffled.slice(min);\n}\n\nexport { sample };\nexport default sample;\n"],"mappings":";;;;AAEA,SAAS,yBAAyB;AAqBlC,SAAS,OACP,IACA,KACsB;AACtB,MAAI,CAAC;AAAI,UAAM,IAAI,MAAM,gBAAgB;AACzC,MAAI,QAAQ,QAAQ,QAAQ;AAAW,UAAM,IAAI,MAAM,iBAAiB;AACxE,MAAI,OAAO,QAAQ;AAAU,UAAM,IAAI,MAAM,sBAAsB;AACnE,MAAI,QAAQ,kBAAkB,kBAAkB,GAAG,UAAU,GAAG,CAAC;AACjE,SAAO;AACT;AATS;AAWT,SAAS,kBACP,KACA,MACA;AACA,MAAI,WAAW,IAAI,MAAM,CAAC,GACxB,IAAI,IAAI,QACR,MAAM,IAAI,MACV,MACA;AACF,SAAO,MAAM,KAAK;AAChB,YAAQ,KAAK,OAAO,IAAI,KAAK,KAAK,OAAO,CAAC;AAC1C,WAAO,SAAS,KAAK;AACrB,aAAS,KAAK,IAAI,SAAS,CAAC;AAC5B,aAAS,CAAC,IAAI;AAAA,EAChB;AACA,SAAO,SAAS,MAAM,GAAG;AAC3B;AAhBS;AAmBT,IAAO,sBAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/sample",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0",
   "description": "turf sample module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -22,38 +22,47 @@
     "sample",
     "turf"
   ],
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./index.d.ts",
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
     }
   },
-  "types": "index.d.ts",
   "sideEffects": false,
   "files": [
-    "dist",
-    "index.d.ts"
+    "dist"
   ],
   "scripts": {
-    "bench": "tsx bench.js",
-    "build": "rollup -c ../../rollup.config.js && echo '{\"type\":\"module\"}' > dist/es/package.json",
-    "docs": "tsx ../../scripts/generate-readmes",
-    "test": "npm-run-all test:*",
-    "test:tape": "tsx test.js"
+    "bench": "tsx bench.ts",
+    "build": "tsup --config ../../tsup.config.ts",
+    "docs": "tsx ../../scripts/generate-readmes.ts",
+    "test": "npm-run-all --npm-path npm test:*",
+    "test:tape": "tsx test.ts"
   },
   "devDependencies": {
-    "benchmark": "*",
-    "npm-run-all": "*",
-    "rollup": "*",
-    "tape": "*",
-    "tsx": "*"
+    "@types/benchmark": "^2.1.5",
+    "@types/tape": "^4.2.32",
+    "benchmark": "^2.1.4",
+    "npm-run-all": "^4.1.5",
+    "tape": "^5.7.2",
+    "tsup": "^8.0.1",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@turf/helpers": "^7.0.0-alpha.2"
+    "@turf/helpers": "^7.0.0",
+    "tslib": "^2.6.2"
   },
-  "gitHead": "dd35b52725945b4fa29a98d9a550733e06cc222e"
+  "gitHead": "3d3a7917025fbabe191dbddbc89754b86f9c7739"
 }

package/dist/es/index.js

@@ -1,50 +0,0 @@
-import { featureCollection } from '@turf/helpers';
-
-// http://stackoverflow.com/questions/11935175/sampling-a-random-subset-from-an-array
-
-/**
- * Takes a {@link FeatureCollection} and returns a FeatureCollection with given number of {@link Feature|features} at random.
- *
- * @name sample
- * @param {FeatureCollection} featurecollection set of input features
- * @param {number} num number of features to select
- * @returns {FeatureCollection} a FeatureCollection with `n` features
- * @example
- * var points = turf.randomPoint(100, {bbox: [-80, 30, -60, 60]});
- *
- * var sample = turf.sample(points, 5);
- *
- * //addToMap
- * var addToMap = [points, sample]
- * turf.featureEach(sample, function (currentFeature) {
- *   currentFeature.properties['marker-size'] = 'large';
- *   currentFeature.properties['marker-color'] = '#000';
- * });
- */
-function sample(featurecollection, num) {
-  if (!featurecollection) throw new Error("featurecollection is required");
-  if (num === null || num === undefined) throw new Error("num is required");
-  if (typeof num !== "number") throw new Error("num must be a number");
-
-  var outFC = featureCollection(
-    getRandomSubarray(featurecollection.features, num)
-  );
-  return outFC;
-}
-
-function getRandomSubarray(arr, size) {
-  var shuffled = arr.slice(0),
-    i = arr.length,
-    min = i - size,
-    temp,
-    index;
-  while (i-- > min) {
-    index = Math.floor((i + 1) * Math.random());
-    temp = shuffled[index];
-    shuffled[index] = shuffled[i];
-    shuffled[i] = temp;
-  }
-  return shuffled.slice(min);
-}
-
-export default sample;

package/dist/es/package.json

@@ -1 +0,0 @@
-{"type":"module"}

package/dist/js/index.js

@@ -1,53 +0,0 @@
-'use strict';
-
-var helpers = require('@turf/helpers');
-
-// http://stackoverflow.com/questions/11935175/sampling-a-random-subset-from-an-array
-
-/**
- * Takes a {@link FeatureCollection} and returns a FeatureCollection with given number of {@link Feature|features} at random.
- *
- * @name sample
- * @param {FeatureCollection} featurecollection set of input features
- * @param {number} num number of features to select
- * @returns {FeatureCollection} a FeatureCollection with `n` features
- * @example
- * var points = turf.randomPoint(100, {bbox: [-80, 30, -60, 60]});
- *
- * var sample = turf.sample(points, 5);
- *
- * //addToMap
- * var addToMap = [points, sample]
- * turf.featureEach(sample, function (currentFeature) {
- *   currentFeature.properties['marker-size'] = 'large';
- *   currentFeature.properties['marker-color'] = '#000';
- * });
- */
-function sample(featurecollection, num) {
-  if (!featurecollection) throw new Error("featurecollection is required");
-  if (num === null || num === undefined) throw new Error("num is required");
-  if (typeof num !== "number") throw new Error("num must be a number");
-
-  var outFC = helpers.featureCollection(
-    getRandomSubarray(featurecollection.features, num)
-  );
-  return outFC;
-}
-
-function getRandomSubarray(arr, size) {
-  var shuffled = arr.slice(0),
-    i = arr.length,
-    min = i - size,
-    temp,
-    index;
-  while (i-- > min) {
-    index = Math.floor((i + 1) * Math.random());
-    temp = shuffled[index];
-    shuffled[index] = shuffled[i];
-    shuffled[i] = temp;
-  }
-  return shuffled.slice(min);
-}
-
-module.exports = sample;
-module.exports.default = sample;

package/index.d.ts

@@ -1,9 +0,0 @@
-import { FeatureCollection, GeometryObject } from "geojson";
-
-/**
- * http://turfjs.org/docs/#sample
- */
-export default function sample<T extends GeometryObject>(
-  features: FeatureCollection<T>,
-  num: number
-): FeatureCollection<T>;