@tim-code/my-util 0.4.6 → 0.4.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tim-code/my-util",
-  "version": "0.4.6",
+  "version": "0.4.8",
   "description": "",
   "type": "module",
   "author": "Tim Sprowl",

package/src/math.js

@@ -141,3 +141,12 @@ export function range(start, end, increment = 1) {
   }
   return results
 }
+
+/**
+ * Check if the argument is a number (typeof is "number" and not NaN).
+ * @param {any} number
+ * @returns {boolean}
+ */
+export function isNumber(number) {
+  return typeof number === "number" && !isNaN(number)
+}

package/src/math.test.js

@@ -1,5 +1,7 @@
 import { describe, expect, it } from "@jest/globals"
-const { mod, formatPlus, line, sum, average, variance, range } = await import("./math.js")
+const { mod, formatPlus, line, sum, average, variance, range, isNumber } = await import(
+  "./math.js"
+)
 
 describe("mod", () => {
   it("returns n when n is less than m and n is non-negative", () => {
@@ -299,3 +301,34 @@ describe("range", () => {
     expect(range(0, 1, 0.25)).toEqual([0, 0.25, 0.5, 0.75])
   })
 })
+
+describe("isNumber", () => {
+  it("returns true for finite numbers", () => {
+    expect(isNumber(0)).toBe(true)
+    expect(isNumber(42)).toBe(true)
+    expect(isNumber(-3.14)).toBe(true)
+    expect(isNumber(Number.MAX_SAFE_INTEGER)).toBe(true)
+    expect(isNumber(Number.MIN_SAFE_INTEGER)).toBe(true)
+  })
+
+  it("returns true for Infinity and -Infinity", () => {
+    expect(isNumber(Infinity)).toBe(true)
+    expect(isNumber(-Infinity)).toBe(true)
+  })
+
+  it("returns false for NaN", () => {
+    expect(isNumber(NaN)).toBe(false)
+  })
+
+  it("returns false for non-number types", () => {
+    expect(isNumber("123")).toBe(false)
+    expect(isNumber(undefined)).toBe(false)
+    // eslint-disable-next-line no-restricted-syntax
+    expect(isNumber(null)).toBe(false)
+    expect(isNumber({})).toBe(false)
+    expect(isNumber([])).toBe(false)
+    expect(isNumber(true)).toBe(false)
+    expect(isNumber(Symbol("x"))).toBe(false)
+    expect(isNumber(() => 1)).toBe(false)
+  })
+})

package/src/time.js

@@ -200,3 +200,14 @@ export function getDateRange(start, end, { limit = 1000 } = {}) {
   }
   return dates
 }
+
+/**
+ * Get the first date in the week containing the passed date string.
+ * @param {string} dateString YYYY-MM-DD
+ * @returns {string} YYYY-MM-DD
+ */
+export function getStartOfWeek(dateString) {
+  const index = getDayIndexInWeek(dateString)
+  const start = addDays(dateString, { days: -index })
+  return start
+}

package/src/time.test.js

@@ -7,6 +7,7 @@ import {
   // getDayOfWeek, // removed, replaced by getDayIndexInWeek
   getEasternTime,
   getMinute,
+  getStartOfWeek,
   getTime,
   getTimeRange,
   isDate,
@@ -492,3 +493,31 @@ describe("getDateRange", () => {
     expect(getDateRange("not-a-date", "2024-01-01")).toEqual([])
   })
 })
+
+// Tests for getStartOfWeek (newly exported function)
+describe("getStartOfWeek", () => {
+  test("returns same date if input is Sunday", () => {
+    expect(getStartOfWeek("2024-06-02")).toBe("2024-06-02") // Sunday
+    expect(getDayIndexInWeek("2024-06-02")).toBe(0)
+  })
+
+  test("returns previous Sunday for a weekday", () => {
+    expect(getStartOfWeek("2024-06-05")).toBe("2024-06-02") // Wednesday -> previous Sunday
+    expect(getStartOfWeek("2024-06-03")).toBe("2024-06-02") // Monday -> previous Sunday
+    expect(getStartOfWeek("2024-06-08")).toBe("2024-06-02") // Saturday -> previous Sunday
+  })
+
+  test("works for leap day", () => {
+    // 2024-02-29 is Thursday (4), so start of week should be 2024-02-25
+    expect(getStartOfWeek("2024-02-29")).toBe("2024-02-25")
+  })
+
+  test("works for year boundary", () => {
+    // 2023-01-01 is Sunday
+    expect(getStartOfWeek("2023-01-01")).toBe("2023-01-01")
+    // 2023-01-07 is Saturday, so start of week is 2023-01-01
+    expect(getStartOfWeek("2023-01-07")).toBe("2023-01-01")
+    // 2023-01-02 is Monday, so start of week is 2023-01-01
+    expect(getStartOfWeek("2023-01-02")).toBe("2023-01-01")
+  })
+})