added ts support

Author: DanielJDufour

.gitignore

@@ -105,4 +105,4 @@ dist
 
 numbers.json
 *-numbers.json
-
+pnpm-lock.yaml

README.md

@@ -14,39 +14,39 @@ so if we encounter a 255 in the array, we can stop searching for a higher value.
 # usage
 # getting maximum value of a normal array
 ```javascript
-const max = require("fast-max");
+const fastMax = require("fast-max"); // or import max from "fast-max";
 
-const result = max([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+const result = fastMax([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
 // result is 10
 ```
 
 # getting maximum value of a typed array
 ```javascript
-const max = require("fast-max");
+const fastMax = require("fast-max");
 
 const pixel_values = Uint8Array.from([0, 128, 255, 34, ...]);
-const result = max(pixel_values);
+const result = fastMax(pixel_values);
 // result is 255
 ```
 
 # setting theoretical maximum
 If you know that an array's values can't exceed a specific number,
 you can set the theoretical_max.
 ```javascript
-const max = require("fast-max");
+const fastMax = require("fast-max");
 
 const numbers = [0, 9, 4, 2, 10, ...]);
-const result = max(numbers, { theoretical_max: 10 });
+const result = fastMax(numbers, { theoretical_max: 10 });
 // result is 10
 ```
 
 # no data value
 If you want to ignore a specific value, you can set the no_data value.
 ```javascript
-const max = require("fast-max");
+const fastMax = require("fast-max");
 
 const numbers = [99, 0, 7, 99, 5, ...]);
-const result = max(numbers, { no_data: 99 });
+const result = fastMax(numbers, { no_data: 99 });
 // result is 7
 ```
 

index.d.ts

@@ -0,0 +1,22 @@
+type ARRAY_TYPE =
+  | Array<number>
+  | Int8Array
+  | Uint8Array
+  | Uint8ClampedArray
+  | Int16Array
+  | Uint16Array
+  | Int32Array
+  | Uint32Array
+  | Float32Array
+  | Float64Array
+  | BigInt64Array
+  | BigUint64Array;
+
+export default function fastMax(
+  numbers: ARRAY_TYPE,
+  options?: {
+    debug?: boolean | undefined;
+    no_data?: number | undefined;
+    theoretical_max?: number | undefined;
+  }
+): number;

index.js

@@ -1,6 +1,6 @@
 const getTheoreticalMax = require("typed-array-ranges/get-max");
 
-module.exports = function fastMax(
+function fastMax(
   numbers,
   { debug = false, no_data = undefined, theoretical_max = undefined } = {
     debug: false,
@@ -74,4 +74,23 @@ module.exports = function fastMax(
 
   if (debug) console.log("[fast-max] returning", max);
   return max;
-};
+}
+
+if (typeof define === "function" && define.amd) {
+  define(function () {
+    return fastMax;
+  });
+}
+
+if (typeof module === "object") {
+  module.exports = fastMax;
+  module.exports.default = fastMax;
+}
+
+if (typeof self === "object") {
+  self.fastMax = fastMax;
+}
+
+if (typeof window === "object") {
+  window.fastMax = fastMax;
+}

package.json

@@ -3,11 +3,19 @@
   "version": "0.3.0",
   "description": "Quickest Way to get the Maximum Value of an Array of Numbers (Typed or Untyped)",
   "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts",
+    "index.js"
+  ],
   "scripts": {
-    "format": "npx prettier --arrow-parens=avoid --print-width=120 --write *.js",
+    "f": "npm run format",
+    "format": "npx prettier --arrow-parens=avoid --print-width=120 --write *.js *.ts",
     "setup": "node setup.js",
     "perf": "./perf",
-    "test": "node test.js"
+    "test": "npm run test:js && npm run test:ts",
+    "test:js": "node test.js",
+    "test:ts": "npx ts-node ./test.ts"
   },
   "repository": {
     "type": "git",
@@ -35,9 +43,9 @@
   },
   "homepage": "https://github.com/DanielJDufour/fast-max#readme",
   "devDependencies": {
-    "flug": "^1.1.0",
+    "flug": "^2.3.1",
     "lodash.max": "^4.0.1",
-    "underscore": "^1.13.1"
+    "underscore": "^1.13.4"
   },
   "dependencies": {
     "typed-array-ranges": "^0.0.0"

test.js

@@ -37,7 +37,7 @@ test("getting maximum from typed arrays", ({ eq }) => {
 });
 
 test("getting maximum from a very large untyped array", ({ eq }) => {
-  const numbers = JSON.parse(fs.readFileSync("uint16-numbers.json")).map(n => Number(n));
+  const numbers = JSON.parse(fs.readFileSync("uint16-numbers.json", "utf-8")).map(n => Number(n));
   const result = max(numbers, { debug: true });
   eq(result, 65535);
 });

test.ts

@@ -0,0 +1,67 @@
+import { readFileSync } from "fs";
+import test from "flug";
+import max from "./index";
+
+test("gettings maximum from a normal array", ({ eq }) => {
+  const numbers = [920, 550, 340, 690, 550, 340, 840, 700, 550, 210, 540];
+  const result = max(numbers, { debug: false });
+  eq(result, 920);
+});
+
+test("getting maximum from an array of image band values", ({ eq }) => {
+  const numbers = Uint8Array.from(JSON.parse(readFileSync("uint8-numbers.json", "utf-8")));
+  console.log("loaded uint8 numbers of length:", numbers.length);
+  const result = max(numbers, { debug: false });
+  eq(result, 255);
+});
+
+test("setting theoretical maximum", ({ eq }) => {
+  const numbers = Array.from(Uint8Array.from(JSON.parse(readFileSync("uint8-numbers.json", "utf-8"))));
+  console.log("loaded uint8 numbers of length:", numbers.length);
+  const result = max(numbers, { debug: false, theoretical_max: 255 });
+  eq(result, 255);
+});
+
+test("getting maximum from typed arrays", ({ eq }) => {
+  [
+    [Int8Array, 127] as const,
+    [Uint8Array, 255] as const,
+    [Int16Array, 32767] as const,
+    [Uint16Array, 65535] as const,
+  ].forEach(([array_type, expected_max]) => {
+    const filename = array_type.name.replace("Array", "").toLowerCase() + "-numbers.json";
+    const numbers = array_type.from(JSON.parse(readFileSync(filename, "utf-8")));
+    const result = max(numbers, { debug: false });
+    eq(result, expected_max);
+  });
+});
+
+test("getting maximum from a very large untyped array", ({ eq }) => {
+  const numbers = JSON.parse(readFileSync("uint16-numbers.json", "utf-8")).map(n => Number(n));
+  const result = max(numbers, { debug: true });
+  eq(result, 65535);
+});
+
+test("getting no maximum from normal arrays with all no data values", ({ eq }) => {
+  const numbers = [99, 99, 99, 99];
+  const result = max(numbers, { no_data: 99 });
+  eq(result, undefined);
+});
+
+test("getting maximum from normal arrays with some data values", ({ eq }) => {
+  const numbers = [1, 99, 2, 99, 4, 99, 6, 99, -10];
+  const result = max(numbers, { no_data: 99 });
+  eq(result, 6);
+});
+
+test("getting no maximum from typed arrays with all no data values", ({ eq }) => {
+  const numbers = Uint8Array.from([99, 99, 99, 99]);
+  const result = max(numbers, { no_data: 99 });
+  eq(result, undefined);
+});
+
+test("getting maximum from typed arrays with some data values", ({ eq }) => {
+  const numbers = Int8Array.from([1, 99, 2, 99, 4, 99, 6, 99, -10]);
+  const result = max(numbers, { no_data: 99 });
+  eq(result, 6);
+});