@qrvey/utils 1.11.0-0 → 1.11.0-1

package/dist/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/dates/adapters/dateToMonthYear.js

@@ -5,8 +5,9 @@ import { isValidDateObject } from "../helpers/isValidDateObject";
 import { isValidPotentialDate } from "../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
  */
 export function dateToMonthYear(date, settings) {
     if (!isValidPotentialDate(date))

package/dist/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/dates/adapters/dateToQuarterYear.js

@@ -5,8 +5,9 @@ import { isValidDateObject } from "../helpers/isValidDateObject";
 import { isValidPotentialDate } from "../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
  */
 export function dateToQuarterYear(date, settings) {
     if (!isValidPotentialDate(date))

package/dist/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/dates/adapters/dateToWeekYear.js

@@ -5,8 +5,9 @@ import { isValidDateObject } from "../helpers/isValidDateObject";
 import { isValidPotentialDate } from "../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
  */
 export function dateToWeekYear(date, settings) {
     if (!isValidPotentialDate(date))

package/dist/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/dates/adapters/dateToYear.js

@@ -4,8 +4,9 @@ import { isValidDateObject } from "../helpers/isValidDateObject";
 import { isValidPotentialDate } from "../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
  */
 export function dateToYear(date, settings) {
     if (!isValidPotentialDate(date))

package/dist/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/dates/adapters/hmsToDate.js

@@ -6,9 +6,9 @@ import { getDefaultDateSettings } from "../helpers/getDefaultDateSettings";
 import { validateDate } from "../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
  */
 export function hmsToDate(hmsDate, settings) {
     if (isEmpty(hmsDate) ||

package/dist/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/dates/adapters/mdyDateToDate.js

@@ -6,9 +6,9 @@ import { getDefaultDateSettings } from "../helpers/getDefaultDateSettings";
 import { validateDate } from "../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
  */
 export function mdyDateToDate(date, settings) {
     if (isEmpty(date) ||

package/dist/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/dates/adapters/monthYearToDate.js

@@ -7,9 +7,9 @@ import { getDefaultDateSettings } from "../helpers/getDefaultDateSettings";
 import { validateDate } from "../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
  */
 export function monthYearToDate(monthYearDate, settings) {
     if (isEmpty(monthYearDate) ||

package/dist/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/dates/adapters/numericOffsetToISO.js

@@ -5,7 +5,7 @@ import { isValidISOOffset } from "../helpers/isValidISOOffset";
 import { ISOToNumericOffset } from "./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
  */
 export function numericOffsetToISO(offset, leadZeros = true) {

package/dist/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/dates/adapters/quarterYearToDate.js

@@ -7,9 +7,9 @@ import { getDefaultDateSettings } from "../helpers/getDefaultDateSettings";
 import { validateDate } from "../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.
  */
 export function quarterYearToDate(quarterYearDate, settings) {
     if (isEmpty(quarterYearDate) ||

package/dist/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/dates/adapters/weekYearToDate.js

@@ -7,9 +7,9 @@ import { getWeek } from "../helpers/getWeek";
 import { validateDate } from "../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.
  */
 export function weekYearToDate(weekYear, settings) {
     if (isEmpty(weekYear) ||

package/dist/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/dates/adapters/yearToDate.js

@@ -6,9 +6,9 @@ import { getDefaultDateSettings } from "../helpers/getDefaultDateSettings";
 import { validateDate } from "../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.
  */
 export function yearToDate(yearDate, settings) {
     if (isEmpty(yearDate) ||

package/dist/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/dates/constants/ISO_8601_REGEX.js

@@ -1 +1,12 @@
-export const 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
+ */
+export const 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/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/dates/helpers/areIncludedDateTokens.js

@@ -5,9 +5,9 @@ import { getSeparatorByDateFormat } from "./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
  */
 export function areIncludedDateTokens(date, format = DATE_FORMAT.DAY) {
     let hasTokens = false;

package/dist/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/dates/helpers/getDateByDateFormat.js

@@ -6,10 +6,10 @@ import { weekYearToDate } from "../adapters/weekYearToDate";
 import { mdyDateToDate } from "../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.
  */
 export function getDateByDateFormat(date, format, settings) {
     switch (format) {

package/dist/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/dates/helpers/getDateByTimezone.js

@@ -6,9 +6,9 @@ import { isValidPotentialDate } from "./isValidPotentialDate";
 import { validateDate } from "./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
  */
 export function getDateByTimezone(date, timezone) {
     const defaultTimezone = getTimezoneObject(timezone);

package/dist/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/dates/helpers/getDateByTimezoneOffset.js

@@ -6,8 +6,9 @@ import { validateDate } from "./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
  */
 export function getDateByTimezoneOffset(date, offset) {
     if (!isValidPotentialDate(date) ||

package/dist/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/dates/helpers/getDateFormatByProperty.js

@@ -1,8 +1,8 @@
 import { DATE_FORMAT_BY_PROPERTY } from "../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
  */
 export function getDateFormatByProperty(property) {
     return DATE_FORMAT_BY_PROPERTY[property];

package/dist/dates/helpers/getDateFormatRegularExpressionInArray.d.ts

@@ -3,6 +3,6 @@ import { IDateFormat } from "../interfaces/IDateFormat";
  * Gets an array of regular expressions by the given date format.
  * Day format is the default date format
  * @param {IDateFormat} dateFormat an string of the format
- * @returns an array of regular expressions
+ * @returns {string[]} an array of regular expressions
  */
 export declare function getDateFormatRegularExpressionInArray(dateFormat?: IDateFormat): string[];

package/dist/dates/helpers/getDateFormatRegularExpressionInArray.js

@@ -5,7 +5,7 @@ import { DATE_REGULAR_EXPRESSION_ARRAY_BY_FORMAT } from "../constants/DATE_REGUL
  * Gets an array of regular expressions by the given date format.
  * Day format is the default date format
  * @param {IDateFormat} dateFormat an string of the format
- * @returns an array of regular expressions
+ * @returns {string[]} an array of regular expressions
  */
 export function getDateFormatRegularExpressionInArray(dateFormat = DATE_FORMAT.DAY) {
     const defaultRegularExpression = DATE_REGULAR_EXPRESSION_ARRAY_BY_FORMAT[DATE_FORMAT.DAY];

package/dist/dates/helpers/getDefaultDateSettings.d.ts

@@ -1,7 +1,7 @@
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Gets the default properties for Date Settings object
- * @param settings the date settings
- * @returns a new object with the date settings.
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDateSettings} a new object with the date settings.
  */
 export declare function getDefaultDateSettings(settings: IDateSettings): IDateSettings;

package/dist/dates/helpers/getDefaultDateSettings.js

@@ -1,8 +1,8 @@
 import { getTimezoneObject } from "./getTimezoneObject";
 /**
  * Gets the default properties for Date Settings object
- * @param settings the date settings
- * @returns a new object with the date settings.
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDateSettings} a new object with the date settings.
  */
 export function getDefaultDateSettings(settings) {
     var _a;

package/dist/dates/helpers/getFormattedDateByFormat.d.ts

@@ -1,10 +1,12 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateFormat } from "../interfaces/IDateFormat";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * A Date object, string or millisecond number are gotten in order to convert it in an formatted string date
  * - Some strings are valid
- * @param date String with a formatted date
- * @param format The date format
- * @returns a formmatted date or the same value if format does not match
+ * @param {IDate} date String with a formatted date
+ * @param {IDateFormat} format The date format
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} a formmatted date or the same value if format does not match
  */
-export declare function getFormattedDateByFormat(date: string | Date | number, format: IDateFormat, settings?: IDateSettings): string | Date | number;
+export declare function getFormattedDateByFormat(date: IDate, format: IDateFormat, settings?: IDateSettings): IDate;

package/dist/dates/helpers/getFormattedDateByFormat.js

@@ -7,9 +7,10 @@ import { DATE_FORMAT } from "../constants/DATE_FORMAT";
 /**
  * A Date object, string or millisecond number are gotten in order to convert it in an formatted string date
  * - Some strings are valid
- * @param date String with a formatted date
- * @param format The date format
- * @returns a formmatted date or the same value if format does not match
+ * @param {IDate} date String with a formatted date
+ * @param {IDateFormat} format The date format
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {IDate} a formmatted date or the same value if format does not match
  */
 export function getFormattedDateByFormat(date, format, settings) {
     switch (format) {

package/dist/dates/helpers/getSeparatorByDateFormat.d.ts

@@ -2,6 +2,6 @@ import { IDateFormat } from "../interfaces/IDateFormat";
 /**
  * Gets the separator of the date format
  * @param {IDateFormat} format the date format
- * @returns a separator string
+ * @returns {string} a separator string
  */
 export declare function getSeparatorByDateFormat(format?: IDateFormat): string;

package/dist/dates/helpers/getSeparatorByDateFormat.js

@@ -2,7 +2,7 @@ import { DATE_FORMAT } from "../constants/DATE_FORMAT";
 /**
  * Gets the separator of the date format
  * @param {IDateFormat} format the date format
- * @returns a separator string
+ * @returns {string} a separator string
  */
 export function getSeparatorByDateFormat(format = DATE_FORMAT.DAY) {
     return format === DATE_FORMAT.DAY ? "/" : " ";

package/dist/dates/helpers/getTimezoneObject.d.ts

@@ -6,6 +6,6 @@ import { IDTimezone } from "../interfaces/IDTimezone";
  * - In any case, the offset is prioritized to override other properties.
  * @param {IDTimezone} timezone the timezone object
  * @param {IModel | IDataset} model the info of the dataset (model)
- * @returns a new timezone object
+ * @returns {IDTimezone} a new timezone object
  */
 export declare function getTimezoneObject(timezone: IDTimezone, model?: IModel | IDataset): IDTimezone;

package/dist/dates/helpers/getTimezoneObject.js

@@ -10,7 +10,7 @@ import { isValidTimezoneOffset } from "./isValidTimezoneOffset";
  * - In any case, the offset is prioritized to override other properties.
  * @param {IDTimezone} timezone the timezone object
  * @param {IModel | IDataset} model the info of the dataset (model)
- * @returns a new timezone object
+ * @returns {IDTimezone} a new timezone object
  */
 export function getTimezoneObject(timezone, model) {
     const offset = getOffset(timezone, model);
@@ -64,8 +64,9 @@ function getType(timezone, model, offset) {
     if (!isEmpty(timezone === null || timezone === void 0 ? void 0 : timezone.type)) {
         type = timezone.type;
     }
-    else if (!isEmpty(timezone === null || timezone === void 0 ? void 0 : timezone.offset)) {
-        type = getTypeByOffset(timezone === null || timezone === void 0 ? void 0 : timezone.offset);
+    else if (!isEmpty(timezone === null || timezone === void 0 ? void 0 : timezone.offset) &&
+        isValidTimezoneOffset(timezone.offset)) {
+        type = getTypeByOffset(timezone.offset);
     }
     else if (!isEmpty((_a = model === null || model === void 0 ? void 0 : model.timezone) === null || _a === void 0 ? void 0 : _a.type)) {
         type = model.timezone.type;

package/dist/dates/helpers/getUTCFormatByOffset.d.ts

@@ -2,6 +2,7 @@ import { IDTimezone } from "../interfaces/IDTimezone";
 /**
  * Gets the UTC format dependeing on the given offset
  * @param {IDTimezone} timezone the timezone object
+ * @param {boolean} minified Flag to reduce the Zeros
  * @returns {string} an string with the UTC format
  */
 export declare function getUTCFormatByOffset(timezone: IDTimezone, minified?: boolean): string;