@tim-code/my-util 0.0.17 → 0.0.19

package/package.json

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

package/src/time.js

@@ -6,7 +6,7 @@ import { mod } from "./math.js"
  * @param {boolean=} $1.floorMinute If true, floors to the nearest minute. If false, floors to the nearest second.
  * @param {number=} $1.timestamp Unix timestamp to use instead of current time.
  * @param {string=} $1.timezone Timezone to use instead of Eastern time.
- * @returns {Object} { timestamp, date, time, datetime }
+ * @returns {Object} { timestamp, date: YYYY-MM-DD, time: HH:mm:ss }
  */
 export function getEasternTime({
   floorMinute = false,
@@ -17,7 +17,8 @@ export function getEasternTime({
     timestamp = new Date().getTime() / 1000
   }
   timestamp = floorMinute ? Math.floor(timestamp / 60) * 60 : Math.floor(timestamp)
-  const string = new Date(timestamp * 1000).toLocaleString("en-US", {
+  // 'en-CA' (English - Canada) formats dates as YYYY-MM-DD and times in 24-hour format by default
+  const string = new Date(timestamp * 1000).toLocaleString("en-CA", {
     ...(timezone ? { timeZone: timezone } : {}),
     hour12: false,
     year: "numeric",
@@ -27,9 +28,7 @@ export function getEasternTime({
     minute: "2-digit",
     second: "2-digit",
   })
-  const [americanDate, time] = string.split(", ")
-  const [month, day, year] = americanDate.split("/")
-  const date = [year, month, day].join("-")
+  const [date, time] = string.split(", ")
   return { timestamp, date, time }
 }
 
@@ -38,13 +37,21 @@ export function getEasternTime({
  * @param {Object} $1
  * @param {boolean=} $1.floorMinute If true, floors to the nearest minute. If false, floors to the nearest second.
  * @param {number=} $1.timestamp Unix timestamp to use instead of current time.
- * @param {string=} $1.timezone Timezone to use instead of local time.
+ * @param {string=} $1.timezone Timezone to use instead of local time. undefined corresponds to "America/New_York" and "" (falsy) corresponds to local time.
  * @returns {Object} { timestamp, date, time, minute, datetime }
  */
-export function getTime({ floorMinute, timestamp, timezone = false } = {}) {
+export function getTime({ floorMinute, timestamp, timezone = "" } = {}) {
   return getEasternTime({ floorMinute, timestamp, timezone })
 }
 
+/**
+ * Get today's date in YYYY-MM-DD format.
+ * @returns {string}
+ */
+export function today() {
+  return getTime().date
+}
+
 /**
  * Checks if the string represents a valid YYYY-MM-DD date.
  * This will return false for dates like "2024-02-31".
@@ -88,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
@@ -112,9 +119,35 @@ 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
+ * @returns {Array} times in HH:mm:ss
+ */
+export function getMinuteRange(start, end) {
+  // coerce start and end to seconds
+  start = addTime(start)
+  end = addTime(end)
+  if (!(start <= end)) {
+    throw new Error("start time is not less than end time")
+  }
+  const times = []
+  let current = start
+  while (current <= end) {
+    times.push(current)
+    current = addTime(current, { minutes: 1 })
+    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}
  */
@@ -127,8 +160,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

@@ -4,10 +4,12 @@ import {
   addTime,
   getDateRange,
   getEasternTime,
+  getMinuteRange,
   getTime,
   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,49 @@ describe("addTime", () => {
   })
 })
 
+describe("getMinuteRange", () => {
+  test("returns all minutes between start and end inclusive", () => {
+    expect(getMinuteRange("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(getMinuteRange("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(getMinuteRange("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(getMinuteRange("12:34:56", "12:34:56")).toEqual(["12:34:56"])
+  })
+
+  test("throws if start is not less than end", () => {
+    expect(() => getMinuteRange("12:04:00", "12:03:00")).toThrow(
+      /start time is not less than end time/u
+    )
+    expect(() => getMinuteRange("12:00:00", "12:00:00")).not.toThrow()
+  })
+
+  test("handles input with no seconds", () => {
+    expect(getMinuteRange("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")