@alextheman/utility 3.5.9 → 3.5.10

package/dist/index.cjs

@@ -264,8 +264,16 @@ var createTemplateStringsArray_default = createTemplateStringsArray;
 
 //#endregion
 //#region src/functions/date/addDaysToDate.ts
+/**
+* Adds a given number of days to the provided date, returning the result as a new instance of Date.
+*
+* @param currentDate - The starting date (defaults to today).
+* @param dayIncrement - The amount of days you want to add (defaults to 1)
+*
+* @returns A new Date instance with the number of days added to the initially provided date.
+*/
 function addDaysToDate(currentDate = /* @__PURE__ */ new Date(), dayIncrement = 1) {
-	const newDate = currentDate;
+	const newDate = new Date(currentDate);
 	newDate.setDate(newDate.getDate() + dayIncrement);
 	return newDate;
 }
@@ -273,6 +281,14 @@ var addDaysToDate_default = addDaysToDate;
 
 //#endregion
 //#region src/functions/date/isSameDate.ts
+/**
+* Checks if the provided dates happen on the exact same day, month, and year.
+*
+* @param firstDate - The first date to compare.
+* @param secondDate - The second date to compare.
+*
+* @returns True if the provided dates occur on exactly the same day, month, and year, and returns false otherwise.
+*/
 function isSameDate(firstDate, secondDate) {
 	return firstDate.getDate() === secondDate.getDate() && firstDate.getMonth() === secondDate.getMonth() && firstDate.getFullYear() === secondDate.getFullYear();
 }
@@ -280,6 +296,17 @@ var isSameDate_default = isSameDate;
 
 //#endregion
 //#region src/functions/date/formatDateAndTime.ts
+/**
+* Creates a human-readable string with information about the input date.
+*
+* @param inputDate - The date to base the string on.
+*
+* @returns A new string with information about the given date.
+*
+* - If the date given is today, the output will be something like `Today at HH:MM`
+* - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+* - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+*/
 function formatDateAndTime(inputDate) {
 	const yesterday = addDaysToDate_default(/* @__PURE__ */ new Date(), -1);
 	const today = /* @__PURE__ */ new Date();
@@ -292,6 +319,15 @@ var formatDateAndTime_default = formatDateAndTime;
 
 //#endregion
 //#region src/functions/date/isLeapYear.ts
+/**
+* Checks if the provided year is a leap year.
+*
+* @param year - The year to check as a number.
+*
+* @throws {TypeError} If the year provided is not an integer.
+*
+* @returns True if the year is a leap year, and false otherwise.
+*/
 function isLeapYear(year) {
 	const parsedYear = parseIntStrict_default(`${year}`);
 	return parsedYear % 4 === 0 && parsedYear % 100 !== 0 || parsedYear % 400 === 0;
@@ -304,6 +340,14 @@ function checkLeapYear(firstDate, secondDate) {
 	if (isLeapYear_default(firstDate.getFullYear()) && firstDate.getMonth() === 1 && secondDate.getMonth() === 1) return firstDate.getDate() === 29 && secondDate.getDate() === 28;
 	return false;
 }
+/**
+* Checks if the provided dates are exactly a whole number of years apart.
+*
+* @param firstDate - The first date to compare.
+* @param secondDate - The second date to compare.
+*
+* @returns True if the provided dates are exactly a whole number of years apart, and false otherwise.
+*/
 function isAnniversary(firstDate, secondDate) {
 	if (checkLeapYear(firstDate, secondDate) || checkLeapYear(secondDate, firstDate)) return true;
 	return firstDate.getDate() === secondDate.getDate() && firstDate.getMonth() === secondDate.getMonth();
@@ -342,6 +386,14 @@ function leapYearFebruaryChecks(firstDate, secondDate) {
 	}
 	return false;
 }
+/**
+* Checks if the provided dates are exactly a whole number of months apart.
+*
+* @param firstDate - The first date to compare.
+* @param secondDate - The second date to compare.
+*
+* @returns True if the provided dates are exactly a whole number of months apart, and false otherwise.
+*/
 function isMonthlyMultiple(firstDate, secondDate) {
 	if (endOfMonthChecksButNotFebruary(firstDate, secondDate) || endOfMonthChecksButNotFebruary(secondDate, firstDate)) return true;
 	if (nonLeapYearFebruaryChecks(firstDate, secondDate) || nonLeapYearFebruaryChecks(secondDate, firstDate)) return true;

package/dist/index.d.cts

@@ -176,21 +176,73 @@ declare function createFormData<T extends Record<RecordKey, unknown>>(data: T, o
 declare function createTemplateStringsArray(strings: readonly string[]): TemplateStringsArray;
 //#endregion
 //#region src/functions/date/addDaysToDate.d.ts
+/**
+ * Adds a given number of days to the provided date, returning the result as a new instance of Date.
+ *
+ * @param currentDate - The starting date (defaults to today).
+ * @param dayIncrement - The amount of days you want to add (defaults to 1)
+ *
+ * @returns A new Date instance with the number of days added to the initially provided date.
+ */
 declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
 //#endregion
 //#region src/functions/date/formatDateAndTime.d.ts
+/**
+ * Creates a human-readable string with information about the input date.
+ *
+ * @param inputDate - The date to base the string on.
+ *
+ * @returns A new string with information about the given date.
+ *
+ * - If the date given is today, the output will be something like `Today at HH:MM`
+ * - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+ * - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+ */
 declare function formatDateAndTime(inputDate: Date): string;
 //#endregion
 //#region src/functions/date/isAnniversary.d.ts
+/**
+ * Checks if the provided dates are exactly a whole number of years apart.
+ *
+ * @param firstDate - The first date to compare.
+ * @param secondDate - The second date to compare.
+ *
+ * @returns True if the provided dates are exactly a whole number of years apart, and false otherwise.
+ */
 declare function isAnniversary(firstDate: Date, secondDate: Date): boolean;
 //#endregion
 //#region src/functions/date/isLeapYear.d.ts
+/**
+ * Checks if the provided year is a leap year.
+ *
+ * @param year - The year to check as a number.
+ *
+ * @throws {TypeError} If the year provided is not an integer.
+ *
+ * @returns True if the year is a leap year, and false otherwise.
+ */
 declare function isLeapYear(year: number): boolean;
 //#endregion
 //#region src/functions/date/isMonthlyMultiple.d.ts
+/**
+ * Checks if the provided dates are exactly a whole number of months apart.
+ *
+ * @param firstDate - The first date to compare.
+ * @param secondDate - The second date to compare.
+ *
+ * @returns True if the provided dates are exactly a whole number of months apart, and false otherwise.
+ */
 declare function isMonthlyMultiple(firstDate: Date, secondDate: Date): boolean;
 //#endregion
 //#region src/functions/date/isSameDate.d.ts
+/**
+ * Checks if the provided dates happen on the exact same day, month, and year.
+ *
+ * @param firstDate - The first date to compare.
+ * @param secondDate - The second date to compare.
+ *
+ * @returns True if the provided dates occur on exactly the same day, month, and year, and returns false otherwise.
+ */
 declare function isSameDate(firstDate: Date, secondDate: Date): boolean;
 //#endregion
 //#region src/functions/deepCopy.d.ts

package/dist/index.d.ts

@@ -176,21 +176,73 @@ declare function createFormData<T extends Record<RecordKey, unknown>>(data: T, o
 declare function createTemplateStringsArray(strings: readonly string[]): TemplateStringsArray;
 //#endregion
 //#region src/functions/date/addDaysToDate.d.ts
+/**
+ * Adds a given number of days to the provided date, returning the result as a new instance of Date.
+ *
+ * @param currentDate - The starting date (defaults to today).
+ * @param dayIncrement - The amount of days you want to add (defaults to 1)
+ *
+ * @returns A new Date instance with the number of days added to the initially provided date.
+ */
 declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
 //#endregion
 //#region src/functions/date/formatDateAndTime.d.ts
+/**
+ * Creates a human-readable string with information about the input date.
+ *
+ * @param inputDate - The date to base the string on.
+ *
+ * @returns A new string with information about the given date.
+ *
+ * - If the date given is today, the output will be something like `Today at HH:MM`
+ * - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+ * - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+ */
 declare function formatDateAndTime(inputDate: Date): string;
 //#endregion
 //#region src/functions/date/isAnniversary.d.ts
+/**
+ * Checks if the provided dates are exactly a whole number of years apart.
+ *
+ * @param firstDate - The first date to compare.
+ * @param secondDate - The second date to compare.
+ *
+ * @returns True if the provided dates are exactly a whole number of years apart, and false otherwise.
+ */
 declare function isAnniversary(firstDate: Date, secondDate: Date): boolean;
 //#endregion
 //#region src/functions/date/isLeapYear.d.ts
+/**
+ * Checks if the provided year is a leap year.
+ *
+ * @param year - The year to check as a number.
+ *
+ * @throws {TypeError} If the year provided is not an integer.
+ *
+ * @returns True if the year is a leap year, and false otherwise.
+ */
 declare function isLeapYear(year: number): boolean;
 //#endregion
 //#region src/functions/date/isMonthlyMultiple.d.ts
+/**
+ * Checks if the provided dates are exactly a whole number of months apart.
+ *
+ * @param firstDate - The first date to compare.
+ * @param secondDate - The second date to compare.
+ *
+ * @returns True if the provided dates are exactly a whole number of months apart, and false otherwise.
+ */
 declare function isMonthlyMultiple(firstDate: Date, secondDate: Date): boolean;
 //#endregion
 //#region src/functions/date/isSameDate.d.ts
+/**
+ * Checks if the provided dates happen on the exact same day, month, and year.
+ *
+ * @param firstDate - The first date to compare.
+ * @param secondDate - The second date to compare.
+ *
+ * @returns True if the provided dates occur on exactly the same day, month, and year, and returns false otherwise.
+ */
 declare function isSameDate(firstDate: Date, secondDate: Date): boolean;
 //#endregion
 //#region src/functions/deepCopy.d.ts

package/dist/index.js

@@ -235,8 +235,16 @@ var createTemplateStringsArray_default = createTemplateStringsArray;
 
 //#endregion
 //#region src/functions/date/addDaysToDate.ts
+/**
+* Adds a given number of days to the provided date, returning the result as a new instance of Date.
+*
+* @param currentDate - The starting date (defaults to today).
+* @param dayIncrement - The amount of days you want to add (defaults to 1)
+*
+* @returns A new Date instance with the number of days added to the initially provided date.
+*/
 function addDaysToDate(currentDate = /* @__PURE__ */ new Date(), dayIncrement = 1) {
-	const newDate = currentDate;
+	const newDate = new Date(currentDate);
 	newDate.setDate(newDate.getDate() + dayIncrement);
 	return newDate;
 }
@@ -244,6 +252,14 @@ var addDaysToDate_default = addDaysToDate;
 
 //#endregion
 //#region src/functions/date/isSameDate.ts
+/**
+* Checks if the provided dates happen on the exact same day, month, and year.
+*
+* @param firstDate - The first date to compare.
+* @param secondDate - The second date to compare.
+*
+* @returns True if the provided dates occur on exactly the same day, month, and year, and returns false otherwise.
+*/
 function isSameDate(firstDate, secondDate) {
 	return firstDate.getDate() === secondDate.getDate() && firstDate.getMonth() === secondDate.getMonth() && firstDate.getFullYear() === secondDate.getFullYear();
 }
@@ -251,6 +267,17 @@ var isSameDate_default = isSameDate;
 
 //#endregion
 //#region src/functions/date/formatDateAndTime.ts
+/**
+* Creates a human-readable string with information about the input date.
+*
+* @param inputDate - The date to base the string on.
+*
+* @returns A new string with information about the given date.
+*
+* - If the date given is today, the output will be something like `Today at HH:MM`
+* - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+* - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+*/
 function formatDateAndTime(inputDate) {
 	const yesterday = addDaysToDate_default(/* @__PURE__ */ new Date(), -1);
 	const today = /* @__PURE__ */ new Date();
@@ -263,6 +290,15 @@ var formatDateAndTime_default = formatDateAndTime;
 
 //#endregion
 //#region src/functions/date/isLeapYear.ts
+/**
+* Checks if the provided year is a leap year.
+*
+* @param year - The year to check as a number.
+*
+* @throws {TypeError} If the year provided is not an integer.
+*
+* @returns True if the year is a leap year, and false otherwise.
+*/
 function isLeapYear(year) {
 	const parsedYear = parseIntStrict_default(`${year}`);
 	return parsedYear % 4 === 0 && parsedYear % 100 !== 0 || parsedYear % 400 === 0;
@@ -275,6 +311,14 @@ function checkLeapYear(firstDate, secondDate) {
 	if (isLeapYear_default(firstDate.getFullYear()) && firstDate.getMonth() === 1 && secondDate.getMonth() === 1) return firstDate.getDate() === 29 && secondDate.getDate() === 28;
 	return false;
 }
+/**
+* Checks if the provided dates are exactly a whole number of years apart.
+*
+* @param firstDate - The first date to compare.
+* @param secondDate - The second date to compare.
+*
+* @returns True if the provided dates are exactly a whole number of years apart, and false otherwise.
+*/
 function isAnniversary(firstDate, secondDate) {
 	if (checkLeapYear(firstDate, secondDate) || checkLeapYear(secondDate, firstDate)) return true;
 	return firstDate.getDate() === secondDate.getDate() && firstDate.getMonth() === secondDate.getMonth();
@@ -313,6 +357,14 @@ function leapYearFebruaryChecks(firstDate, secondDate) {
 	}
 	return false;
 }
+/**
+* Checks if the provided dates are exactly a whole number of months apart.
+*
+* @param firstDate - The first date to compare.
+* @param secondDate - The second date to compare.
+*
+* @returns True if the provided dates are exactly a whole number of months apart, and false otherwise.
+*/
 function isMonthlyMultiple(firstDate, secondDate) {
 	if (endOfMonthChecksButNotFebruary(firstDate, secondDate) || endOfMonthChecksButNotFebruary(secondDate, firstDate)) return true;
 	if (nonLeapYearFebruaryChecks(firstDate, secondDate) || nonLeapYearFebruaryChecks(secondDate, firstDate)) return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "3.5.9",
+  "version": "3.5.10",
   "description": "Helpful utility functions",
   "repository": {
     "type": "git",