@tmlmobilidade/go-utils-dates 20260829.1122.26 → 20260829.1307.28

package/dist/helpers/split-time-intervals.d.ts

@@ -1,12 +1,17 @@
 import { type UnixMilliseconds } from '@tmlmobilidade/go-types-shared';
 /**
  * Splits a time interval into smaller intervals of a given duration.
+ * This function returns an array of `TimeInterval` objects, where the start timestamp
+ * is always before the end timestamp, no matter the specified order. This is to ensure
+ * clarity when using these intervals in database queries, with `$gte`-like operands.
+ * If you are going backwards in time, you are responsible for adpating your queries to the correct order.
  * @param from The start timestamp of the interval.
  * @param to The end timestamp of the interval.
  * @param intervalHrs The duration of the intervals in hours.
- * @returns An array of intervals.
+ * @param order The order of the intervals.
+ * @returns An array of `TimeInterval` objects, where the start timestamp is always before the end timestamp.
  */
-export declare function splitTimeIntervals(from: UnixMilliseconds, to: UnixMilliseconds, intervalHrs: number): {
+export declare function splitTimeIntervals(from: UnixMilliseconds, to: UnixMilliseconds, intervalHrs: number, order: 'asc' | 'desc'): {
     end: number & {
         __brand: "UnixMilliseconds";
     };

package/dist/helpers/split-time-intervals.js

@@ -2,12 +2,17 @@
 import { UnixMillisecondsSchema } from '@tmlmobilidade/go-types-shared';
 /**
  * Splits a time interval into smaller intervals of a given duration.
+ * This function returns an array of `TimeInterval` objects, where the start timestamp
+ * is always before the end timestamp, no matter the specified order. This is to ensure
+ * clarity when using these intervals in database queries, with `$gte`-like operands.
+ * If you are going backwards in time, you are responsible for adpating your queries to the correct order.
  * @param from The start timestamp of the interval.
  * @param to The end timestamp of the interval.
  * @param intervalHrs The duration of the intervals in hours.
- * @returns An array of intervals.
+ * @param order The order of the intervals.
+ * @returns An array of `TimeInterval` objects, where the start timestamp is always before the end timestamp.
  */
-export function splitTimeIntervals(from, to, intervalHrs) {
+export function splitTimeIntervals(from, to, intervalHrs, order) {
     //
     //
     // Validate the input timestamps
@@ -42,6 +47,10 @@ export function splitTimeIntervals(from, to, intervalHrs) {
         endTimestamp = startTimestamp;
     }
     //
-    // Return the intervals in reverse order.
-    return finalIntervals.reverse();
+    // Return the intervals in the desired order.
+    // Since this function is calculating the intervals in descending order,
+    // we need to reverse the final array when going in ascending mode.
+    if (order === 'asc')
+        return finalIntervals.reverse();
+    return finalIntervals;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/go-utils-dates",
-	"version": "20260829.1122.26",
+	"version": "20260829.1307.28",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"