@tim-code/my-util 0.2.3 → 0.2.4

package/package.json

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

package/src/time.js

@@ -52,6 +52,22 @@ export function today() {
   return getTime().date
 }
 
+/**
+ * Get the day of the week from a YYYY-MM-DD string.
+ * @param {string=} string YYYY-MM-DD
+ * @returns {string} "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"
+ */
+export function getDayOfWeek(string = today()) {
+  const [year, month, day] = string.split("-").map(Number)
+  const dayOfWeek = new Date(year, month - 1, day)
+    .toLocaleDateString("en-US", { weekday: "long" })
+    .toLowerCase()
+  if (dayOfWeek === "invalid date") {
+    throw new Error(`invalid date passed: ${string}`)
+  }
+  return dayOfWeek
+}
+
 /**
  * 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,6 +3,7 @@ import {
   addDays,
   addTime,
   getDateRange,
+  getDayOfWeek,
   getEasternTime,
   getTime,
   getTimeRange,
@@ -187,6 +188,33 @@ describe("today", () => {
   })
 })
 
+describe("getDayOfWeek", () => {
+  test("returns correct day of week for known dates", () => {
+    expect(getDayOfWeek("2024-06-01")).toBe("saturday")
+    expect(getDayOfWeek("2024-06-02")).toBe("sunday")
+    expect(getDayOfWeek("2024-06-03")).toBe("monday")
+    expect(getDayOfWeek("2024-06-04")).toBe("tuesday")
+    expect(getDayOfWeek("2024-06-05")).toBe("wednesday")
+    expect(getDayOfWeek("2024-06-06")).toBe("thursday")
+    expect(getDayOfWeek("2024-06-07")).toBe("friday")
+  })
+
+  test("returns correct day for leap day", () => {
+    expect(getDayOfWeek("2024-02-29")).toBe("thursday")
+  })
+
+  test("defaults to today() if no argument is given", () => {
+    // Should match today()'s day of week
+    const todayDate = today()
+    expect(getDayOfWeek()).toBe(getDayOfWeek(todayDate))
+  })
+
+  test("handles invalid date strings (returns 'invalid date')", () => {
+    expect(() => getDayOfWeek("not-a-date")).toThrow(/invalid date/u)
+    expect(getDayOfWeek("2024-02-31")).toBe("saturday")
+  })
+})
+
 describe("isDate", () => {
   test("returns true for valid YYYY-MM-DD dates", () => {
     expect(isDate("2024-06-01")).toBe(true)