@8ms/helpers 2.0.12 → 2.0.13

package/date/calculation.d.ts

@@ -4,12 +4,25 @@ import { InputDate, Timeframe } from "./";
  * Convert an client's input (any time-zone) ready to be used by the server (UTC).
  */
 export declare const getUtcDate: (input: InputDate, inputZone?: Zone) => DateTime<boolean>;
+export declare const getUnix: (input?: InputDate) => number;
 /**
  * Assume the input is always UTC.
  *
  * If it's not UTC, it needs to be converted to UTC before being used.
  */
 export declare const getDate: (input?: InputDate, setMidnight?: boolean) => DateTime<boolean>;
+/**
+ * Determines if a given date falls on a weekend.
+ *
+ * This function checks whether the day of the week for the provided input corresponds
+ * to Saturday or Sunday, where weekday values of 6 and 7 represent Saturday and Sunday, respectively.
+ */
+export declare const isWeekend: (input: InputDate) => boolean;
+/**
+ * Calculates the difference in business days between two dates.
+ * Business days are considered as weekdays (Monday to Friday).
+ */
+export declare const differenceInBusinessDays: (start: InputDate, end: InputDate) => number;
 /**
  * Similar to date-fns' eachDayOfInterval, however the timezone messes this function up.
  * https://date-fns.org/v2.28.0/docs/eachDayOfInterval

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.getDate = exports.getUtcDate = 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.getDatesBetween = exports.differenceInBusinessDays = exports.isWeekend = exports.getDate = exports.getUnix = exports.getUtcDate = void 0;
 const luxon_1 = require("luxon");
 /**
  * Convert an client's input (any time-zone) ready to be used by the server (UTC).
@@ -24,6 +24,11 @@ const getUtcDate = (input, inputZone) => {
     return instance.toUTC();
 };
 exports.getUtcDate = getUtcDate;
+const getUnix = (input) => {
+    return (0, exports.getDate)(input)
+        .toUnixInteger();
+};
+exports.getUnix = getUnix;
 /**
  * Assume the input is always UTC.
  *
@@ -33,7 +38,8 @@ const getDate = (input, setMidnight) => {
     let instance = luxon_1.DateTime.now();
     if (input) {
         if (input instanceof Date) {
-            instance = luxon_1.DateTime.fromJSDate(input).toUTC();
+            instance = luxon_1.DateTime.fromJSDate(input)
+                .toUTC();
         }
         else if (input instanceof luxon_1.DateTime) {
             instance = input.toUTC();
@@ -57,6 +63,36 @@ const getDate = (input, setMidnight) => {
     return instance;
 };
 exports.getDate = getDate;
+/**
+ * Determines if a given date falls on a weekend.
+ *
+ * This function checks whether the day of the week for the provided input corresponds
+ * to Saturday or Sunday, where weekday values of 6 and 7 represent Saturday and Sunday, respectively.
+ */
+const isWeekend = (input) => {
+    const date = (0, exports.getDate)(input);
+    return date.weekday >= 6;
+};
+exports.isWeekend = isWeekend;
+/**
+ * Calculates the difference in business days between two dates.
+ * Business days are considered as weekdays (Monday to Friday).
+ */
+const differenceInBusinessDays = (start, end) => {
+    const startDate = (0, exports.getDate)(start);
+    const endDate = (0, exports.getDate)(end);
+    let businessDays = 0;
+    let current = startDate.startOf("day");
+    while (current < endDate.startOf("day")) {
+        // weekday 1-5 are Monday-Friday (business days)
+        if (current.weekday <= 5) {
+            businessDays++;
+        }
+        current = current.plus({ days: 1 });
+    }
+    return businessDays;
+};
+exports.differenceInBusinessDays = differenceInBusinessDays;
 /**
  * Similar to date-fns' eachDayOfInterval, however the timezone messes this function up.
  * https://date-fns.org/v2.28.0/docs/eachDayOfInterval

package/package.json

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