@qrvey/utils 1.3.0-0 → 1.3.0-3

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

@@ -0,0 +1,6 @@
+/**
+ * * Transform a Date to [HH:mm:ss] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [HH:mm:ss] date format
+ */
+export declare function dateToHms(date: string | Date | number): any;

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateToHms = void 0;
+const isEmpty_1 = require("../../general/mix/isEmpty");
+const padLeadingZeros_1 = require("../../general/string/padLeadingZeros");
+const isTokenLabel_1 = require("../../tokens/isTokenLabel");
+/**
+ * * Transform a Date to [HH:mm:ss] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [HH:mm:ss] date format
+ */
+function dateToHms(date) {
+    if ((0, isEmpty_1.isEmpty)(date) || (0, isTokenLabel_1.isTokenLabel)(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    return (0, padLeadingZeros_1.padLeadingZeros)(dt.getHours(), 2).slice(-2) + ':' + (0, padLeadingZeros_1.padLeadingZeros)(dt.getMinutes(), 2).slice(-2) + ':' + (0, padLeadingZeros_1.padLeadingZeros)(dt.getSeconds(), 2).slice(-2);
+}
+exports.dateToHms = dateToHms;

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

@@ -0,0 +1,6 @@
+/**
+ * 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
+ */
+export declare function dateToMdyDate(date: string | Date | number, includeTime?: boolean): string;

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateToMdyDate = void 0;
+const isEmpty_1 = require("../../general/mix/isEmpty");
+const padLeadingZeros_1 = require("../../general/string/padLeadingZeros");
+const isTokenLabel_1 = require("../../tokens/isTokenLabel");
+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
+ */
+function dateToMdyDate(date, includeTime) {
+    if ((0, isEmpty_1.isEmpty)(date) || (0, isTokenLabel_1.isTokenLabel)(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    return (0, padLeadingZeros_1.padLeadingZeros)(dt.getMonth() + 1, 2).slice(-2) + '/' + (0, padLeadingZeros_1.padLeadingZeros)(dt.getDate(), 2).slice(-2) + '/' + (0, padLeadingZeros_1.padLeadingZeros)(dt.getFullYear(), 4) + (includeTime ? ' ' + (0, dateToHms_1.dateToHms)(date) : '');
+}
+exports.dateToMdyDate = dateToMdyDate;

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

@@ -0,0 +1,6 @@
+/**
+ * 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
+ */
+export declare function dateToMonthYear(date: string | Date | number): string;

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateToMonthYear = void 0;
+const isEmpty_1 = require("../../general/mix/isEmpty");
+const isTokenLabel_1 = require("../../tokens/isTokenLabel");
+const DATE_YEAR_MONTHS_1 = require("../constants/DATE_YEAR_MONTHS");
+/**
+ * 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
+ */
+function dateToMonthYear(date) {
+    if ((0, isEmpty_1.isEmpty)(date) || (0, isTokenLabel_1.isTokenLabel)(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    return DATE_YEAR_MONTHS_1.DATE_YEAR_MONTHS[dt.getMonth()] + ' ' + dt.getFullYear();
+}
+exports.dateToMonthYear = dateToMonthYear;

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

@@ -0,0 +1,6 @@
+/**
+ * Transform a Date to [Quarter Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Quarter Year] date format
+ */
+export declare function dateToQuarterYear(date: string | Date | number): string;

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateToQuarterYear = void 0;
+const isEmpty_1 = require("../../general/mix/isEmpty");
+const isTokenLabel_1 = require("../../tokens/isTokenLabel");
+const DATE_YEAR_QUARTERS_1 = require("../constants/DATE_YEAR_QUARTERS");
+/**
+ * Transform a Date to [Quarter Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Quarter Year] date format
+ */
+function dateToQuarterYear(date) {
+    if ((0, isEmpty_1.isEmpty)(date) || (0, isTokenLabel_1.isTokenLabel)(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    const quarter = Math.ceil((dt.getMonth() + 1) / 3);
+    return DATE_YEAR_QUARTERS_1.DATE_YEAR_QUARTERS[quarter - 1] + ' ' + dt.getFullYear();
+}
+exports.dateToQuarterYear = dateToQuarterYear;

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

@@ -0,0 +1,6 @@
+/**
+ * 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
+ */
+export declare function dateToWeekYear(date: string | Date | number): string;

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateToWeekYear = void 0;
+const isEmpty_1 = require("../../general/mix/isEmpty");
+const isTokenLabel_1 = require("../../tokens/isTokenLabel");
+const getWeek_1 = require("../helpers/getWeek");
+/**
+ * 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
+ */
+function dateToWeekYear(date) {
+    if ((0, isEmpty_1.isEmpty)(date) || (0, isTokenLabel_1.isTokenLabel)(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    const weekObj = (0, getWeek_1.getWeek)(dt);
+    return `W${weekObj.week} ${weekObj.year}`;
+}
+exports.dateToWeekYear = dateToWeekYear;

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

@@ -0,0 +1,6 @@
+/**
+ * Transform a Date to [Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Year] date format
+ */
+export declare function dateToYear(date: string | Date | number): string;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateToYear = void 0;
+const isEmpty_1 = require("../../general/mix/isEmpty");
+const isTokenLabel_1 = require("../../tokens/isTokenLabel");
+/**
+ * Transform a Date to [Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Year] date format
+ */
+function dateToYear(date) {
+    if ((0, isEmpty_1.isEmpty)(date) || (0, isTokenLabel_1.isTokenLabel)(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    return String(dt.getFullYear());
+}
+exports.dateToYear = dateToYear;

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function mdyDateToDate(date: string, time?: boolean): string | number | Date;
+export declare function mdyDateToDate(date: string, time?: boolean): string | Date | number;

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function monthYearToDate(monthYearDate: string, time?: boolean): string | number | Date;
+export declare function monthYearToDate(monthYearDate: string, time?: boolean): string | Date | number;

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function quarterYearToDate(quarterYearDate: string, time?: boolean): string | number | Date;
+export declare function quarterYearToDate(quarterYearDate: string, time?: boolean): string | Date | number;

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function weekYearToDate(weekYear: string, time?: boolean): string | number | Date;
+export declare function weekYearToDate(weekYear: string, time?: boolean): string | Date | number;

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function yearToDate(yearDate: string, time?: boolean): string | number | Date;
+export declare function yearToDate(yearDate: string, time?: boolean): string | Date | number;

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

@@ -6,4 +6,4 @@ import { IDateFormat } from "../interfaces/IDateFormat";
  * @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.
  */
-export declare function getDateByDateFormat(date: string, format: IDateFormat, time?: boolean): string | number | Date;
+export declare function getDateByDateFormat(date: string, format: IDateFormat, time?: boolean): string | Date | number;

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

@@ -0,0 +1,8 @@
+import { IDateFormat } from "../interfaces/IDateFormat";
+/**
+ * A Date object, string or millisecond number are gotten in order to convert it in an formatted string date
+ * @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
+ */
+export declare function getFormattedDateByFormat(date: string | Date | number, format: IDateFormat): string | Date | number;

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

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFormattedDateByFormat = void 0;
+const dateToMdyDate_1 = require("../adapters/dateToMdyDate");
+const dateToMonthYear_1 = require("../adapters/dateToMonthYear");
+const dateToQuarterYear_1 = require("../adapters/dateToQuarterYear");
+const dateToWeekYear_1 = require("../adapters/dateToWeekYear");
+const dateToYear_1 = require("../adapters/dateToYear");
+const DATE_FORMAT_1 = require("../constants/DATE_FORMAT");
+/**
+ * A Date object, string or millisecond number are gotten in order to convert it in an formatted string date
+ * @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
+ */
+function getFormattedDateByFormat(date, format) {
+    if (format === DATE_FORMAT_1.DATE_FORMAT.QUARTER) {
+        return (0, dateToQuarterYear_1.dateToQuarterYear)(date);
+    }
+    else if (format === DATE_FORMAT_1.DATE_FORMAT.MONTH) {
+        return (0, dateToMonthYear_1.dateToMonthYear)(date);
+    }
+    else if (format === DATE_FORMAT_1.DATE_FORMAT.YEAR) {
+        return (0, dateToYear_1.dateToYear)(date);
+    }
+    else if (format === DATE_FORMAT_1.DATE_FORMAT.WEEK) {
+        return (0, dateToWeekYear_1.dateToWeekYear)(date);
+    }
+    else if (format === DATE_FORMAT_1.DATE_FORMAT.DAY) {
+        return (0, dateToMdyDate_1.dateToMdyDate)(date);
+    }
+    else {
+        return date;
+    }
+}
+exports.getFormattedDateByFormat = getFormattedDateByFormat;

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

@@ -0,0 +1,9 @@
+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
+ */
+export declare function includeDateTokens(date: string, format: IDateFormat): boolean;

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.includeDateTokens = void 0;
+const isEmpty_1 = require("../../general/mix/isEmpty");
+const isTokenLabel_1 = require("../../tokens/isTokenLabel");
+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
+ */
+function includeDateTokens(date, format) {
+    let hasTokens = false;
+    if (!(0, isEmpty_1.isEmpty)(date)) {
+        if ((0, isTokenLabel_1.isTokenLabel)(date))
+            hasTokens = true;
+        else {
+            const separator = (0, getSeparatorByDateFormat_1.getSeparatorByDateFormat)(format);
+            if (separator != null) {
+                const tokens = date.split(separator);
+                hasTokens = tokens.some(token => (0, isTokenLabel_1.isTokenLabel)(token));
+            }
+        }
+    }
+    return hasTokens;
+}
+exports.includeDateTokens = includeDateTokens;

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

@@ -1,6 +1,9 @@
+export * from './getDateByDateFormat';
 export * from './getDateFormatByProperty';
 export * from './getDateFormatRegularExpressionInArray';
+export * from './getFormattedDateByFormat';
 export * from './getSeparatorByDateFormat';
+export * from './includeDateTokens';
 export * from './getWeek';
 export * from './validateDate';
 export * from './validateDateByDateFormat';

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

@@ -14,9 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./getDateByDateFormat"), exports);
 __exportStar(require("./getDateFormatByProperty"), exports);
 __exportStar(require("./getDateFormatRegularExpressionInArray"), exports);
+__exportStar(require("./getFormattedDateByFormat"), exports);
 __exportStar(require("./getSeparatorByDateFormat"), exports);
+__exportStar(require("./includeDateTokens"), exports);
 __exportStar(require("./getWeek"), exports);
 __exportStar(require("./validateDate"), exports);
 __exportStar(require("./validateDateByDateFormat"), exports);

package/dist/cjs/general/string/index.d.ts

@@ -1 +1,3 @@
 export * from './capitalize';
+export * from './padLeadingZeros';
+export * from './parseUrl';

package/dist/cjs/general/string/index.js

@@ -15,3 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./capitalize"), exports);
+__exportStar(require("./padLeadingZeros"), exports);
+__exportStar(require("./parseUrl"), exports);

package/dist/cjs/general/string/padLeadingZeros.d.ts

@@ -0,0 +1 @@
+export declare function padLeadingZeros(num: number | string, size?: number): string;

package/dist/cjs/general/string/padLeadingZeros.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.padLeadingZeros = void 0;
+function padLeadingZeros(num, size = 0) {
+    if (isNaN(Number(num)))
+        return String(num);
+    let s = num + "";
+    while (s.length < size)
+        s = "0" + s;
+    return s;
+}
+exports.padLeadingZeros = padLeadingZeros;

package/dist/cjs/globalization/service/i18nextBuilder.d.ts

@@ -5,6 +5,15 @@ export declare class I18nServiceBuilder {
     private static _initI18n;
     static setTranslations(i18nDefault: any, i18nResource: II18nResource): II18nResource;
 }
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 export declare abstract class I18nService {
+    /**
+      * This method by means of the key searches in the configuration object, replaces the values received by means of the options parameter and returns the translated text. Ex: <b>translate('the_value_is {{number}}',{number: 1});</b>
+      * @param key String used as key
+      * @param options Object of type II18nServiceTranslateOption that contains the dynamic parameters to replace
+      * @returns The translated text Ex: <b>The value is: 1</b>
+      */
     abstract translate(key: string, options?: II18nServiceTranslateOption): string;
 }

package/dist/cjs/globalization/service/i18nextBuilder.js

@@ -47,6 +47,9 @@ class I18nServiceBuilder {
     }
 }
 exports.I18nServiceBuilder = I18nServiceBuilder;
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 class I18nService {
 }
 exports.I18nService = I18nService;

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

@@ -0,0 +1,6 @@
+/**
+ * * Transform a Date to [HH:mm:ss] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [HH:mm:ss] date format
+ */
+export declare function dateToHms(date: string | Date | number): any;

package/dist/dates/adapters/dateToHms.js

@@ -0,0 +1,14 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { padLeadingZeros } from "../../general/string/padLeadingZeros";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+/**
+ * * Transform a Date to [HH:mm:ss] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [HH:mm:ss] date format
+ */
+export function dateToHms(date) {
+    if (isEmpty(date) || isTokenLabel(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    return padLeadingZeros(dt.getHours(), 2).slice(-2) + ':' + padLeadingZeros(dt.getMinutes(), 2).slice(-2) + ':' + padLeadingZeros(dt.getSeconds(), 2).slice(-2);
+}

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

@@ -0,0 +1,6 @@
+/**
+ * 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
+ */
+export declare function dateToMdyDate(date: string | Date | number, includeTime?: boolean): string;

package/dist/dates/adapters/dateToMdyDate.js

@@ -0,0 +1,15 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { padLeadingZeros } from "../../general/string/padLeadingZeros";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+import { dateToHms } from "./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
+ */
+export function dateToMdyDate(date, includeTime) {
+    if (isEmpty(date) || isTokenLabel(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    return padLeadingZeros(dt.getMonth() + 1, 2).slice(-2) + '/' + padLeadingZeros(dt.getDate(), 2).slice(-2) + '/' + padLeadingZeros(dt.getFullYear(), 4) + (includeTime ? ' ' + dateToHms(date) : '');
+}

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

@@ -0,0 +1,6 @@
+/**
+ * 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
+ */
+export declare function dateToMonthYear(date: string | Date | number): string;

package/dist/dates/adapters/dateToMonthYear.js

@@ -0,0 +1,14 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+import { DATE_YEAR_MONTHS } from "../constants/DATE_YEAR_MONTHS";
+/**
+ * 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
+ */
+export function dateToMonthYear(date) {
+    if (isEmpty(date) || isTokenLabel(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    return DATE_YEAR_MONTHS[dt.getMonth()] + ' ' + dt.getFullYear();
+}

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

@@ -0,0 +1,6 @@
+/**
+ * Transform a Date to [Quarter Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Quarter Year] date format
+ */
+export declare function dateToQuarterYear(date: string | Date | number): string;

package/dist/dates/adapters/dateToQuarterYear.js

@@ -0,0 +1,15 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+import { DATE_YEAR_QUARTERS } from "../constants/DATE_YEAR_QUARTERS";
+/**
+ * Transform a Date to [Quarter Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Quarter Year] date format
+ */
+export function dateToQuarterYear(date) {
+    if (isEmpty(date) || isTokenLabel(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    const quarter = Math.ceil((dt.getMonth() + 1) / 3);
+    return DATE_YEAR_QUARTERS[quarter - 1] + ' ' + dt.getFullYear();
+}

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

@@ -0,0 +1,6 @@
+/**
+ * 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
+ */
+export declare function dateToWeekYear(date: string | Date | number): string;

package/dist/dates/adapters/dateToWeekYear.js

@@ -0,0 +1,15 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+import { getWeek } from "../helpers/getWeek";
+/**
+ * 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
+ */
+export function dateToWeekYear(date) {
+    if (isEmpty(date) || isTokenLabel(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    const weekObj = getWeek(dt);
+    return `W${weekObj.week} ${weekObj.year}`;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * Transform a Date to [Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Year] date format
+ */
+export declare function dateToYear(date: string | Date | number): string;

package/dist/dates/adapters/dateToYear.js

@@ -0,0 +1,13 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+/**
+ * Transform a Date to [Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Year] date format
+ */
+export function dateToYear(date) {
+    if (isEmpty(date) || isTokenLabel(date))
+        return date;
+    const dt = new Date(date.valueOf());
+    return String(dt.getFullYear());
+}

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function mdyDateToDate(date: string, time?: boolean): string | number | Date;
+export declare function mdyDateToDate(date: string, time?: boolean): string | Date | number;

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function monthYearToDate(monthYearDate: string, time?: boolean): string | number | Date;
+export declare function monthYearToDate(monthYearDate: string, time?: boolean): string | Date | number;

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function quarterYearToDate(quarterYearDate: string, time?: boolean): string | number | Date;
+export declare function quarterYearToDate(quarterYearDate: string, time?: boolean): string | Date | number;

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function weekYearToDate(weekYear: string, time?: boolean): string | number | Date;
+export declare function weekYearToDate(weekYear: string, time?: boolean): string | Date | number;

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

@@ -4,4 +4,4 @@
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export declare function yearToDate(yearDate: string, time?: boolean): string | number | Date;
+export declare function yearToDate(yearDate: string, time?: boolean): string | Date | number;

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

@@ -6,4 +6,4 @@ import { IDateFormat } from "../interfaces/IDateFormat";
  * @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.
  */
-export declare function getDateByDateFormat(date: string, format: IDateFormat, time?: boolean): string | number | Date;
+export declare function getDateByDateFormat(date: string, format: IDateFormat, time?: boolean): string | Date | number;

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

@@ -0,0 +1,8 @@
+import { IDateFormat } from "../interfaces/IDateFormat";
+/**
+ * A Date object, string or millisecond number are gotten in order to convert it in an formatted string date
+ * @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
+ */
+export declare function getFormattedDateByFormat(date: string | Date | number, format: IDateFormat): string | Date | number;

package/dist/dates/helpers/getFormattedDateByFormat.js

@@ -0,0 +1,32 @@
+import { dateToMdyDate } from "../adapters/dateToMdyDate";
+import { dateToMonthYear } from "../adapters/dateToMonthYear";
+import { dateToQuarterYear } from "../adapters/dateToQuarterYear";
+import { dateToWeekYear } from "../adapters/dateToWeekYear";
+import { dateToYear } from "../adapters/dateToYear";
+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
+ * @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
+ */
+export function getFormattedDateByFormat(date, format) {
+    if (format === DATE_FORMAT.QUARTER) {
+        return dateToQuarterYear(date);
+    }
+    else if (format === DATE_FORMAT.MONTH) {
+        return dateToMonthYear(date);
+    }
+    else if (format === DATE_FORMAT.YEAR) {
+        return dateToYear(date);
+    }
+    else if (format === DATE_FORMAT.WEEK) {
+        return dateToWeekYear(date);
+    }
+    else if (format === DATE_FORMAT.DAY) {
+        return dateToMdyDate(date);
+    }
+    else {
+        return date;
+    }
+}

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

@@ -0,0 +1,9 @@
+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
+ */
+export declare function includeDateTokens(date: string, format: IDateFormat): boolean;

package/dist/dates/helpers/includeDateTokens.js

@@ -0,0 +1,25 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+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
+ */
+export function includeDateTokens(date, format) {
+    let hasTokens = false;
+    if (!isEmpty(date)) {
+        if (isTokenLabel(date))
+            hasTokens = true;
+        else {
+            const separator = getSeparatorByDateFormat(format);
+            if (separator != null) {
+                const tokens = date.split(separator);
+                hasTokens = tokens.some(token => isTokenLabel(token));
+            }
+        }
+    }
+    return hasTokens;
+}

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

@@ -1,6 +1,9 @@
+export * from './getDateByDateFormat';
 export * from './getDateFormatByProperty';
 export * from './getDateFormatRegularExpressionInArray';
+export * from './getFormattedDateByFormat';
 export * from './getSeparatorByDateFormat';
+export * from './includeDateTokens';
 export * from './getWeek';
 export * from './validateDate';
 export * from './validateDateByDateFormat';

package/dist/dates/helpers/index.js

@@ -1,6 +1,9 @@
+export * from './getDateByDateFormat';
 export * from './getDateFormatByProperty';
 export * from './getDateFormatRegularExpressionInArray';
+export * from './getFormattedDateByFormat';
 export * from './getSeparatorByDateFormat';
+export * from './includeDateTokens';
 export * from './getWeek';
 export * from './validateDate';
 export * from './validateDateByDateFormat';

package/dist/general/string/index.d.ts

@@ -1 +1,3 @@
 export * from './capitalize';
+export * from './padLeadingZeros';
+export * from './parseUrl';

package/dist/general/string/index.js

@@ -1 +1,3 @@
 export * from './capitalize';
+export * from './padLeadingZeros';
+export * from './parseUrl';

package/dist/general/string/padLeadingZeros.d.ts

@@ -0,0 +1 @@
+export declare function padLeadingZeros(num: number | string, size?: number): string;

package/dist/general/string/padLeadingZeros.js

@@ -0,0 +1,8 @@
+export function padLeadingZeros(num, size = 0) {
+    if (isNaN(Number(num)))
+        return String(num);
+    let s = num + "";
+    while (s.length < size)
+        s = "0" + s;
+    return s;
+}

package/dist/globalization/service/i18nextBuilder.d.ts

@@ -5,6 +5,15 @@ export declare class I18nServiceBuilder {
     private static _initI18n;
     static setTranslations(i18nDefault: any, i18nResource: II18nResource): II18nResource;
 }
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 export declare abstract class I18nService {
+    /**
+      * This method by means of the key searches in the configuration object, replaces the values received by means of the options parameter and returns the translated text. Ex: <b>translate('the_value_is {{number}}',{number: 1});</b>
+      * @param key String used as key
+      * @param options Object of type II18nServiceTranslateOption that contains the dynamic parameters to replace
+      * @returns The translated text Ex: <b>The value is: 1</b>
+      */
     abstract translate(key: string, options?: II18nServiceTranslateOption): string;
 }

package/dist/globalization/service/i18nextBuilder.js

@@ -40,6 +40,9 @@ export class I18nServiceBuilder {
         return mergeDeep(i18nResource, i18nDefault, { mergeExistingValues: false });
     }
 }
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 export class I18nService {
 }
 class I18nServiceConcrete extends I18nService {

package/package.json

@@ -1,42 +1,39 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.3.0-0",
+  "version": "1.3.0-3",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc && tsc -m commonjs --outDir dist/cjs",
     "build-clean": "node ./scripts/clean-build",
-    "docs": "./node_modules/.bin/jsdoc -c ./jsdoc.config.json",
-    "doxs": "doxdox './dist/**/*.js' --ignore './dist/cjs/**/*.js' --output README.md --layout markdown --package ./package.json",
+    "compodoc": "npx compodoc -p tsconfig.doc.json",
+    "compodoc:server": "./node_modules/.bin/compodoc -p ./tsconfig.doc.json -s --port=4400",
     "lint": "eslint src --quiet --exit-on-fatal-error --ext .ts,.js",
     "lint-dev": "eslint src --debug --ext .ts,.tsx",
     "publishing-old": "node ./scripts/prepare-publish && np",
     "publishing-prerelease-old": "node ./scripts/prepare-publish && np --any-branch --tag=$npm_config_tag",
     "publishing-beta-1": "node ./scripts/publishing --np-new-version=$npm_config_np_new_version --np-any-branch=$npm_config_np_any_branch --np-tag=$npm_config_np_tag",
-    "publishing-beta-2": "node ./scripts/clean-build && node ./scripts/generating-docs && np --any-branch --np-tag=$npm_config_np_tag",
+    "publishing-beta-2": "node ./scripts/clean-build && node ./scripts/generating-docs --np-new-version=$npm_config_np_new_version && np $npm_config_np_new_version --any-branch --tag=$npm_config_np_tag",
     "test": "jest test",
     "test:watch": "jest --watch test"
   },
   "author": "Qrvey Inc",
   "license": "MIT",
   "devDependencies": {
-    "@types/jest": "27.4.1",
-    "@typescript-eslint/eslint-plugin": "5.22.0",
-    "@typescript-eslint/parser": "5.22.0",
-    "doxdox": "3.0.0",
     "eslint": "8.14.0",
     "jest": "27.5.1",
-    "jsdoc": "3.6.10",
     "np": "7.6.1",
     "typedoc": "0.22.15",
-    "typescript": "4.6.4"
+    "typescript": "4.6.4",
+    "@compodoc/compodoc": "1.1.19",
+    "@types/jest": "27.4.1",
+    "@typescript-eslint/eslint-plugin": "5.22.0",
+    "@typescript-eslint/parser": "5.22.0"
   },
   "dependencies": {
     "d3": "6.3.1",
+    "dayjs": "1.11.1",
     "i18next": "21.6.16"
-  },
-  "peerDependencies": {
-    "dayjs": ">=1.11.1 <1.12.0"
   }
 }

package/scripts/generating-docs/index.js

@@ -67,9 +67,9 @@ async function startGeneratingDocs(settings) {
     await pushingChanges(settings);
 }
 
-async function generatingDocument(settings) {
+async function generatingDocument(_settings) {
     console.log('==>>> Generating Document...');
-    await execute(`doxdox './dist/**/*.js' --output ${settings.docsFileName} --ignore './dist/cjs/**/*.js' --package ${settings.packagePath} --layout markdown`);
+    await execute('npm run compodoc');
 }
 
 async function changingVersion(settings) {

package/src/dates/adapters/dateToHms.ts

@@ -0,0 +1,15 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { padLeadingZeros } from "../../general/string/padLeadingZeros";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+
+/**
+ * * Transform a Date to [HH:mm:ss] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [HH:mm:ss] date format
+ */
+ export function dateToHms(date: string | Date | number) {
+    if (isEmpty(date) || isTokenLabel(date as any)) return date as any;
+
+    const dt = new Date(date.valueOf());
+    return padLeadingZeros(dt.getHours(), 2).slice(-2) + ':' + padLeadingZeros(dt.getMinutes(), 2).slice(-2) + ':' + padLeadingZeros(dt.getSeconds(), 2).slice(-2);
+}

package/src/dates/adapters/dateToMdyDate.ts

@@ -0,0 +1,16 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { padLeadingZeros } from "../../general/string/padLeadingZeros";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+import { dateToHms } from "./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
+ */
+ export function dateToMdyDate(date: string | Date | number, includeTime?: boolean): string{
+    if (isEmpty(date) || isTokenLabel(date as any)) return date as any;
+
+    const dt = new Date(date.valueOf());
+    return padLeadingZeros(dt.getMonth() + 1, 2).slice(-2) + '/' + padLeadingZeros(dt.getDate(), 2).slice(-2) + '/' + padLeadingZeros(dt.getFullYear(), 4) + (includeTime ? ' ' + dateToHms(date) : '');
+}

package/src/dates/adapters/dateToMonthYear.ts

@@ -0,0 +1,15 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+import { DATE_YEAR_MONTHS } from "../constants/DATE_YEAR_MONTHS";
+
+/**
+ * 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
+ */
+ export function dateToMonthYear(date: string | Date | number): string {
+    if (isEmpty(date) || isTokenLabel(date as any)) return date as any;
+
+    const dt = new Date(date.valueOf());
+    return DATE_YEAR_MONTHS[dt.getMonth()] + ' ' + dt.getFullYear();
+}

package/src/dates/adapters/dateToQuarterYear.ts

@@ -0,0 +1,16 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+import { DATE_YEAR_QUARTERS } from "../constants/DATE_YEAR_QUARTERS";
+
+/**
+ * Transform a Date to [Quarter Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Quarter Year] date format
+ */
+ export function dateToQuarterYear(date: string | Date | number): string {
+    if (isEmpty(date) || isTokenLabel(date as any)) return date as any;
+
+    const dt = new Date(date.valueOf());
+    const quarter = Math.ceil((dt.getMonth() + 1) / 3);
+    return DATE_YEAR_QUARTERS[quarter - 1] + ' ' + dt.getFullYear();
+}

package/src/dates/adapters/dateToWeekYear.ts

@@ -0,0 +1,16 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+import { getWeek } from "../helpers/getWeek";
+
+/**
+ * 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
+ */
+ export function dateToWeekYear(date: string | Date | number): string {
+    if (isEmpty(date) || isTokenLabel(date as any)) return date as any;
+
+    const dt = new Date(date.valueOf());
+    const weekObj = getWeek(dt);
+    return `W${weekObj.week} ${weekObj.year}`;
+}

package/src/dates/adapters/dateToYear.ts

@@ -0,0 +1,14 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+
+/**
+ * Transform a Date to [Year] date format.
+ * @param date String, object or millisencond number of the date
+ * @returns string of [Year] date format
+ */
+ export function dateToYear(date: string | Date | number): string {
+    if (isEmpty(date) || isTokenLabel(date as any)) return date as any;
+
+    const dt = new Date(date.valueOf());
+    return String(dt.getFullYear());
+}

package/src/dates/adapters/mdyDateToDate.ts

@@ -9,7 +9,7 @@ import { validateDate } from "../helpers/validateDate";
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export function mdyDateToDate (date: string, time = false) {
+export function mdyDateToDate (date: string, time = false): string | Date | number {
     if (isEmpty(date) || isTokenLabel(date)) return date;
    
     if (validateDate(date, DATE_FORMAT.DAY)) {

package/src/dates/adapters/monthYearToDate.ts

@@ -10,7 +10,7 @@ import { validateDate } from "../helpers/validateDate";
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export function monthYearToDate(monthYearDate: string, time = false) {
+export function monthYearToDate(monthYearDate: string, time = false): string | Date | number {
     if (isEmpty(monthYearDate) || isTokenLabel(monthYearDate)) return monthYearDate;
 
     if (validateDate(monthYearDate, DATE_FORMAT.MONTH)) {

package/src/dates/adapters/quarterYearToDate.ts

@@ -10,7 +10,7 @@ import { validateDate } from "../helpers/validateDate";
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export function quarterYearToDate (quarterYearDate: string, time = false) {
+export function quarterYearToDate (quarterYearDate: string, time = false): string | Date | number {
     if (isEmpty(quarterYearDate) || isTokenLabel(quarterYearDate)) return quarterYearDate;
     
     if (validateDate(quarterYearDate, DATE_FORMAT.QUARTER)) {

package/src/dates/adapters/weekYearToDate.ts

@@ -10,7 +10,7 @@ import { validateDate } from "../helpers/validateDate";
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
- export function weekYearToDate(weekYear: string, time = false) {
+ export function weekYearToDate(weekYear: string, time = false): string | Date | number {
     if (isEmpty(weekYear) || isTokenLabel(weekYear)) return weekYear;
 
     if (validateDate(weekYear, DATE_FORMAT.WEEK)) {

package/src/dates/adapters/yearToDate.ts

@@ -10,7 +10,7 @@ import { validateDate } from "../helpers/validateDate";
  * @param time Flag to parse the object date to milliseconds.
  * @returns The date object or the date in milliseconds
  */
-export function yearToDate(yearDate: string, time = false) {
+export function yearToDate(yearDate: string, time = false): string | Date | number {
     if (isEmpty(yearDate) || isTokenLabel(yearDate)) return yearDate;
 
     if (validateDate(yearDate, DATE_FORMAT.YEAR)) {

package/src/dates/helpers/getDateByDateFormat.ts

@@ -13,7 +13,7 @@ import { mdyDateToDate } from "../adapters/mdyDateToDate";
  * @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.
  */
-export function getDateByDateFormat(date: string, format: IDateFormat, time = false) {
+export function getDateByDateFormat(date: string, format: IDateFormat, time = false): string | Date | number {
     switch (format) {
         case DATE_FORMAT.YEAR:
             return yearToDate(date, time);

package/src/dates/helpers/getFormattedDateByFormat.ts

@@ -0,0 +1,29 @@
+import { dateToMdyDate } from "../adapters/dateToMdyDate";
+import { dateToMonthYear } from "../adapters/dateToMonthYear";
+import { dateToQuarterYear } from "../adapters/dateToQuarterYear";
+import { dateToWeekYear } from "../adapters/dateToWeekYear";
+import { dateToYear } from "../adapters/dateToYear";
+import { DATE_FORMAT } from "../constants/DATE_FORMAT";
+import { IDateFormat } from "../interfaces/IDateFormat";
+
+/**
+ * A Date object, string or millisecond number are gotten in order to convert it in an formatted string date
+ * @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
+ */
+ export function getFormattedDateByFormat(date: string | Date | number, format: IDateFormat): string | Date | number {
+    if (format === DATE_FORMAT.QUARTER) {
+      return dateToQuarterYear(date);
+    } else if (format === DATE_FORMAT.MONTH) {
+      return dateToMonthYear(date);
+    } else if (format === DATE_FORMAT.YEAR) {
+      return dateToYear(date);
+    } else if (format === DATE_FORMAT.WEEK) {
+      return dateToWeekYear(date);
+    } else if (format === DATE_FORMAT.DAY) {
+      return dateToMdyDate(date);
+    } else {
+      return date;
+    }
+}

package/src/dates/helpers/includeDateTokens.ts

@@ -0,0 +1,26 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isTokenLabel } from "../../tokens/isTokenLabel";
+import { IDateFormat } from "../interfaces/IDateFormat";
+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
+ */
+export function includeDateTokens(date: string, format: IDateFormat) {
+    let hasTokens = false;
+    if (!isEmpty(date)) {
+        if (isTokenLabel(date)) hasTokens = true;
+        else {
+            const separator = getSeparatorByDateFormat(format);
+            if (separator != null) {
+                const tokens = date.split(separator);
+                hasTokens = tokens.some(token => isTokenLabel(token));
+            }
+        }
+    }
+    return hasTokens;
+}

package/src/dates/helpers/index.ts

@@ -1,6 +1,9 @@
+export * from './getDateByDateFormat';
 export * from './getDateFormatByProperty';
 export * from './getDateFormatRegularExpressionInArray';
+export * from './getFormattedDateByFormat';
 export * from './getSeparatorByDateFormat';
+export * from './includeDateTokens';
 export * from './getWeek';
 export * from './validateDate';
 export * from './validateDateByDateFormat';

package/src/general/string/index.ts

@@ -1 +1,3 @@
-export * from './capitalize';
+export * from './capitalize';
+export * from './padLeadingZeros';
+export * from './parseUrl';

package/src/general/string/padLeadingZeros.ts

@@ -0,0 +1,7 @@
+export function padLeadingZeros(num: number | string, size = 0): string {
+    if (isNaN(Number(num))) return String(num);
+  
+    let s = num + "";
+    while (s.length < size) s = "0" + s;
+    return s;
+}

package/src/globalization/service/i18nextBuilder.ts

@@ -35,7 +35,17 @@ export class I18nServiceBuilder {
   }
 }
 
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 export abstract class I18nService {
+
+  /**
+    * This method by means of the key searches in the configuration object, replaces the values received by means of the options parameter and returns the translated text. Ex: <b>translate('the_value_is {{number}}',{number: 1});</b>
+    * @param key String used as key
+    * @param options Object of type II18nServiceTranslateOption that contains the dynamic parameters to replace
+    * @returns The translated text Ex: <b>The value is: 1</b>
+    */
   abstract translate(key: string, options?: II18nServiceTranslateOption): string;
 }
 

package/tsconfig.doc.json

@@ -0,0 +1,4 @@
+{
+  "include": ["src/**/*.ts"],
+  "exclude": ["test/*.test.ts", "test/**/*.test.js"]
+}