@8ms/helpers 2.0.22 → 2.0.24

package/date/calculation.d.ts

@@ -36,6 +36,10 @@ export declare const differenceInBusinessDays: (start: InputDate, end: InputDate
  * https://www.gov.uk/when-do-the-clocks-change
  */
 export declare const getDatesBetween: (start: InputDate, end: InputDate) => DateTime<true>[];
+/**
+ * Get an array of DateTime objects representing the 1st of each month between start and end dates.
+ */
+export declare const getMonthsBetween: (start: InputDate, end: InputDate) => DateTime<boolean>[];
 /**
  * If a given date is beyond the maximum, return the maximum.
  */

package/date/calculation.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLastWeek = exports.isThisWeek = exports.getYesterday = exports.getWeeksAgo = exports.getToday = exports.getTwoWeeksAgo = exports.getThisWeek = exports.getLastWeek = exports.getSunday = exports.getMonday = exports.getMin = exports.getMax = exports.getDatesBetween = exports.differenceInBusinessDays = exports.differenceInMinutes = exports.isWeekend = exports.isSunday = exports.isSaturday = exports.isFriday = exports.isThursday = exports.isWednesday = exports.isTuesday = exports.isMonday = exports.getDate = exports.getUnix = void 0;
+exports.isLastWeek = exports.isThisWeek = exports.getYesterday = exports.getWeeksAgo = exports.getToday = exports.getTwoWeeksAgo = exports.getThisWeek = exports.getLastWeek = exports.getSunday = exports.getMonday = exports.getMin = exports.getMax = exports.getMonthsBetween = exports.getDatesBetween = exports.differenceInBusinessDays = exports.differenceInMinutes = exports.isWeekend = exports.isSunday = exports.isSaturday = exports.isFriday = exports.isThursday = exports.isWednesday = exports.isTuesday = exports.isMonday = exports.getDate = exports.getUnix = void 0;
 const luxon_1 = require("luxon");
 const getUnix = (input) => {
     return (0, exports.getDate)(input)
@@ -13,10 +13,11 @@ exports.getUnix = getUnix;
  * If it's not UTC, it needs to be converted to UTC before being used.
  */
 const getDate = (input, setMidnight) => {
-    let instance = luxon_1.DateTime.now().toUTC();
+    let instance = luxon_1.DateTime.now()
+        .toUTC();
     if (input) {
         if (input instanceof Date) {
-            instance = luxon_1.DateTime.fromJSDate(input, { zone: 'utc' });
+            instance = luxon_1.DateTime.fromJSDate(input, { zone: "utc" });
         }
         else if (input instanceof luxon_1.DateTime) {
             instance = input.toUTC();
@@ -29,7 +30,7 @@ const getDate = (input, setMidnight) => {
         }
     }
     // Ensure the instance is in UTC timezone
-    instance = instance.setZone('utc', { keepLocalTime: false });
+    instance = instance.setZone("utc", { keepLocalTime: false });
     if (setMidnight) {
         instance = instance.set({
             hour: 0,
@@ -129,6 +130,23 @@ const getDatesBetween = (start, end) => {
     return response;
 };
 exports.getDatesBetween = getDatesBetween;
+/**
+ * Get an array of DateTime objects representing the 1st of each month between start and end dates.
+ */
+const getMonthsBetween = (start, end) => {
+    const months = [];
+    const endDate = (0, exports.getDate)(end)
+        .startOf("month");
+    // Start from the 1st of the month containing startDate
+    let current = (0, exports.getDate)(start).startOf("month");
+    while (current <= endDate) {
+        months.push(current);
+        // Move to next month
+        current = current.plus({ months: 1 });
+    }
+    return months;
+};
+exports.getMonthsBetween = getMonthsBetween;
 /**
  * If a given date is beyond the maximum, return the maximum.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@8ms/helpers",
 	"license": "UNLICENSED",
-	"version": "2.0.22",
+	"version": "2.0.24",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"