@tim-code/my-util 0.8.1 → 0.8.2

package/package.json

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

package/src/time.js

@@ -260,3 +260,23 @@ export function getStartOfWeek(dateString) {
   const start = addDays(dateString, { days: -index })
   return start
 }
+
+/**
+ * Returns number of seconds from any combination of weeks, days, hours, and minutes.
+ * @param {Object} $1
+ * @param {number=} $1.weeks Default is 0
+ * @param {number=} $1.days Default is 0
+ * @param {number=} $1.hours Default is 0
+ * @param {number=} $1.minutes Default is 0
+ * @returns {number}
+ */
+export function convertToSeconds({ weeks = 0, days = 0, hours = 0, minutes = 0 }) {
+  if (!(weeks >= 0) || !(days >= 0) || !(hours >= 0) || !(minutes >= 0)) {
+    throw new Error("weeks, days, hours, and minutes must be nonnegative")
+  }
+  days += weeks * 7
+  hours += days * 24
+  minutes += hours * 60
+  const seconds = minutes * 60
+  return seconds
+}

package/src/time.test.js

@@ -2,6 +2,7 @@ import { describe, expect, test } from "@jest/globals"
 import {
   addDays,
   addTime,
+  convertToSeconds,
   getDateRange,
   getDayIndexInWeek,
   getEasternTime,
@@ -21,7 +22,7 @@ import {
 // Exported functions:
 // getEasternTime, getTime, getUnixTimestamp, today, getDayIndexInWeek, getMinute,
 // isDateString, isTimeString, isDateTimeString, isUTCString, isUnixTimestamp,
-// addTime, getTimeRange, addDays, getDateRange, getStartOfWeek
+// addTime, getTimeRange, addDays, getDateRange, getStartOfWeek, convertToSeconds
 
 describe("getEasternTime", () => {
   test("returns correct structure and types", () => {
@@ -586,3 +587,32 @@ describe("getStartOfWeek", () => {
     expect(getStartOfWeek("2023-01-02")).toBe("2023-01-01")
   })
 })
+
+describe("convertToSeconds", () => {
+  test("returns 0 for empty input object", () => {
+    expect(convertToSeconds({})).toBe(0)
+  })
+
+  test("converts single units correctly", () => {
+    expect(convertToSeconds({ minutes: 5 })).toBe(5 * 60)
+    expect(convertToSeconds({ hours: 2 })).toBe(2 * 3600)
+    expect(convertToSeconds({ days: 1 })).toBe(24 * 3600)
+    expect(convertToSeconds({ weeks: 1 })).toBe(7 * 24 * 3600)
+  })
+
+  test("converts combined weeks, days, hours, and minutes", () => {
+    // 1w + 2d + 3h + 4m = 788640 seconds
+    expect(convertToSeconds({ weeks: 1, days: 2, hours: 3, minutes: 4 })).toBe(788640)
+  })
+
+  test("supports fractional values (minutes: 0.5 => 30 seconds)", () => {
+    expect(convertToSeconds({ minutes: 0.5 })).toBe(30)
+  })
+
+  test("throws if any value is negative", () => {
+    const cases = [{ weeks: -1 }, { days: -1 }, { hours: -1 }, { minutes: -1 }]
+    for (const opts of cases) {
+      expect(() => convertToSeconds(opts)).toThrow("must be nonnegative")
+    }
+  })
+})