@syncfusion/ej2-base 19.2.57 → 19.3.53

package/src/keyboard-model.d.ts

@@ -8,19 +8,22 @@ export interface KeyboardEventsModel {
 
     /**
      * Specifies key combination and it respective action name.
+     *
      * @default null
      */
     keyConfigs?: { [key: string]: string };
 
     /**
      * Specifies on which event keyboardEvents class should listen for key press. For ex., `keyup`, `keydown` or `keypress`
+     *
      * @default keyup
      */
     eventName?: string;
 
     /**
-     * Specifies the listener when keyboard actions is performed. 
-     * @event
+     * Specifies the listener when keyboard actions is performed.
+     *
+     * @event keyAction
      */
     keyAction?: EmitType<KeyboardEventArgs>;
 

package/src/keyboard.d.ts

@@ -29,6 +29,7 @@ export interface KeyboardEventArgs extends KeyboardEvent {
 export declare class KeyboardEvents extends Base<HTMLElement> implements INotifyPropertyChanged {
     /**
      * Specifies key combination and it respective action name.
+     *
      * @default null
      */
     keyConfigs: {
@@ -36,56 +37,73 @@ export declare class KeyboardEvents extends Base<HTMLElement> implements INotify
     };
     /**
      * Specifies on which event keyboardEvents class should listen for key press. For ex., `keyup`, `keydown` or `keypress`
+     *
      * @default keyup
      */
     eventName: string;
     /**
      * Specifies the listener when keyboard actions is performed.
-     * @event
+     *
+     * @event keyAction
      */
     keyAction: EmitType<KeyboardEventArgs>;
     /**
      * Initializes the KeyboardEvents
-     * @param {HTMLElement} element
-     * @param {KeyboardEventsModel} options
+     *
+     * @param {HTMLElement} element ?
+     * @param {KeyboardEventsModel} options ?
      */
     constructor(element: HTMLElement, options?: KeyboardEventsModel);
     /**
      * Unwire bound events and destroy the instance.
-     * @return {void}
+     *
+     * @returns {void} ?
      */
     destroy(): void;
     /**
      * Function can be used to specify certain action if a property is changed
-     * @param newProp
-     * @param oldProp
-     * @returns {void}
+     *
+     * @param {KeyboardEventsModel} newProp ?
+     * @param {KeyboardEventsModel} oldProp ?
+     * @returns {void} ?
      * @private
      */
     onPropertyChanged(newProp: KeyboardEventsModel, oldProp?: KeyboardEventsModel): void;
     protected bind(): void;
     /**
      * To get the module name, returns 'keyboard'.
+     *
+     * @returns {string} ?
      * @private
      */
     getModuleName(): string;
     /**
      * Wiring event handlers to events
+     *
+     * @returns {void} ?
+     * @private
      */
     private wireEvents;
     /**
      * Unwiring event handlers to events
+     *
+     * @returns {void} ?
+     * @private
      */
     private unwireEvents;
     /**
      * To handle a key press event returns null
+     *
+     * @param {KeyboardEventArgs} e ?
+     * @returns {void} ?
      */
     private keyPressHandler;
     private static configCache;
     /**
      * To get the key configuration data
+     *
      * @param {string} config - configuration data
-     * returns {KeyData}
+     * @returns {KeyData} ?
      */
     private static getKeyConfigData;
     private static getKeyCode;

package/src/keyboard.js

@@ -84,13 +84,17 @@ var KeyboardEvents = /** @class */ (function (_super) {
     __extends(KeyboardEvents, _super);
     /**
      * Initializes the KeyboardEvents
-     * @param {HTMLElement} element
-     * @param {KeyboardEventsModel} options
+     *
+     * @param {HTMLElement} element ?
+     * @param {KeyboardEventsModel} options ?
      */
     function KeyboardEvents(element, options) {
         var _this = _super.call(this, options, element) || this;
         /**
          * To handle a key press event returns null
+         *
+         * @param {KeyboardEventArgs} e ?
+         * @returns {void} ?
          */
         _this.keyPressHandler = function (e) {
             var isAltKey = e.altKey;
@@ -120,7 +124,8 @@ var KeyboardEvents = /** @class */ (function (_super) {
     KeyboardEvents_1 = KeyboardEvents;
     /**
      * Unwire bound events and destroy the instance.
-     * @return {void}
+     *
+     * @returns {void} ?
      */
     KeyboardEvents.prototype.destroy = function () {
         this.unwireEvents();
@@ -128,20 +133,23 @@ var KeyboardEvents = /** @class */ (function (_super) {
     };
     /**
      * Function can be used to specify certain action if a property is changed
-     * @param newProp
-     * @param oldProp
-     * @returns {void}
+     *
+     * @param {KeyboardEventsModel} newProp ?
+     * @param {KeyboardEventsModel} oldProp ?
+     * @returns {void} ?
      * @private
      */
+    // eslint-disable-next-line
     KeyboardEvents.prototype.onPropertyChanged = function (newProp, oldProp) {
         // No code are needed
     };
-    ;
     KeyboardEvents.prototype.bind = function () {
         this.wireEvents();
     };
     /**
      * To get the module name, returns 'keyboard'.
+     *
+     * @returns {string} ?
      * @private
      */
     KeyboardEvents.prototype.getModuleName = function () {
@@ -149,20 +157,27 @@ var KeyboardEvents = /** @class */ (function (_super) {
     };
     /**
      * Wiring event handlers to events
+     *
+     * @returns {void} ?
+     * @private
      */
     KeyboardEvents.prototype.wireEvents = function () {
         this.element.addEventListener(this.eventName, this.keyPressHandler);
     };
     /**
      * Unwiring event handlers to events
+     *
+     * @returns {void} ?
+     * @private
      */
     KeyboardEvents.prototype.unwireEvents = function () {
         this.element.removeEventListener(this.eventName, this.keyPressHandler);
     };
     /**
      * To get the key configuration data
+     *
      * @param {string} config - configuration data
-     * returns {KeyData}
+     * @returns {KeyData} ?
      */
     KeyboardEvents.getKeyConfigData = function (config) {
         if (config in this.configCache) {
@@ -184,7 +199,7 @@ var KeyboardEvents = /** @class */ (function (_super) {
         KeyboardEvents_1.configCache[config] = keyData;
         return keyData;
     };
-    // Return the keycode value as string 
+    // Return the keycode value as string
     KeyboardEvents.getKeyCode = function (keyVal) {
         return keyCode[keyVal] || keyVal.toUpperCase().charCodeAt(0);
     };

package/src/l10n.d.ts

@@ -28,30 +28,39 @@ export declare class L10n {
     private currentLocale;
     /**
      * Constructor
+     *
+     * @param {string} controlName ?
+     * @param {Object} localeStrings ?
+     * @param {string} locale ?
      */
     constructor(controlName: string, localeStrings: Object, locale?: string);
     /**
      * Sets the locale text
-     * @param {string} locale
-     * @returns {void}
+     *
+     * @param {string} locale ?
+     * @returns {void} ?
      */
     setLocale(locale: string): void;
     /**
      * Sets the global locale for all components.
+     *
      * @param {Object} localeObject - specifies the localeObject to be set as global locale.
+     * @returns {void} ?
      */
     static load(localeObject: Object): void;
     /**
      * Returns current locale text for the property based on the culture name and control name.
-     * @param {string} propertyName - specifies the property for which localize text to be returned.
-     * @return string
+     *
+     * @param {string} prop - specifies the property for which localize text to be returned.
+     * @returns {string} ?
      */
     getConstant(prop: string): string;
     /**
      * Returns the control constant object for current object and the locale specified.
-     * @param {Object} curObject
-     * @param {string} locale
-     * @returns {Object}
+     *
+     * @param {Object} curObject ?
+     * @param {string} locale ?
+     * @returns {Object} ?
      */
     private intGetControlConstant;
 }

package/src/l10n.js

@@ -26,6 +26,10 @@ import { defaultCulture } from './internationalization';
 var L10n = /** @class */ (function () {
     /**
      * Constructor
+     *
+     * @param {string} controlName ?
+     * @param {Object} localeStrings ?
+     * @param {string} locale ?
      */
     function L10n(controlName, localeStrings, locale) {
         this.controlName = controlName;
@@ -34,8 +38,9 @@ var L10n = /** @class */ (function () {
     }
     /**
      * Sets the locale text
-     * @param {string} locale
-     * @returns {void}
+     *
+     * @param {string} locale ?
+     * @returns {void} ?
      */
     L10n.prototype.setLocale = function (locale) {
         var intLocale = this.intGetControlConstant(L10n.locale, locale);
@@ -43,15 +48,18 @@ var L10n = /** @class */ (function () {
     };
     /**
      * Sets the global locale for all components.
+     *
      * @param {Object} localeObject - specifies the localeObject to be set as global locale.
+     * @returns {void} ?
      */
     L10n.load = function (localeObject) {
         this.locale = extend(this.locale, localeObject, {}, true);
     };
     /**
      * Returns current locale text for the property based on the culture name and control name.
-     * @param {string} propertyName - specifies the property for which localize text to be returned.
-     * @return string
+     *
+     * @param {string} prop - specifies the property for which localize text to be returned.
+     * @returns {string} ?
      */
     L10n.prototype.getConstant = function (prop) {
         // Removed conditional operator because this method does not return correct value when passing 0 as value in localization
@@ -64,9 +72,10 @@ var L10n = /** @class */ (function () {
     };
     /**
      * Returns the control constant object for current object and the locale specified.
-     * @param {Object} curObject
-     * @param {string} locale
-     * @returns {Object}
+     *
+     * @param {Object} curObject ?
+     * @param {string} locale ?
+     * @returns {Object} ?
      */
     L10n.prototype.intGetControlConstant = function (curObject, locale) {
         if ((curObject)[locale]) {

package/src/module-loader.d.ts

@@ -24,32 +24,37 @@ export declare class ModuleLoader {
     constructor(parent: IParent);
     /**
      * Inject required modules in component library
-     * @return {void}
+     *
+     * @returns {void} ?
      * @param {ModuleDeclaration[]} requiredModules - Array of modules to be required
      * @param {Function[]} moduleList - Array of modules to be injected from sample side
      */
     inject(requiredModules: ModuleDeclaration[], moduleList: Function[]): void;
     /**
      * To remove the created object while destroying the control
-     * @return {void}
+     *
+     * @returns {void}
      */
     clean(): void;
     /**
      * Removes all unused modules
-     * @param {ModuleDeclaration[]} moduleList
-     * @returns {void}
+     *
+     * @param {ModuleDeclaration[]} moduleList ?
+     * @returns {void} ?
      */
     private clearUnusedModule;
     /**
      * To get the name of the member.
-     * @param {string} name
-     * @returns {string}
+     *
+     * @param {string} name ?
+     * @returns {string} ?
      */
     private getMemberName;
     /**
      * Returns boolean based on whether the module specified is loaded or not
-     * @param {string} modName
-     * @returns {boolean}
+     *
+     * @param {string} modName ?
+     * @returns {boolean} ?
      */
     private isModuleLoaded;
 }

package/src/module-loader.js

@@ -8,10 +8,10 @@ var ModuleLoader = /** @class */ (function () {
         this.loadedModules = [];
         this.parent = parent;
     }
-    ;
     /**
      * Inject required modules in component library
-     * @return {void}
+     *
+     * @returns {void} ?
      * @param {ModuleDeclaration[]} requiredModules - Array of modules to be required
      * @param {Function[]} moduleList - Array of modules to be injected from sample side
      */
@@ -47,7 +47,8 @@ var ModuleLoader = /** @class */ (function () {
     };
     /**
      * To remove the created object while destroying the control
-     * @return {void}
+     *
+     * @returns {void}
      */
     ModuleLoader.prototype.clean = function () {
         for (var _i = 0, _a = this.loadedModules; _i < _a.length; _i++) {
@@ -60,8 +61,9 @@ var ModuleLoader = /** @class */ (function () {
     };
     /**
      * Removes all unused modules
-     * @param {ModuleDeclaration[]} moduleList
-     * @returns {void}
+     *
+     * @param {ModuleDeclaration[]} moduleList ?
+     * @returns {void} ?
      */
     ModuleLoader.prototype.clearUnusedModule = function (moduleList) {
         var _this = this;
@@ -80,16 +82,18 @@ var ModuleLoader = /** @class */ (function () {
     };
     /**
      * To get the name of the member.
-     * @param {string} name
-     * @returns {string}
+     *
+     * @param {string} name ?
+     * @returns {string} ?
      */
     ModuleLoader.prototype.getMemberName = function (name) {
         return name[0].toLowerCase() + name.substring(1) + MODULE_SUFFIX;
     };
     /**
      * Returns boolean based on whether the module specified is loaded or not
-     * @param {string} modName
-     * @returns {boolean}
+     *
+     * @param {string} modName ?
+     * @returns {boolean} ?
      */
     ModuleLoader.prototype.isModuleLoaded = function (modName) {
         for (var _i = 0, _a = this.loadedModules; _i < _a.length; _i++) {

package/src/notify-property-change.d.ts

@@ -1,6 +1,8 @@
 /**
  * Method used to create property. General syntax below.
- * @param  {T} defaultValue? - Specifies the default value of property.
+ *
+ * @param {Object} defaultValue - Specifies the default value of property.
+ * @returns {PropertyDecorator} ?
  * ```
  * @Property('TypeScript')
  * propertyName: Type;
@@ -10,8 +12,10 @@
 export declare function Property<T>(defaultValue?: T | Object): PropertyDecorator;
 /**
  * Method used to create complex property. General syntax below.
- * @param  {T} defaultValue - Specifies the default value of property.
+ *
+ * @param  {any} defaultValue - Specifies the default value of property.
  * @param  {Function} type - Specifies the class type of complex object.
+ * @returns {PropertyDecorator} ?
  * ```
  * @Complex<Type>({},Type)
  * propertyName: Type;
@@ -21,8 +25,9 @@ export declare function Property<T>(defaultValue?: T | Object): PropertyDecorato
 export declare function Complex<T>(defaultValue: T, type: Function): PropertyDecorator;
 /**
  * Method used to create complex Factory property. General syntax below.
- * @param  {Function} defaultType - Specifies the default value of property.
+ *
  * @param  {Function} type - Specifies the class factory type of complex object.
+ * @returns {PropertyDecorator} ?
  * ```
  * @ComplexFactory(defaultType, factoryFunction)
  * propertyName: Type1 | Type2;
@@ -32,8 +37,10 @@ export declare function Complex<T>(defaultValue: T, type: Function): PropertyDec
 export declare function ComplexFactory(type: Function): PropertyDecorator;
 /**
  * Method used to create complex array property. General syntax below.
- * @param  {T[]} defaultValue - Specifies the default value of property.
+ *
+ * @param  {any} defaultValue - Specifies the default value of property.
  * @param  {Function} type - Specifies the class type of complex object.
+ * @returns {PropertyDecorator} ?
  * ```
  * @Collection([], Type);
  * propertyName: Type;
@@ -43,8 +50,9 @@ export declare function ComplexFactory(type: Function): PropertyDecorator;
 export declare function Collection<T>(defaultValue: T[], type: Function): PropertyDecorator;
 /**
  * Method used to create complex factory array property. General syntax below.
- * @param  {T[]} defaultType - Specifies the default type of property.
+ *
  * @param  {Function} type - Specifies the class type of complex object.
+ * @returns {PropertyCollectionInfo} ?
  * ```
  * @Collection([], Type);
  * propertyName: Type;
@@ -54,8 +62,8 @@ export declare function Collection<T>(defaultValue: T[], type: Function): Proper
 export declare function CollectionFactory(type: Function): PropertyDecorator;
 /**
  * Method used to create event property. General syntax below.
- * @param  {Function} defaultValue? - Specifies the default value of property.
- * @param  {boolean} isComplex? - Specifies the whether it is complex object.
+ *
+ * @returns {PropertyDecorator} ?
  * ```
  * @Event(()=>{return true;})
  * ```
@@ -65,6 +73,8 @@ export declare function Event(): PropertyDecorator;
 /**
  * NotifyPropertyChanges is triggers the call back when the property has been changed.
  *
+ * @param {Function} classConstructor ?
+ * @returns {void} ?
  * ```
  *  @NotifyPropertyChanges
  * class DemoClass implements INotifyPropertyChanged {
@@ -92,7 +102,9 @@ export interface INotifyPropertyChanged {
 }
 /**
  * Method used to create builder for the components
+ *
  * @param {any} component -specifies the target component for which builder to be created.
+ * @returns {Object} ?
  * @private
  */
 export declare function CreateBuilder<T>(component: T): Object;