@tim-code/my-util 0.2.3 → 0.2.5

package/package.json

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

package/src/time.js

@@ -52,6 +52,30 @@ export function today() {
   return getTime().date
 }
 
+/**
+ * Get the day of the week index from a YYYY-MM-DD string.
+ * @param {string=} string YYYY-MM-DD
+ * @returns {string} 0, 1, 2, 3, 4, 5, 6; 0 is Sunday and, 1 is Monday, ... 6 is Saturday
+ */
+export function getDayIndexInWeek(string = today()) {
+  const [year, month, day] = string.split("-").map(Number)
+  const index = new Date(year, month - 1, day).getDay()
+  if (isNaN(index)) {
+    throw new Error(`invalid date: ${string}`)
+  }
+  return index
+}
+
+/**
+ * Get the minute from a time string.
+ * @param {string} time HH:mm or HH:mm::ss
+ * @returns {number} Between 0 and 59 inclusive
+ */
+export function getMinute(time) {
+  const minute = Number(time.split(":")[1])
+  return minute
+}
+
 /**
  * Checks if the string represents a valid YYYY-MM-DD date.
  * This will return false for dates like "2024-02-31".

package/src/time.test.js

@@ -3,7 +3,10 @@ import {
   addDays,
   addTime,
   getDateRange,
+  getDayIndexInWeek,
+  // getDayOfWeek, // removed, replaced by getDayIndexInWeek
   getEasternTime,
+  getMinute,
   getTime,
   getTimeRange,
   isDate,
@@ -12,14 +15,12 @@ import {
   today,
 } from "./time.js"
 
-// getEasternTime changed: now accepts a "timezone" param and no longer returns "minute" or "datetime"
 describe("getEasternTime", () => {
   test("returns correct structure and types", () => {
     const result = getEasternTime()
     expect(typeof result.timestamp).toBe("number")
     expect(typeof result.date).toBe("string")
     expect(typeof result.time).toBe("string")
-    // minute and datetime are no longer returned
     expect(result).not.toHaveProperty("minute")
     expect(result).not.toHaveProperty("datetime")
   })
@@ -52,7 +53,6 @@ describe("getEasternTime", () => {
     expect(def.timestamp).toEqual(explicit.timestamp)
   })
 
-  // New: test timezone override
   test("respects timezone parameter", () => {
     // 2024-06-01T12:34:56Z (UTC)
     const ts = 1717245296
@@ -65,7 +65,6 @@ describe("getEasternTime", () => {
     expect(eastern.time).not.toBe(pacific.time)
     expect(eastern.time).not.toBe(utc.time)
     expect(pacific.time).not.toBe(utc.time)
-    // Should match expected hour offset
     expect(eastern.time.startsWith("08:34")).toBe(true) // EDT
     expect(pacific.time.startsWith("05:34")).toBe(true) // PDT
     expect(utc.time.startsWith("12:34")).toBe(true) // UTC
@@ -92,7 +91,6 @@ describe("getEasternTime", () => {
     expect(local.time).toBe(time)
   })
 
-  // DST boundary tests
   test("handles DST start (spring forward) correctly", () => {
     // In 2024, DST starts in US/Eastern at 2024-03-10 02:00:00 local time (clocks jump to 03:00:00)
     // 2024-03-10T06:59:59Z = 1:59:59 EST (should be 01:59:59)
@@ -132,7 +130,6 @@ describe("getEasternTime", () => {
   })
 })
 
-// New tests for getTime (newly exported function)
 describe("getTime", () => {
   test("returns same structure as getEasternTime", () => {
     const result = getTime({})
@@ -187,6 +184,55 @@ describe("today", () => {
   })
 })
 
+describe("getDayIndexInWeek", () => {
+  test("returns correct index for known dates", () => {
+    expect(getDayIndexInWeek("2024-06-02")).toBe(0)
+    expect(getDayIndexInWeek("2024-06-03")).toBe(1)
+    expect(getDayIndexInWeek("2024-06-04")).toBe(2)
+    expect(getDayIndexInWeek("2024-06-05")).toBe(3)
+    expect(getDayIndexInWeek("2024-06-06")).toBe(4)
+    expect(getDayIndexInWeek("2024-06-07")).toBe(5)
+    expect(getDayIndexInWeek("2024-06-08")).toBe(6)
+  })
+
+  test("returns correct index for leap day", () => {
+    // 2024-02-29 is Thursday (4)
+    expect(getDayIndexInWeek("2024-02-29")).toBe(4)
+  })
+
+  test("defaults to today() if no argument is given", () => {
+    const todayDate = today()
+    expect(getDayIndexInWeek()).toBe(getDayIndexInWeek(todayDate))
+  })
+
+  test("throws on invalid date strings", () => {
+    expect(() => getDayIndexInWeek("not-a-date")).toThrow(/invalid date/u)
+    // don't worry about bad dates like the following; can be caught with isDate()
+    expect(getDayIndexInWeek("2024-02-31")).toBe(6)
+  })
+})
+
+// New tests for getMinute
+describe("getMinute", () => {
+  test("extracts minute from HH:mm:ss", () => {
+    expect(getMinute("12:34:56")).toBe(34)
+    expect(getMinute("00:01:00")).toBe(1)
+    expect(getMinute("23:59:59")).toBe(59)
+  })
+
+  test("extracts minute from HH:mm", () => {
+    expect(getMinute("12:34")).toBe(34)
+    expect(getMinute("00:01")).toBe(1)
+    expect(getMinute("23:59")).toBe(59)
+  })
+
+  test("handles single-digit minutes", () => {
+    expect(getMinute("12:07:00")).toBe(7)
+    expect(getMinute("12:7:00")).toBe(7)
+    expect(getMinute("12:7")).toBe(7)
+  })
+})
+
 describe("isDate", () => {
   test("returns true for valid YYYY-MM-DD dates", () => {
     expect(isDate("2024-06-01")).toBe(true)
@@ -299,27 +345,22 @@ describe("addTime", () => {
     expect(addTime("9:8", { hours: 0, minutes: 0 })).toBe("09:08:00")
   })
 
-  // Edge case: negative minutes that require multiple hour underflows
   test("handles large negative minutes", () => {
     expect(addTime("05:10:00", { minutes: -130 })).toBe("03:00:00")
   })
 
-  // Edge case: large positive minutes that require multiple hour rollovers
   test("handles large positive minutes", () => {
     expect(addTime("05:10:00", { minutes: 130 })).toBe("07:20:00")
   })
 
-  // Edge case: input with seconds omitted
   test("handles input with no seconds", () => {
     expect(addTime("12:34", { minutes: 0 })).toBe("12:34:00")
   })
 
-  // Edge case: input with all zeros
   test("handles midnight", () => {
     expect(addTime("00:00:00", { hours: 0, minutes: 0 })).toBe("00:00:00")
   })
 
-  // New: test default parameters (no options argument)
   test("handles missing options argument (all defaults)", () => {
     expect(addTime("12:34:56")).toBe("12:34:56")
     expect(addTime("05:10")).toBe("05:10:00")
@@ -391,14 +432,12 @@ describe("addDays", () => {
     expect(addDays("2024-01-01", { days: -1 })).toBe("2023-12-31")
   })
 
-  // DST boundary: adding days across US DST start (spring forward)
   test("adds days across DST start (spring forward) (object param)", () => {
     expect(addDays("2024-03-09", { days: 1 })).toBe("2024-03-10")
     expect(addDays("2024-03-09", { days: 2 })).toBe("2024-03-11")
     expect(addDays("2024-03-10", { days: -1 })).toBe("2024-03-09")
   })
 
-  // DST boundary: adding days across US DST end (fall back)
   test("adds days across DST end (fall back) (object param)", () => {
     expect(addDays("2024-11-02", { days: 1 })).toBe("2024-11-03")
     expect(addDays("2024-11-02", { days: 2 })).toBe("2024-11-04")