@tim-code/my-util 0.4.5 → 0.4.7

package/package.json

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

package/src/math.js

@@ -123,3 +123,21 @@ export function formatPlus(number, { zero = false } = {}) {
   }
   return undefined
 }
+
+/**
+ * Create an array of numbers progressing from start up to, but not including, end.
+ * @param {number} start
+ * @param {number=} end
+ * @param {number=} step
+ * @returns {number[]}
+ */
+export function range(start, end, increment = 1) {
+  if (!(increment > 0)) {
+    return []
+  }
+  const results = []
+  for (let i = start; i < end; i += increment) {
+    results.push(i)
+  }
+  return results
+}

package/src/math.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "@jest/globals"
-const { mod, formatPlus, line, sum, average, variance } = await import("./math.js")
+const { mod, formatPlus, line, sum, average, variance, range } = await import("./math.js")
 
 describe("mod", () => {
   it("returns n when n is less than m and n is non-negative", () => {
@@ -255,3 +255,47 @@ describe("formatPlus", () => {
     expect(formatPlus(NaN)).toBeUndefined()
   })
 })
+
+describe("range", () => {
+  it("returns an empty array if start >= end", () => {
+    expect(range(5, 5)).toEqual([])
+    expect(range(10, 5)).toEqual([])
+  })
+
+  it("returns a sequence from start to end-1 with default increment 1", () => {
+    expect(range(0, 3)).toEqual([0, 1, 2])
+    expect(range(2, 6)).toEqual([2, 3, 4, 5])
+  })
+
+  it("returns a sequence with a custom positive increment", () => {
+    expect(range(0, 5, 2)).toEqual([0, 2, 4])
+    expect(range(1, 8, 3)).toEqual([1, 4, 7])
+  })
+  it("works with negative start and end", () => {
+    expect(range(-3, 1)).toEqual([-3, -2, -1, 0])
+    expect(range(-5, -2)).toEqual([-5, -4, -3])
+  })
+
+  it("returns an empty array if increment is zero", () => {
+    expect(range(0, 5, 0)).toEqual([])
+  })
+
+  it("returns an empty array if increment is negative and start < end", () => {
+    expect(range(0, 5, -1)).toEqual([])
+    expect(range(2, 6, -2)).toEqual([])
+  })
+
+  it("returns an empty array if increment is negative and start > end", () => {
+    expect(range(5, 0, -1)).toEqual([])
+    expect(range(3, -2, -2)).toEqual([])
+  })
+
+  it("returns an empty array if increment is positive and start > end", () => {
+    expect(range(5, 0, 1)).toEqual([])
+    expect(range(2, -2, 2)).toEqual([])
+  })
+
+  it("handles floating point increments", () => {
+    expect(range(0, 1, 0.25)).toEqual([0, 0.25, 0.5, 0.75])
+  })
+})

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")
+  })
+})