getDateRangeSeries (#28)

Author: ogroppo

CHANGELOG.md

@@ -1,5 +1,11 @@
 # deverything
 
+## 3.1.0
+
+### Minor Changes
+
+- getDateRangeSeries
+
 ## 3.0.0
 
 ### Major Changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "deverything",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Everything you need for Dev",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

src/dates/getDateRangeSeries.test.ts

@@ -0,0 +1,83 @@
+import { describe, it, expect } from "@jest/globals";
+import { getDateRangeSeries } from "./getDateRangeSeries";
+
+describe("getDateRangeSeries", () => {
+  it("should return a series of dates as ISO strings for days", () => {
+    const startDate = new Date("2024-01-01");
+    const endDate = new Date("2024-01-05");
+    const unit = "days";
+
+    const result = getDateRangeSeries({ startDate, endDate }, unit);
+
+    expect(result).toEqual([
+      "2024-01-01T00:00:00.000Z",
+      "2024-01-02T00:00:00.000Z",
+      "2024-01-03T00:00:00.000Z",
+      "2024-01-04T00:00:00.000Z",
+    ]);
+  });
+
+  it("should handle a series for hours", () => {
+    const startDate = new Date("2024-01-01T00:00:00.000Z");
+    const endDate = new Date("2024-01-01T03:00:00.000Z");
+    const unit = "hours";
+
+    const result = getDateRangeSeries({ startDate, endDate }, unit);
+
+    expect(result).toEqual([
+      "2024-01-01T00:00:00.000Z",
+      "2024-01-01T01:00:00.000Z",
+      "2024-01-01T02:00:00.000Z",
+    ]);
+  });
+
+  it("should handle a series for minutes", () => {
+    const startDate = new Date("2024-01-01T00:00:00.000Z");
+    const endDate = new Date("2024-01-01T00:05:00.000Z");
+    const unit = "minutes";
+
+    const result = getDateRangeSeries({ startDate, endDate }, unit);
+
+    expect(result).toEqual([
+      "2024-01-01T00:00:00.000Z",
+      "2024-01-01T00:01:00.000Z",
+      "2024-01-01T00:02:00.000Z",
+      "2024-01-01T00:03:00.000Z",
+      "2024-01-01T00:04:00.000Z",
+    ]);
+  });
+
+  it("should handle a series for seconds", () => {
+    const startDate = new Date("2024-01-01T00:00:00.000Z");
+    const endDate = new Date("2024-01-01T00:00:05.000Z");
+    const unit = "seconds";
+
+    const result = getDateRangeSeries({ startDate, endDate }, unit);
+
+    expect(result).toEqual([
+      "2024-01-01T00:00:00.000Z",
+      "2024-01-01T00:00:01.000Z",
+      "2024-01-01T00:00:02.000Z",
+      "2024-01-01T00:00:03.000Z",
+      "2024-01-01T00:00:04.000Z",
+    ]);
+  });
+
+  it("should throw an error if startDate is after endDate", () => {
+    const startDate = new Date("2024-01-05");
+    const endDate = new Date("2024-01-01");
+    const unit = "days";
+
+    expect(() => getDateRangeSeries({ startDate, endDate }, unit)).toThrow();
+  });
+
+  it("should handle a single date range", () => {
+    const startDate = new Date("2024-01-01T00:00:00.000Z");
+    const endDate = new Date("2024-01-01T00:00:00.000Z");
+    const unit = "days";
+
+    const result = getDateRangeSeries({ startDate, endDate }, unit);
+
+    expect(result).toEqual([]);
+  });
+});

src/dates/getDateRangeSeries.ts

@@ -0,0 +1,42 @@
+import { parseDate } from "../helpers/parseDate";
+import { DateRange, ISODate } from "../types";
+
+/**
+ *
+ * @description Generate a series of dates between the start and end dates
+ * NOTE: it does NOT include the end date
+ */
+export const getDateRangeSeries = (
+  dateRange: DateRange,
+  unit: "days" | "hours" | "minutes" | "seconds"
+): ISODate[] => {
+  const series: ISODate[] = [];
+  const unitMap: Record<typeof unit, number> = {
+    days: 24 * 60 * 60 * 1000, // milliseconds in a day
+    hours: 60 * 60 * 1000, // milliseconds in an hour
+    minutes: 60 * 1000, // milliseconds in a minute
+    seconds: 1000, // milliseconds in a second
+  };
+
+  const increment = unitMap[unit];
+
+  const { startDate, endDate } = dateRange;
+
+  const start = parseDate(startDate);
+  const end = parseDate(endDate);
+
+  if (!start || !end || start.getTime() > end.getTime()) {
+    throw new Error("Invalid date range");
+  }
+
+  // Ensure we are working with time in milliseconds
+  let currentTime = start.getTime();
+  const endTime = end.getTime();
+
+  while (currentTime < endTime) {
+    series.push(new Date(currentTime).toISOString());
+    currentTime += increment; // Move forward by the specified unit
+  }
+
+  return series;
+};

src/dates/getDateSeries.ts

@@ -1,5 +1,9 @@
 import { ISODate } from "../types";
 
+/**
+ *
+ * @deprecated use getDateRangeSeries instead
+ */
 export const getDateSeries = (
   startDate: Date,
   endDate: Date,

src/dates/index.ts

@@ -1,4 +1,5 @@
 export * from "./getDateSeries";
+export * from "./getDateRangeSeries";
 export * from "./isOver18";
 export * from "./startOfDay";
 export * from "./startOfNextMonth";