@tim-code/my-util 0.0.19 → 0.0.20

package/package.json

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

package/src/time.js

@@ -121,23 +121,24 @@ export function addTime(timeString, { minutes = 0, hours = 0 } = {}) {
 
 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.
+ * 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 getMinuteRange(start, end) {
+export function getTimeRange(start, end, { hours = 0, minutes = 1 } = {}) {
   // 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 })
+    current = addTime(current, { hours, minutes })
     if (times.length >= MINUTES_IN_DAY) {
       break
     }

package/src/time.test.js

@@ -4,8 +4,8 @@ import {
   addTime,
   getDateRange,
   getEasternTime,
-  getMinuteRange,
   getTime,
+  getTimeRange,
   isDate,
   isTime,
   isUnixTimestamp,
@@ -326,9 +326,9 @@ describe("addTime", () => {
   })
 })
 
-describe("getMinuteRange", () => {
+describe("getTimeRange", () => {
   test("returns all minutes between start and end inclusive", () => {
-    expect(getMinuteRange("12:00:00", "12:03:00")).toEqual([
+    expect(getTimeRange("12:00:00", "12:03:00")).toEqual([
       "12:00:00",
       "12:01:00",
       "12:02:00",
@@ -337,7 +337,7 @@ describe("getMinuteRange", () => {
   })
 
   test("works with times that cross the hour", () => {
-    expect(getMinuteRange("12:58:00", "13:01:00")).toEqual([
+    expect(getTimeRange("12:58:00", "13:01:00")).toEqual([
       "12:58:00",
       "12:59:00",
       "13:00:00",
@@ -346,26 +346,20 @@ describe("getMinuteRange", () => {
   })
 
   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",
-    ])
+    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(getMinuteRange("12:34:56", "12:34:56")).toEqual(["12:34:56"])
+    expect(getTimeRange("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 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(getMinuteRange("12:00", "12:02")).toEqual(["12:00:00", "12:01:00", "12:02:00"])
+    expect(getTimeRange("12:00", "12:02")).toEqual(["12:00:00", "12:01:00", "12:02:00"])
   })
 })