@tim-code/my-util 0.2.0 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tim-code/my-util",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "",
   "type": "module",
   "author": "",

package/src/find.js

@@ -185,3 +185,85 @@ export function findClosest(array, value, options = {}) {
       throw new Error(`Unknown comparator: ${comparator}`)
   }
 }
+
+/**
+ * Find the minimum value in an array.
+ * @template T, V
+ * @param {Array<T>} array
+ * @param {Object} $1
+ * @param {string|Function=} $1.key Specifies an alternative to using each element as the value.
+ *  If string, then accesses each element at that key to get value.
+ *  If function, then calls the callback on each element to get value.
+ * @param {V=} $1.cutoff Only values below cutoff will be considered.
+ * @returns {T}
+ */
+export function findMin(array, { key, cutoff = Infinity } = {}) {
+  let closest
+  if (typeof key === "function") {
+    for (let i = 0; i < array.length; i++) {
+      const element = array[i]
+      const value = key(element, i, array)
+      if (value < cutoff) {
+        closest = element
+        cutoff = value
+      }
+    }
+  } else if (typeof key === "number" || typeof key === "string") {
+    for (const element of array) {
+      const value = element[key]
+      if (value < cutoff) {
+        closest = element
+        cutoff = value
+      }
+    }
+  } else {
+    for (const value of array) {
+      if (value < cutoff) {
+        closest = value
+        cutoff = value
+      }
+    }
+  }
+  return closest
+}
+
+/**
+ * Find the maximum value in an array.
+ * @template T, V
+ * @param {Array<T>} array
+ * @param {Object} $1
+ * @param {string|Function=} $1.key Specifies an alternative to using each element as the value.
+ *  If string, then accesses each element at that key to get value.
+ *  If function, then calls the callback on each element to get value.
+ * @param {V=} $1.cutoff Only values above cutoff will be considered.
+ * @returns {T}
+ */
+export function findMax(array, { key, cutoff = -Infinity } = {}) {
+  let closest
+  if (typeof key === "function") {
+    for (let i = 0; i < array.length; i++) {
+      const element = array[i]
+      const value = key(element, i, array)
+      if (value > cutoff) {
+        closest = element
+        cutoff = value
+      }
+    }
+  } else if (typeof key === "number" || typeof key === "string") {
+    for (const element of array) {
+      const value = element[key]
+      if (value > cutoff) {
+        closest = element
+        cutoff = value
+      }
+    }
+  } else {
+    for (const value of array) {
+      if (value > cutoff) {
+        closest = value
+        cutoff = value
+      }
+    }
+  }
+  return closest
+}

package/src/find.test.js

@@ -7,6 +7,8 @@ const {
   findClosestGT,
   findClosestGTE,
   findClosest,
+  findMin,
+  findMax,
 } = await import("./find.js")
 
 describe("findClosestAbs", () => {
@@ -214,3 +216,71 @@ describe("findClosest", () => {
     expect(findClosest(arr, 8, { comparator: "abs", key: "x" })).toEqual({ x: 10 })
   })
 })
+
+describe("findMin", () => {
+  it("returns the minimum value in a numeric array", () => {
+    expect(findMin([3, 1, 4, 2])).toBe(1)
+  })
+
+  it("returns undefined for empty array", () => {
+    expect(findMin([])).toBeUndefined()
+  })
+
+  it("returns the first minimum if there are duplicates", () => {
+    expect(findMin([2, 1, 1, 3])).toBe(1)
+  })
+
+  it("supports key as function", () => {
+    const arr = [{ v: 5 }, { v: 2 }, { v: 8 }]
+    expect(findMin(arr, { key: (e) => e.v })).toEqual({ v: 2 })
+  })
+
+  it("supports key as string", () => {
+    const arr = [{ x: 5 }, { x: 2 }, { x: 8 }]
+    expect(findMin(arr, { key: "x" })).toEqual({ x: 2 })
+  })
+
+  it("supports key as number", () => {
+    const arr = [[5], [2], [8]]
+    expect(findMin(arr, { key: 0 })).toEqual([2])
+  })
+
+  it("respects cutoff", () => {
+    expect(findMin([3, 1, 4, 2], { cutoff: 2 })).toBe(1)
+    expect(findMin([3, 1, 4, 2], { cutoff: 1 })).toBeUndefined()
+  })
+})
+
+describe("findMax", () => {
+  it("returns the maximum value in a numeric array", () => {
+    expect(findMax([3, 1, 4, 2])).toBe(4)
+  })
+
+  it("returns undefined for empty array", () => {
+    expect(findMax([])).toBeUndefined()
+  })
+
+  it("returns the first maximum if there are duplicates", () => {
+    expect(findMax([4, 2, 4, 1])).toBe(4)
+  })
+
+  it("supports key as function", () => {
+    const arr = [{ v: 5 }, { v: 2 }, { v: 8 }]
+    expect(findMax(arr, { key: (e) => e.v })).toEqual({ v: 8 })
+  })
+
+  it("supports key as string", () => {
+    const arr = [{ x: 5 }, { x: 2 }, { x: 8 }]
+    expect(findMax(arr, { key: "x" })).toEqual({ x: 8 })
+  })
+
+  it("supports key as number", () => {
+    const arr = [[5], [2], [8]]
+    expect(findMax(arr, { key: 0 })).toEqual([8])
+  })
+
+  it("respects cutoff", () => {
+    expect(findMax([3, 1, 4, 2], { cutoff: 2 })).toBe(4)
+    expect(findMax([3, 1, 4, 2], { cutoff: 4 })).toBeUndefined()
+  })
+})