@tim-code/my-util 0.0.18 → 0.0.20

package/package.json

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

package/src/time.js

@@ -95,7 +95,7 @@ export function isUnixTimestamp(ts, { max = 9999999999 } = {}) {
 
 /**
  * Add an amount of time to a time string.
- * @param {string} timeString HH:mm:ss or HH:mm; parsable numbers separated by :
+ * @param {string} timeString HH:mm:ss or HH:mm
  * @param {Object} $1
  * @param {number} $1.hours Hours to add to time string
  * @param {number} $1.minutes Minutes to add to time string
@@ -119,9 +119,36 @@ export function addTime(timeString, { minutes = 0, hours = 0 } = {}) {
   return newTime
 }
 
+const MINUTES_IN_DAY = 24 * 60
+/**
+ * Get all minutes between two times.
+ * This does not work across day i.e 23:59:00 to 00:00:00.
+ * @param {string} start HH:mm:ss or HH:mm
+ * @param {string} end HH:mm:ss or HH:mm
+ * @param {Object} $1
+ * @param {number} $1.hours Hours to add to get next time in range. Default 0
+ * @param {number} $1.minutes Minutes to add to get next time in range. Default 1
+ * @returns {Array} times in HH:mm:ss
+ */
+export function getTimeRange(start, end, { hours = 0, minutes = 1 } = {}) {
+  // coerce start and end to seconds
+  start = addTime(start)
+  end = addTime(end)
+  const times = []
+  let current = start
+  while (current <= end) {
+    times.push(current)
+    current = addTime(current, { hours, minutes })
+    if (times.length >= MINUTES_IN_DAY) {
+      break
+    }
+  }
+  return times
+}
+
 /**
  * Adds a number of days to a date string.
- * @param {string} dateString
+ * @param {string} dateString YYYY-MM-DD
  * @param {number} days
  * @returns {string}
  */
@@ -134,8 +161,8 @@ export function addDays(dateString, days = 0) {
 
 /**
  * Get all dates between two dates, with limit.
- * @param {string} start
- * @param {string} end
+ * @param {string} start YYYY-MM-DD
+ * @param {string} end YYYY-MM-DD
  * @returns {Array}
  */
 export function getDateRange(start, end, { limit = 1000 } = {}) {

package/src/time.test.js

@@ -5,9 +5,11 @@ import {
   getDateRange,
   getEasternTime,
   getTime,
+  getTimeRange,
   isDate,
   isTime,
   isUnixTimestamp,
+  today,
 } from "./time.js"
 
 // getEasternTime changed: now accepts a "timezone" param and no longer returns "minute" or "datetime"
@@ -177,6 +179,14 @@ describe("getTime", () => {
   })
 })
 
+describe("today", () => {
+  test("returns today's date in YYYY-MM-DD format", () => {
+    const expected = getTime().date
+    expect(today()).toBe(expected)
+    expect(/^\d{4}-\d{2}-\d{2}$/u.test(today())).toBe(true)
+  })
+})
+
 describe("isDate", () => {
   test("returns true for valid YYYY-MM-DD dates", () => {
     expect(isDate("2024-06-01")).toBe(true)
@@ -316,6 +326,43 @@ describe("addTime", () => {
   })
 })
 
+describe("getTimeRange", () => {
+  test("returns all minutes between start and end inclusive", () => {
+    expect(getTimeRange("12:00:00", "12:03:00")).toEqual([
+      "12:00:00",
+      "12:01:00",
+      "12:02:00",
+      "12:03:00",
+    ])
+  })
+
+  test("works with times that cross the hour", () => {
+    expect(getTimeRange("12:58:00", "13:01:00")).toEqual([
+      "12:58:00",
+      "12:59:00",
+      "13:00:00",
+      "13:01:00",
+    ])
+  })
+
+  test("works with times with nonzero seconds", () => {
+    expect(getTimeRange("12:00:30", "12:02:30")).toEqual(["12:00:30", "12:01:30", "12:02:30"])
+  })
+
+  test("returns single element if start equals end", () => {
+    expect(getTimeRange("12:34:56", "12:34:56")).toEqual(["12:34:56"])
+  })
+
+  test("handles if start is greater or equal to end", () => {
+    expect(getTimeRange("12:04:00", "12:03:00")).toEqual([])
+    expect(getTimeRange("12:00:00", "12:00:00")).toEqual(["12:00:00"])
+  })
+
+  test("handles input with no seconds", () => {
+    expect(getTimeRange("12:00", "12:02")).toEqual(["12:00:00", "12:01:00", "12:02:00"])
+  })
+})
+
 describe("addDays", () => {
   test("adds days within the same month", () => {
     expect(addDays("2024-06-01", 5)).toBe("2024-06-06")