@qrvey/utils 1.10.1 → 1.11.0-1

package/dist/cjs/dates/adapters/ISOToNumericOffset.d.ts

@@ -1,6 +1,6 @@
 /**
  * Gets the numeric offset (minutes) from the ISO offset (string)
- * @param {string} offset the timezone offset
+ * @param {number | string} offset the timezone offset
  * @returns {number} the offset in minutes
  */
 export declare function ISOToNumericOffset(offset: number | string): number;

package/dist/cjs/dates/adapters/ISOToNumericOffset.js

@@ -6,7 +6,7 @@ const getSign_1 = require("../../general/numeric/getSign");
 const isValidISOOffset_1 = require("../helpers/isValidISOOffset");
 /**
  * Gets the numeric offset (minutes) from the ISO offset (string)
- * @param {string} offset the timezone offset
+ * @param {number | string} offset the timezone offset
  * @returns {number} the offset in minutes
  */
 function ISOToNumericOffset(offset) {

package/dist/cjs/dates/adapters/dateToHms.d.ts

@@ -1,8 +1,9 @@
 import { IDFDateToHmsSettings } from "../interfaces/IDFDateToHmsSettings";
+import { IDate } from "../interfaces/IDate";
 /**
  * * Transform a Date to [HH:mm:ss] date format.
- * @param date String, object or millisencond number of the date
- * @param settings the settings of the dateToHms function
- * @returns string of [HH:mm:ss] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} string of [HH:mm:ss] date format
  */
-export declare function dateToHms(date: string | Date | number, settings?: IDFDateToHmsSettings): string;
+export declare function dateToHms(date: IDate, settings?: IDFDateToHmsSettings): string;

package/dist/cjs/dates/adapters/dateToHms.js

@@ -7,9 +7,9 @@ const isValidDateObject_1 = require("../helpers/isValidDateObject");
 const isValidPotentialDate_1 = require("../helpers/isValidPotentialDate");
 /**
  * * Transform a Date to [HH:mm:ss] date format.
- * @param date String, object or millisencond number of the date
- * @param settings the settings of the dateToHms function
- * @returns string of [HH:mm:ss] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} string of [HH:mm:ss] date format
  */
 function dateToHms(date, settings) {
     if (!(0, isValidPotentialDate_1.isValidPotentialDate)(date))
@@ -27,8 +27,8 @@ function dateToHms(date, settings) {
 exports.dateToHms = dateToHms;
 /**
  * Gets the settings for this function.
- * @param settings the settings of the dateToHms function
- * @returns a new object for the settings
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {IDFDateToHmsSettings} a new object for the settings
  */
 function getDefaultSettings(settings) {
     var _a, _b, _c;
@@ -36,27 +36,27 @@ function getDefaultSettings(settings) {
 }
 /**
  * Gets the Hours
- * @param date the date object
- * @param settings the settings of the dateToHms function
- * @returns the hour string
+ * @param {Date} date the date object
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} the hour string
  */
 function getHours(date, settings) {
     return (0, padLeadingZeros_1.padLeadingZeros)(settings.omitHour ? "0" : date.getHours(), 2).slice(-2);
 }
 /**
  * Gets the Minutes
- * @param date the date object
- * @param settings the settings of the dateToHms function
- * @returns the minute string
+ * @param {Date} date the date object
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} the minute string
  */
 function getMinutes(date, settings) {
     return (0, padLeadingZeros_1.padLeadingZeros)(settings.omitMinute ? "0" : date.getMinutes(), 2).slice(-2);
 }
 /**
  * Gets the Seconds
- * @param date the date object
- * @param settings the settings of the dateToHms function
- * @returns the seconds string
+ * @param {Date} date the date object
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} the seconds string
  */
 function getSeconds(date, settings) {
     return (0, padLeadingZeros_1.padLeadingZeros)(settings.omitSecond ? "0" : date.getSeconds(), 2).slice(-2);

package/dist/cjs/dates/adapters/dateToMdyDate.d.ts

@@ -1,7 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transform a Date to [mm/dd/yyyy] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [mm/dd/yyyy] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [mm/dd/yyyy] date format
  */
-export declare function dateToMdyDate(date: string | Date | number, settings?: IDateSettings): string;
+export declare function dateToMdyDate(date: IDate, settings?: IDateSettings): string;

package/dist/cjs/dates/adapters/dateToMdyDate.js

@@ -9,8 +9,9 @@ const isValidPotentialDate_1 = require("../helpers/isValidPotentialDate");
 const dateToHms_1 = require("./dateToHms");
 /**
  * Transform a Date to [mm/dd/yyyy] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [mm/dd/yyyy] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [mm/dd/yyyy] date format
  */
 function dateToMdyDate(date, settings) {
     if (!(0, isValidPotentialDate_1.isValidPotentialDate)(date))

package/dist/cjs/dates/adapters/dateToMonthYear.d.ts

@@ -1,7 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transform a Date to [Month Year] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [Month Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Month Year] date format
  */
-export declare function dateToMonthYear(date: string | Date | number, settings?: IDateSettings): string;
+export declare function dateToMonthYear(date: IDate, settings?: IDateSettings): string;

package/dist/cjs/dates/adapters/dateToMonthYear.js

@@ -8,8 +8,9 @@ const isValidDateObject_1 = require("../helpers/isValidDateObject");
 const isValidPotentialDate_1 = require("../helpers/isValidPotentialDate");
 /**
  * Transform a Date to [Month Year] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [Month Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Month Year] date format
  */
 function dateToMonthYear(date, settings) {
     if (!(0, isValidPotentialDate_1.isValidPotentialDate)(date))

package/dist/cjs/dates/adapters/dateToQuarterYear.d.ts

@@ -1,7 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transform a valid Date to [Quarter Year] date format.
- * @param date String of a valid date, date object or millisencond number of the date
- * @returns string of [Quarter Year] date format
+ * @param {IDate} date String of a valid date, date object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Quarter Year] date format
  */
-export declare function dateToQuarterYear(date: string | Date | number, settings?: IDateSettings): string;
+export declare function dateToQuarterYear(date: IDate, settings?: IDateSettings): string;

package/dist/cjs/dates/adapters/dateToQuarterYear.js

@@ -8,8 +8,9 @@ const isValidDateObject_1 = require("../helpers/isValidDateObject");
 const isValidPotentialDate_1 = require("../helpers/isValidPotentialDate");
 /**
  * Transform a valid Date to [Quarter Year] date format.
- * @param date String of a valid date, date object or millisencond number of the date
- * @returns string of [Quarter Year] date format
+ * @param {IDate} date String of a valid date, date object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Quarter Year] date format
  */
 function dateToQuarterYear(date, settings) {
     if (!(0, isValidPotentialDate_1.isValidPotentialDate)(date))

package/dist/cjs/dates/adapters/dateToWeekYear.d.ts

@@ -1,7 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transform a Date to [W# Year] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [W# Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [W# Year] date format
  */
-export declare function dateToWeekYear(date: string | Date | number, settings?: IDateSettings): string;
+export declare function dateToWeekYear(date: IDate, settings?: IDateSettings): string;

package/dist/cjs/dates/adapters/dateToWeekYear.js

@@ -8,8 +8,9 @@ const isValidDateObject_1 = require("../helpers/isValidDateObject");
 const isValidPotentialDate_1 = require("../helpers/isValidPotentialDate");
 /**
  * Transform a Date to [W# Year] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [W# Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [W# Year] date format
  */
 function dateToWeekYear(date, settings) {
     if (!(0, isValidPotentialDate_1.isValidPotentialDate)(date))

package/dist/cjs/dates/adapters/dateToYear.d.ts

@@ -1,7 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transform a Date to [Year] date format.
- * @param {string | Date | number} date String, object or millisencond number of the date
- * @returns string of [Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Year] date format
  */
-export declare function dateToYear(date: string | Date | number, settings?: IDateSettings): string;
+export declare function dateToYear(date: IDate, settings?: IDateSettings): string;

package/dist/cjs/dates/adapters/dateToYear.js

@@ -7,8 +7,9 @@ const isValidDateObject_1 = require("../helpers/isValidDateObject");
 const isValidPotentialDate_1 = require("../helpers/isValidPotentialDate");
 /**
  * Transform a Date to [Year] date format.
- * @param {string | Date | number} date String, object or millisencond number of the date
- * @returns string of [Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Year] date format
  */
 function dateToYear(date, settings) {
     if (!(0, isValidPotentialDate_1.isValidPotentialDate)(date))

package/dist/cjs/dates/adapters/hmsToDate.d.ts

@@ -1,8 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transforms String time from a [H:m:s] format to Date object.
- * @param monthYearDate String of [H:m:s] time
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected time, the function will return the same value
+ * @param {string} monthYearDate String of [H:m:s] time
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected time, the function will return the same value
  */
-export declare function hmsToDate(hmsDate: string, settings?: IDateSettings): string | Date | number;
+export declare function hmsToDate(hmsDate: string, settings?: IDateSettings): IDate;

package/dist/cjs/dates/adapters/hmsToDate.js

@@ -9,9 +9,9 @@ const getDefaultDateSettings_1 = require("../helpers/getDefaultDateSettings");
 const validateDate_1 = require("../helpers/validateDate");
 /**
  * Transforms String time from a [H:m:s] format to Date object.
- * @param monthYearDate String of [H:m:s] time
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected time, the function will return the same value
+ * @param {string} monthYearDate String of [H:m:s] time
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected time, the function will return the same value
  */
 function hmsToDate(hmsDate, settings) {
     if ((0, isEmpty_1.isEmpty)(hmsDate) ||

package/dist/cjs/dates/adapters/mdyDateToDate.d.ts

@@ -1,8 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transforms String Date from a [mm/dd/yyyy] format to Date object.
- * @param monthYearDate String of [mm/dd/yyyy] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value
+ * @param {string}monthYearDate String of [mm/dd/yyyy] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value
  */
-export declare function mdyDateToDate(date: string, settings?: IDateSettings): string | Date | number;
+export declare function mdyDateToDate(date: string, settings?: IDateSettings): IDate;

package/dist/cjs/dates/adapters/mdyDateToDate.js

@@ -9,9 +9,9 @@ const getDefaultDateSettings_1 = require("../helpers/getDefaultDateSettings");
 const validateDate_1 = require("../helpers/validateDate");
 /**
  * Transforms String Date from a [mm/dd/yyyy] format to Date object.
- * @param monthYearDate String of [mm/dd/yyyy] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value
+ * @param {string}monthYearDate String of [mm/dd/yyyy] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value
  */
 function mdyDateToDate(date, settings) {
     if ((0, isEmpty_1.isEmpty)(date) ||

package/dist/cjs/dates/adapters/monthYearToDate.d.ts

@@ -1,8 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transforms String Date from a [Month Year] format to Date object.
- * @param monthYearDate String of [Month Year] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value
+ * @param {string} monthYearDate String of [Month Year] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value
  */
-export declare function monthYearToDate(monthYearDate: string, settings?: IDateSettings): string | Date | number;
+export declare function monthYearToDate(monthYearDate: string, settings?: IDateSettings): IDate;

package/dist/cjs/dates/adapters/monthYearToDate.js

@@ -10,9 +10,9 @@ const getDefaultDateSettings_1 = require("../helpers/getDefaultDateSettings");
 const validateDate_1 = require("../helpers/validateDate");
 /**
  * Transforms String Date from a [Month Year] format to Date object.
- * @param monthYearDate String of [Month Year] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value
+ * @param {string} monthYearDate String of [Month Year] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value
  */
 function monthYearToDate(monthYearDate, settings) {
     if ((0, isEmpty_1.isEmpty)(monthYearDate) ||

package/dist/cjs/dates/adapters/numericOffsetToISO.d.ts

@@ -1,6 +1,6 @@
 /**
  * Gets the ISO offset From the numeric offset (minutes)
- * @param {number} offset the timezone offset
+ * @param {number | string} offset the timezone offset
  * @returns {string} the offset in minutes
  */
 export declare function numericOffsetToISO(offset: number | string, leadZeros?: boolean): string;

package/dist/cjs/dates/adapters/numericOffsetToISO.js

@@ -8,7 +8,7 @@ const isValidISOOffset_1 = require("../helpers/isValidISOOffset");
 const ISOToNumericOffset_1 = require("./ISOToNumericOffset");
 /**
  * Gets the ISO offset From the numeric offset (minutes)
- * @param {number} offset the timezone offset
+ * @param {number | string} offset the timezone offset
  * @returns {string} the offset in minutes
  */
 function numericOffsetToISO(offset, leadZeros = true) {
@@ -17,8 +17,6 @@ function numericOffsetToISO(offset, leadZeros = true) {
     if (typeof newOffset === "string" && newOffset === "browser")
         newOffset = -1 * new Date().getTimezoneOffset();
     if (typeof newOffset === "string" && (0, isValidISOOffset_1.isValidISOOffset)(newOffset)) {
-        if (leadZeros)
-            return String(newOffset);
         newOffset = (0, ISOToNumericOffset_1.ISOToNumericOffset)(newOffset);
     }
     if (typeof newOffset !== "number" && (0, isNaNV2_1.isNaNV2)(newOffset))

package/dist/cjs/dates/adapters/quarterYearToDate.d.ts

@@ -1,8 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transforms String Date from a [Quarter Year] format to Date object.
- * @param quarterYearDate String of [Quarter Year] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
+ * @param {string} quarterYearDate String of [Quarter Year] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
  */
-export declare function quarterYearToDate(quarterYearDate: string, settings?: IDateSettings): string | Date | number;
+export declare function quarterYearToDate(quarterYearDate: string, settings?: IDateSettings): IDate;

package/dist/cjs/dates/adapters/quarterYearToDate.js

@@ -10,9 +10,9 @@ const getDefaultDateSettings_1 = require("../helpers/getDefaultDateSettings");
 const validateDate_1 = require("../helpers/validateDate");
 /**
  * Transforms String Date from a [Quarter Year] format to Date object.
- * @param quarterYearDate String of [Quarter Year] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
+ * @param {string} quarterYearDate String of [Quarter Year] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
  */
 function quarterYearToDate(quarterYearDate, settings) {
     if ((0, isEmpty_1.isEmpty)(quarterYearDate) ||

package/dist/cjs/dates/adapters/weekYearToDate.d.ts

@@ -1,8 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transforms String Date from a [Week Year] format to Date object.
- * @param date String of [Week Year] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
+ * @param {string} date String of [Week Year] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
  */
-export declare function weekYearToDate(weekYear: string, settings?: IDateSettings): string | Date | number;
+export declare function weekYearToDate(weekYear: string, settings?: IDateSettings): IDate;

package/dist/cjs/dates/adapters/weekYearToDate.js

@@ -10,9 +10,9 @@ const getWeek_1 = require("../helpers/getWeek");
 const validateDate_1 = require("../helpers/validateDate");
 /**
  * Transforms String Date from a [Week Year] format to Date object.
- * @param date String of [Week Year] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
+ * @param {string} date String of [Week Year] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
  */
 function weekYearToDate(weekYear, settings) {
     if ((0, isEmpty_1.isEmpty)(weekYear) ||

package/dist/cjs/dates/adapters/yearToDate.d.ts

@@ -1,8 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transforms String Date from a [Year] format to Date object.
- * @param yearDate String of [Year] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
+ * @param {string} yearDate String of [Year] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
  */
-export declare function yearToDate(yearDate: string, settings?: IDateSettings): string | Date | number;
+export declare function yearToDate(yearDate: string, settings?: IDateSettings): IDate;

package/dist/cjs/dates/adapters/yearToDate.js

@@ -9,9 +9,9 @@ const getDefaultDateSettings_1 = require("../helpers/getDefaultDateSettings");
 const validateDate_1 = require("../helpers/validateDate");
 /**
  * Transforms String Date from a [Year] format to Date object.
- * @param yearDate String of [Year] date
- * @param time Flag to parse the object date to milliseconds.
- * @returns The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
+ * @param {string} yearDate String of [Year] date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.
  */
 function yearToDate(yearDate, settings) {
     if ((0, isEmpty_1.isEmpty)(yearDate) ||

package/dist/cjs/dates/constants/ISO_8601_REGEX.d.ts

@@ -1 +1,12 @@
+/**
+ * @example -12:00
+ * @example -01:00
+ * @example 00:00
+ * @example +00:00
+ * @example -00:00
+ * @example +05:00
+ * @example +12:00
+ * @example +13:59
+ * @example +14:00
+ */
 export declare const ISO_8601_REGEX: RegExp;

package/dist/cjs/dates/constants/ISO_8601_REGEX.js

@@ -1,4 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ISO_8601_REGEX = void 0;
-exports.ISO_8601_REGEX = /^[+-]?\d{2}:\d{2}$/;
+/**
+ * @example -12:00
+ * @example -01:00
+ * @example 00:00
+ * @example +00:00
+ * @example -00:00
+ * @example +05:00
+ * @example +12:00
+ * @example +13:59
+ * @example +14:00
+ */
+exports.ISO_8601_REGEX = /^(-(0[0-9]|1[0-2]):[0-5][0-9]|[+]?(0[0-9]|1[0-3]):[0-5][0-9]|\+14:00)?$/;

package/dist/cjs/dates/helpers/areIncludedDateTokens.d.ts

@@ -2,8 +2,8 @@ import { IDateFormat } from "../interfaces/IDateFormat";
 /**
  * Determines if the given date has tokens. The date is splitted depending on date format.
  * Undefined date is returning false.
- * @param date The string of the date. It may contain tokens.
- * @param format The date format
- * @returns true: include tokens; false: otherwise
+ * @param {string }date The string of the date. It may contain tokens.
+ * @param {IDateFormat} format The date format
+ * @returns {boolean} true: include tokens; false: otherwise
  */
 export declare function areIncludedDateTokens(date: string, format?: IDateFormat): boolean;

package/dist/cjs/dates/helpers/areIncludedDateTokens.js

@@ -8,9 +8,9 @@ const getSeparatorByDateFormat_1 = require("./getSeparatorByDateFormat");
 /**
  * Determines if the given date has tokens. The date is splitted depending on date format.
  * Undefined date is returning false.
- * @param date The string of the date. It may contain tokens.
- * @param format The date format
- * @returns true: include tokens; false: otherwise
+ * @param {string }date The string of the date. It may contain tokens.
+ * @param {IDateFormat} format The date format
+ * @returns {boolean} true: include tokens; false: otherwise
  */
 function areIncludedDateTokens(date, format = DATE_FORMAT_1.DATE_FORMAT.DAY) {
     let hasTokens = false;

package/dist/cjs/dates/helpers/getDateByDateFormat.d.ts

@@ -1,10 +1,11 @@
 import { IDateFormat } from "../interfaces/IDateFormat";
 import { IDateSettings } from "../interfaces/IDateSettings";
+import { IDate } from "../interfaces/IDate";
 /**
  * Gets a Date Object instance by a Date format
- * @param date String with a formatted date
- * @param format The date format
- * @param time flag to convert the formatted date to miliseconds
- * @returns a Date object, milisecond time or the same value if date format does not match.
+ * @param {string} date String with a formatted date
+ * @param {IDateFormat} format The date format
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} a Date object, milisecond time or the same value if date format does not match.
  */
-export declare function getDateByDateFormat(date: string, format: IDateFormat, settings?: IDateSettings): string | Date | number;
+export declare function getDateByDateFormat(date: string, format: IDateFormat, settings?: IDateSettings): IDate;

package/dist/cjs/dates/helpers/getDateByDateFormat.js

@@ -9,10 +9,10 @@ const weekYearToDate_1 = require("../adapters/weekYearToDate");
 const mdyDateToDate_1 = require("../adapters/mdyDateToDate");
 /**
  * Gets a Date Object instance by a Date format
- * @param date String with a formatted date
- * @param format The date format
- * @param time flag to convert the formatted date to miliseconds
- * @returns a Date object, milisecond time or the same value if date format does not match.
+ * @param {string} date String with a formatted date
+ * @param {IDateFormat} format The date format
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} a Date object, milisecond time or the same value if date format does not match.
  */
 function getDateByDateFormat(date, format, settings) {
     switch (format) {

package/dist/cjs/dates/helpers/getDateByTimezone.d.ts

@@ -1,8 +1,9 @@
 import { IDTimezone } from "../interfaces/IDTimezone";
+import { IDate } from "../interfaces/IDate";
 /**
  * Gets a date value in the given timezone
- * @param {string} date the date
+ * @param {IDate} date the date
  * @param {IDTimezone} timezone the timezone object
- * @returns {string} A transformed value
+ * @returns {IDate} A transformed value
  */
-export declare function getDateByTimezone(date: string | number | Date, timezone: IDTimezone): string | number | Date;
+export declare function getDateByTimezone(date: IDate, timezone: IDTimezone): IDate;

package/dist/cjs/dates/helpers/getDateByTimezone.js

@@ -9,9 +9,9 @@ const isValidPotentialDate_1 = require("./isValidPotentialDate");
 const validateDate_1 = require("./validateDate");
 /**
  * Gets a date value in the given timezone
- * @param {string} date the date
+ * @param {IDate} date the date
  * @param {IDTimezone} timezone the timezone object
- * @returns {string} A transformed value
+ * @returns {IDate} A transformed value
  */
 function getDateByTimezone(date, timezone) {
     const defaultTimezone = (0, getTimezoneObject_1.getTimezoneObject)(timezone);

package/dist/cjs/dates/helpers/getDateByTimezoneOffset.d.ts

@@ -1,7 +1,10 @@
+import { IDTimezoneOffset } from "../interfaces/IDTimezoneOffset";
+import { IDate } from "../interfaces/IDate";
 /**
  * Gets a Date with the given offset of the Timezone.
  * No given an offset the default is going to be set by the browser
- * @param date String, object or millisencond number of the date
- * @returns updated Date object
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDTimezoneOffset} offset the timezone offset
+ * @returns {IDate} the updated Date object
  */
-export declare function getDateByTimezoneOffset(date: string | Date | number, offset?: number | string): string | Date | number;
+export declare function getDateByTimezoneOffset(date: IDate, offset?: IDTimezoneOffset): IDate;

package/dist/cjs/dates/helpers/getDateByTimezoneOffset.js

@@ -12,8 +12,9 @@ const validateDate_1 = require("./validateDate");
 /**
  * Gets a Date with the given offset of the Timezone.
  * No given an offset the default is going to be set by the browser
- * @param date String, object or millisencond number of the date
- * @returns updated Date object
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDTimezoneOffset} offset the timezone offset
+ * @returns {IDate} the updated Date object
  */
 function getDateByTimezoneOffset(date, offset) {
     if (!(0, isValidPotentialDate_1.isValidPotentialDate)(date) ||

package/dist/cjs/dates/helpers/getDateFormatByProperty.d.ts

@@ -2,7 +2,7 @@ import { IColumnPropertyType } from "../../columns/interfaces/IColumnPropertyTyp
 import { IDateFormat } from "../interfaces/IDateFormat";
 /**
  * Gets the date format by the given property
- * @param property The Column Property
- * @returns The date format
+ * @param {IColumnPropertyType} property The Column Property
+ * @returns {IDateFormat} The date format
  */
 export declare function getDateFormatByProperty(property: IColumnPropertyType): IDateFormat;

package/dist/cjs/dates/helpers/getDateFormatByProperty.js

@@ -4,8 +4,8 @@ exports.getDateFormatByProperty = void 0;
 const DATE_FORMAT_BY_PROPERTY_1 = require("../constants/DATE_FORMAT_BY_PROPERTY");
 /**
  * Gets the date format by the given property
- * @param property The Column Property
- * @returns The date format
+ * @param {IColumnPropertyType} property The Column Property
+ * @returns {IDateFormat} The date format
  */
 function getDateFormatByProperty(property) {
     return DATE_FORMAT_BY_PROPERTY_1.DATE_FORMAT_BY_PROPERTY[property];