@syncfusion/ej2-base 19.2.55 → 19.3.47

package/src/internationalization.js

@@ -15,16 +15,19 @@ export var onIntlChange = new Observer();
 export var rightToLeft = false;
 /**
  * Specifies the CLDR data loaded for internationalization functionalities.
+ *
  * @private
  */
 export var cldrData = {};
 /**
  * Specifies the default culture value to be considered.
+ *
  * @private
  */
 export var defaultCulture = 'en-US';
 /**
  * Specifies default currency code to be considered
+ *
  * @private
  */
 export var defaultCurrencyCode = 'USD';
@@ -72,16 +75,18 @@ var Internationalization = /** @class */ (function () {
     }
     /**
      * Returns the format function for given options.
+     *
      * @param {DateFormatOptions} options - Specifies the format options in which the format function will return.
-     * @returns {Function}
+     * @returns {Function} ?
      */
     Internationalization.prototype.getDateFormat = function (options) {
         return DateFormat.dateFormat(this.getCulture(), options || { type: 'date', skeleton: 'short' }, cldrData);
     };
     /**
      * Returns the format function for given options.
+     *
      * @param {NumberFormatOptions} options - Specifies the format options in which the format function will return.
-     * @returns {Function}
+     * @returns {Function} ?
      */
     Internationalization.prototype.getNumberFormat = function (options) {
         if (options && !options.currency) {
@@ -94,16 +99,18 @@ var Internationalization = /** @class */ (function () {
     };
     /**
      * Returns the parser function for given options.
+     *
      * @param {DateFormatOptions} options - Specifies the format options in which the parser function will return.
-     * @returns {Function}
+     * @returns {Function} ?
      */
     Internationalization.prototype.getDateParser = function (options) {
         return DateParser.dateParser(this.getCulture(), options || { skeleton: 'short', type: 'date' }, cldrData);
     };
     /**
      * Returns the parser function for given options.
+     *
      * @param {NumberFormatOptions} options - Specifies the format options in which the parser function will return.
-     * @returns {Function}
+     * @returns {Function} ?
      */
     Internationalization.prototype.getNumberParser = function (options) {
         if (isBlazor() && options && !options.format) {
@@ -113,45 +120,50 @@ var Internationalization = /** @class */ (function () {
     };
     /**
      * Returns the formatted string based on format options.
-     * @param {Number} value - Specifies the number to format.
+     *
+     * @param {number} value - Specifies the number to format.
      * @param {NumberFormatOptions} option - Specifies the format options in which the number will be formatted.
-     * @returns {string}
+     * @returns {string} ?
      */
     Internationalization.prototype.formatNumber = function (value, option) {
         return this.getNumberFormat(option)(value);
     };
     /**
      * Returns the formatted date string based on format options.
-     * @param {Number} value - Specifies the number to format.
+     *
+     * @param {Date} value - Specifies the number to format.
      * @param {DateFormatOptions} option - Specifies the format options in which the number will be formatted.
-     * @returns {string}
+     * @returns {string} ?
      */
     Internationalization.prototype.formatDate = function (value, option) {
         return this.getDateFormat(option)(value);
     };
     /**
      * Returns the date object for given date string and options.
+     *
      * @param {string} value - Specifies the string to parse.
      * @param {DateFormatOptions} option - Specifies the parse options in which the date string will be parsed.
-     * @returns {Date}
+     * @returns {Date} ?
      */
     Internationalization.prototype.parseDate = function (value, option) {
         return this.getDateParser(option)(value);
     };
     /**
      * Returns the number object from the given string value and options.
+     *
      * @param {string} value - Specifies the string to parse.
      * @param {NumberFormatOptions} option - Specifies the parse options in which the  string number  will be parsed.
-     * @returns {number}
+     * @returns {number} ?
      */
     Internationalization.prototype.parseNumber = function (value, option) {
         return this.getNumberParser(option)(value);
     };
     /**
      * Returns Native Date Time Pattern
+     *
      * @param {DateFormatOptions} option - Specifies the parse options for resultant date time pattern.
      * @param {boolean} isExcelFormat - Specifies format value to be converted to excel pattern.
-     * @returns {string}
+     * @returns {string} ?
      * @private
      */
     Internationalization.prototype.getDatePattern = function (option, isExcelFormat) {
@@ -159,8 +171,10 @@ var Internationalization = /** @class */ (function () {
     };
     /**
      * Returns Native Number Pattern
+     *
      * @param {NumberFormatOptions} option - Specifies the parse options for resultant number pattern.
-     * @returns {string}
+     * @param {boolean} isExcel ?
+     * @returns {string} ?
      * @private
      */
     Internationalization.prototype.getNumberPattern = function (option, isExcel) {
@@ -168,11 +182,17 @@ var Internationalization = /** @class */ (function () {
     };
     /**
      * Returns the First Day of the Week
-     * @returns {number}
+     *
+     * @returns {number} ?
      */
     Internationalization.prototype.getFirstDayOfWeek = function () {
         return IntlBase.getWeekData(this.getCulture(), cldrData);
     };
+    /**
+     * Returns the culture
+     *
+     * @returns {string} ?
+     */
     Internationalization.prototype.getCulture = function () {
         return this.culture || defaultCulture;
     };
@@ -181,7 +201,9 @@ var Internationalization = /** @class */ (function () {
 export { Internationalization };
 /**
  * Set the default culture to all EJ2 components
+ *
  * @param {string} cultureName - Specifies the culture name to be set as default culture.
+ * @returns {void} ?
  */
 export function setCulture(cultureName) {
     defaultCulture = cultureName;
@@ -189,8 +211,9 @@ export function setCulture(cultureName) {
 }
 /**
  * Set the default currency code to all EJ2 components
+ *
  * @param {string} currencyCode Specifies the culture name to be set as default culture.
- * @returns {void}
+ * @returns {void} ?
  */
 export function setCurrencyCode(currencyCode) {
     defaultCurrencyCode = currencyCode;
@@ -198,8 +221,9 @@ export function setCurrencyCode(currencyCode) {
 }
 /**
  * Load the CLDR data into context
- * @param {Object[]} obj Specifies the CLDR data's to be used for formatting and parser.
- * @returns {void}
+ *
+ * @param {Object[]} data Specifies the CLDR data's to be used for formatting and parser.
+ * @returns {void} ?
  */
 export function loadCldr() {
     var data = [];
@@ -213,8 +237,9 @@ export function loadCldr() {
 }
 /**
  * To enable or disable RTL functionality for all components globally.
+ *
  * @param {boolean} status - Optional argument Specifies the status value to enable or disable rtl option.
- * @returns {void}
+ * @returns {void} ?
  */
 export function enableRtl(status) {
     if (status === void 0) { status = true; }
@@ -223,13 +248,17 @@ export function enableRtl(status) {
 }
 /**
  * To get the numeric CLDR object for given culture
+ *
  * @param {string} locale - Specifies the locale for which numericObject to be returned.
+ * @param {string} type ?
+ * @returns {Object} ?
  * @ignore
  * @private
  */
 export function getNumericObject(locale, type) {
-    /* tslint:disable no-any */
+    // eslint-disable-next-line
     var numObject = IntlBase.getDependables(cldrData, locale, '', true)[mapper[0]];
+    // eslint-disable-next-line
     var dateObject = IntlBase.getDependables(cldrData, locale, '')[mapper[1]];
     var numSystem = getValue('defaultNumberingSystem', numObject);
     var symbPattern = isBlazor() ? getValue('numberSymbols', numObject) : getValue('symbols-numberSystem-' + numSystem, numObject);
@@ -238,20 +267,28 @@ export function getNumericObject(locale, type) {
 }
 /**
  * To get the numeric CLDR  number base object for given culture
+ *
  * @param {string} locale - Specifies the locale for which numericObject to be returned.
  * @param {string} currency - Specifies the currency for which numericObject to be returned.
+ * @returns {string} ?
  * @ignore
  * @private
  */
 export function getNumberDependable(locale, currency) {
+    // eslint-disable-next-line
     var numObject = IntlBase.getDependables(cldrData, locale, '', true);
+    // eslint-disable-next-line
     return IntlBase.getCurrencySymbol(numObject.numericObject, currency);
 }
 /**
  * To get the default date CLDR object.
+ *
+ * @param {string} mode ?
+ * @returns {Object} ?
  * @ignore
  * @private
  */
 export function getDefaultDateObject(mode) {
+    // eslint-disable-next-line
     return IntlBase.getDependables(cldrData, '', mode, false)[mapper[1]];
 }

package/src/intl/date-formatter.d.ts

@@ -4,6 +4,7 @@ import { IntlBase as base } from './intl-base';
 export declare const basicPatterns: string[];
 /**
  * Interface for Date Format Options Modules.
+ *
  * @private
  */
 export interface FormatOptions {
@@ -24,32 +25,42 @@ export declare const datePartMatcher: {
 };
 /**
  * Date Format is a framework provides support for date formatting.
+ *
  * @private
  */
 export declare class DateFormat {
     /**
      * Returns the formatter function for given skeleton.
-     * @param {string} -  Specifies the culture name to be which formatting.
-     * @param {DateFormatOptions} - Specific the format in which date  will format.
-     * @param {cldr} - Specifies the global cldr data collection.
-     * @return Function.
+     *
+     * @param {string} culture -  Specifies the culture name to be which formatting.
+     * @param {DateFormatOptions} option - Specific the format in which date  will format.
+     * @param {Object} cldr - Specifies the global cldr data collection.
+     * @returns {Function} ?
      */
     static dateFormat(culture: string, option: DateFormatOptions, cldr: Object): Function;
     /**
      * Returns formatted date string based on options passed.
-     * @param {Date} value
-     * @param {FormatOptions} options
+     *
+     * @param {Date} value ?
+     * @param {FormatOptions} options ?
+     * @returns {string} ?
      */
     private static intDateFormatter;
     private static getCurrentDateValue;
     /**
      * Returns two digit numbers for given value and length
+     *
+     * @param {number} val ?
+     * @param {number} len ?
+     * @returns {string} ?
      */
     private static checkTwodigitNumber;
     /**
      * Returns the value of the Time Zone.
-     * @param {number} tVal
-     * @param {string} pattern
+     *
+     * @param {number} tVal ?
+     * @param {string} pattern ?
+     * @returns {string} ?
      * @private
      */
     static getTimeZoneValue(tVal: number, pattern: string): string;

package/src/intl/date-formatter.js

@@ -36,6 +36,7 @@ var timeSeparator = 'timeSeparator';
 /* tslint:disable no-any */
 /**
  * Date Format is a framework provides support for date formatting.
+ *
  * @private
  */
 var DateFormat = /** @class */ (function () {
@@ -43,10 +44,11 @@ var DateFormat = /** @class */ (function () {
     }
     /**
      * Returns the formatter function for given skeleton.
-     * @param {string} -  Specifies the culture name to be which formatting.
-     * @param {DateFormatOptions} - Specific the format in which date  will format.
-     * @param {cldr} - Specifies the global cldr data collection.
-     * @return Function.
+     *
+     * @param {string} culture -  Specifies the culture name to be which formatting.
+     * @param {DateFormatOptions} option - Specific the format in which date  will format.
+     * @param {Object} cldr - Specifies the global cldr data collection.
+     * @returns {Function} ?
      */
     DateFormat.dateFormat = function (culture, option, cldr) {
         var _this = this;
@@ -79,24 +81,26 @@ var DateFormat = /** @class */ (function () {
                 if (char === 'K') {
                     char = 'h';
                 }
-                /* tslint:disable no-any */
-                var charKey = datePartMatcher[char];
                 switch (char) {
                     case 'E':
                     case 'c':
                         if (isBlazor()) {
+                            // eslint-disable-next-line
                             formatOptions.weekday = getValue('days.' + base.monthIndex[len], dateObject);
                         }
                         else {
+                            // eslint-disable-next-line
                             formatOptions.weekday = dependable.dateObject[base.days][standalone][base.monthIndex[len]];
                         }
                         break;
                     case 'M':
                     case 'L':
                         if (isBlazor()) {
+                            // eslint-disable-next-line
                             formatOptions.month = getValue('months.' + base.monthIndex[len], dateObject);
                         }
                         else {
+                            // eslint-disable-next-line
                             formatOptions.month = dependable.dateObject[base.month][standalone][base.monthIndex[len]];
                         }
                         break;
@@ -105,6 +109,7 @@ var DateFormat = /** @class */ (function () {
                             getValue('dayPeriods', dateObject) : getValue('dayPeriods.format.wide', dateObject);
                         break;
                     case 'G':
+                        // eslint-disable-next-line
                         var eText = (len <= 3) ? 'eraAbbr' : (len === 4) ? 'eraNames' : 'eraNarrow';
                         formatOptions.era = isBlazor() ? getValue('eras', dateObject) : getValue('eras.' + eText, dependable.dateObject);
                         break;
@@ -123,10 +128,11 @@ var DateFormat = /** @class */ (function () {
     };
     /**
      * Returns formatted date string based on options passed.
-     * @param {Date} value
-     * @param {FormatOptions} options
+     *
+     * @param {Date} value ?
+     * @param {FormatOptions} options ?
+     * @returns {string} ?
      */
-    // tslint:disable-next-line:max-func-body-length
     DateFormat.intDateFormatter = function (value, options) {
         var pattern = options.pattern;
         var ret = '';
@@ -149,6 +155,7 @@ var DateFormat = /** @class */ (function () {
                 case 'L':
                     curval = dObject.month;
                     if (length_1 > 2) {
+                        // eslint-disable-next-line
                         ret += options.month[curval];
                     }
                     else {
@@ -157,6 +164,7 @@ var DateFormat = /** @class */ (function () {
                     break;
                 case 'E':
                 case 'c':
+                    // eslint-disable-next-line
                     ret += options.weekday[weekdayKey[value.getDay()]];
                     break;
                 case 'H':
@@ -172,6 +180,7 @@ var DateFormat = /** @class */ (function () {
                     else if (char === 'f') {
                         isNumber = false;
                         processNumber = true;
+                        // eslint-disable-next-line
                         curvalstr = value[timeSetter[char]]().toString();
                         curvalstr = curvalstr.substring(0, length_1);
                         var curlength = curvalstr.length;
@@ -186,6 +195,7 @@ var DateFormat = /** @class */ (function () {
                         curstr += curvalstr;
                     }
                     else {
+                        // eslint-disable-next-line
                         curval = value[timeSetter[char]]();
                     }
                     if (char === 'h') {
@@ -200,22 +210,29 @@ var DateFormat = /** @class */ (function () {
                     }
                     break;
                 case 'a':
+                    // eslint-disable-next-line
                     var desig = value.getHours() < 12 ? 'am' : 'pm';
+                    // eslint-disable-next-line
                     ret += options.designator[desig];
                     break;
                 case 'G':
+                    // eslint-disable-next-line
                     var dec = value.getFullYear() < 0 ? 0 : 1;
+                    // eslint-disable-next-line
                     var retu = options.era[dec];
                     if (isNullOrUndefined(retu)) {
+                        // eslint-disable-next-line
                         retu = options.era[dec ? 0 : 1];
                     }
                     ret += retu || '';
                     break;
                 case '\'':
-                    ret += (match === '\'\'') ? '\'' : match.replace(/\'/g, '');
+                    ret += (match === '\'\'') ? '\'' : match.replace(/'/g, '');
                     break;
                 case 'z':
+                    // eslint-disable-next-line
                     var timezone = value.getTimezoneOffset();
+                    // eslint-disable-next-line
                     var pattern_1 = (length_1 < 4) ? '+H;-H' : options.timeZone.hourFormat;
                     pattern_1 = pattern_1.replace(/:/g, options.numMapper.timeSeparator);
                     if (timezone === 0) {
@@ -228,8 +245,8 @@ var DateFormat = /** @class */ (function () {
                     curstr = options.timeZone.gmtFormat.replace(/\{0\}/, curstr);
                     break;
                 case ':':
+                    // eslint-disable-next-line
                     ret += options.numMapper.numberSymbols[timeSeparator];
-                    /* tslint:enable no-any */
                     break;
                 case '/':
                     ret += options.dateSeperator;
@@ -259,6 +276,10 @@ var DateFormat = /** @class */ (function () {
     };
     /**
      * Returns two digit numbers for given value and length
+     *
+     * @param {number} val ?
+     * @param {number} len ?
+     * @returns {string} ?
      */
     DateFormat.checkTwodigitNumber = function (val, len) {
         var ret = val + '';
@@ -269,8 +290,10 @@ var DateFormat = /** @class */ (function () {
     };
     /**
      * Returns the value of the Time Zone.
-     * @param {number} tVal
-     * @param {string} pattern
+     *
+     * @param {number} tVal ?
+     * @param {string} pattern ?
+     * @returns {string} ?
      * @private
      */
     DateFormat.getTimeZoneValue = function (tVal, pattern) {

package/src/intl/date-parser.d.ts

@@ -1,54 +1,61 @@
 import { DateFormatOptions } from '../internationalization';
 /**
  * Date Parser.
+ *
  * @private
  */
 export declare class DateParser {
     /**
      * Returns the parser function for given skeleton.
-     * @param {string} -  Specifies the culture name to be which formatting.
-     * @param {DateFormatOptions} - Specific the format in which string date  will be parsed.
-     * @param {cldr} - Specifies the global cldr data collection.
-     *  @return Function.
+     *
+     * @param {string} culture -  Specifies the culture name to be which formatting.
+     * @param {DateFormatOptions} option - Specific the format in which string date  will be parsed.
+     * @param {Object} cldr - Specifies the global cldr data collection.
+     * @returns {Function} ?
      */
     static dateParser(culture: string, option: DateFormatOptions, cldr: Object): Function;
     /**
      * Returns date object for provided date options
-     * @param {DateParts} options
-     * @param {Date} value
-     * @returns {Date}
+     *
+     * @param {DateParts} options ?
+     * @param {Date} value ?
+     * @returns {Date} ?
      */
     private static getDateObject;
     /**
      * Returns date parsing options for provided value along with parse and numeric options
-     * @param {string} value
-     * @param {ParseOptions} parseOptions
-     * @param {NumericOptions} num
-     * @returns {DateParts}
+     *
+     * @param {string} value ?
+     * @param {ParseOptions} parseOptions ?
+     * @param {NumericOptions} num ?
+     * @returns {DateParts} ?
      */
     private static internalDateParse;
     /**
      * Returns parsed number for provided Numeric string and Numeric Options
-     * @param {string} value
-     * @param {NumericOptions} option
-     * @returns {number}
+     *
+     * @param {string} value ?
+     * @param {NumericOptions} option ?
+     * @returns {number} ?
      */
     private static internalNumberParser;
     /**
      * Returns parsed time zone RegExp for provided hour format and time zone
-     * @param {string} hourFormat
-     * @param {base.TimeZoneOptions} tZone
-     * @param {string} nRegex
-     * @returns {string}
+     *
+     * @param {string} hourFormat ?
+     * @param {base.TimeZoneOptions} tZone ?
+     * @param {string} nRegex ?
+     * @returns {string} ?
      */
     private static parseTimeZoneRegx;
     /**
      * Returns zone based value.
-     * @param {boolean} flag
-     * @param {string} val1
-     * @param {string} val2
-     * @param {NumericOptions} num
-     * @returns {number}
+     *
+     * @param {boolean} flag ?
+     * @param {string} val1 ?
+     * @param {string} val2 ?
+     * @param {NumericOptions} num ?
+     * @returns {number} ?
      */
     private static getZoneValue;
 }