@formio/js 5.0.0-dev.5610.c46fab6 → 5.0.0-dev.5613.3476921

package/lib/cjs/widgets/CalendarWidget.d.ts

@@ -26,7 +26,8 @@ export default class CalendarWidget extends InputWidget {
     timezonesUrl: string;
     /**
      * Load the timezones.
-     * @returns {boolean} TRUE if the zones are loading, FALSE otherwise.
+     *
+     * @return {boolean} TRUE if the zones are loading, FALSE otherwise.
      */
     loadZones(): boolean;
     attach(input: any): Promise<any>;
@@ -70,18 +71,18 @@ export default class CalendarWidget extends InputWidget {
     get dateTimeFormat(): string;
     get dateFormat(): any;
     /**
-     * Return the date value as a string.
-     * @param {string|Date} date - The date object or a date string that is momentjs compatible.
-     * @param {string} format - The DateParser code format.
-     * @param {boolean} [useTimezone] - If the timezone should be used.
-     * @returns {string} - Returns the formatted date string.
+     * Return the date value.
+     *
+     * @param date
+     * @param format
+     * @return {string}
      */
-    getDateValue(date: string | Date, format: string, useTimezone?: boolean | undefined): string;
+    getDateValue(date: any, format: any, useTimezone: any): string;
     isValueISO8601(value: any): any;
     /**
      * Set the selected date value.
-     * @param {*} value - The value to set.
-     * @returns {void}
+     *
+     * @param value
      */
     setValue(value: any): void;
     getValueAsString(value: any, format: any): string;

package/lib/cjs/widgets/CalendarWidget.js

@@ -56,7 +56,8 @@ class CalendarWidget extends InputWidget_1.default {
     }
     /**
      * Load the timezones.
-     * @returns {boolean} TRUE if the zones are loading, FALSE otherwise.
+     *
+     * @return {boolean} TRUE if the zones are loading, FALSE otherwise.
      */
     loadZones() {
         const timezone = this.timezone;
@@ -254,11 +255,11 @@ class CalendarWidget extends InputWidget_1.default {
         return lodash_1.default.get(this.settings, 'format', DEFAULT_FORMAT);
     }
     /**
-     * Return the date value as a string.
-     * @param {string|Date} date - The date object or a date string that is momentjs compatible.
-     * @param {string} format - The DateParser code format.
-     * @param {boolean} [useTimezone] - If the timezone should be used.
-     * @returns {string} - Returns the formatted date string.
+     * Return the date value.
+     *
+     * @param date
+     * @param format
+     * @return {string}
      */
     getDateValue(date, format, useTimezone) {
         if (useTimezone) {
@@ -268,7 +269,8 @@ class CalendarWidget extends InputWidget_1.default {
     }
     /**
      * Return the value of the selected date.
-     * @returns {*} - The value of the selected date.
+     *
+     * @return {*}
      */
     getValue() {
         // Standard output format.
@@ -290,8 +292,8 @@ class CalendarWidget extends InputWidget_1.default {
     }
     /**
      * Set the selected date value.
-     * @param {*} value - The value to set.
-     * @returns {void}
+     *
+     * @param value
      */
     setValue(value) {
         const saveAsText = (this.settings.saveAs === 'text');

package/lib/mjs/Element.d.ts

@@ -22,17 +22,20 @@ export default class Element {
     i18next: any;
     /**
      * An instance of the EventEmitter class to handle the emitting and registration of events.
+     *
      * @type {EventEmitter}
      */
     events: EventEmitter;
     defaultMask: any[] | null;
     /**
      * Conditional to show or hide helplinks in editForm
+     *
      * @type {*|boolean}
      */
     helplinks: any | boolean;
     /**
      * Register for a new event within this component.
+     *
      * @example
      * let component = new BaseComponent({
      *   type: 'textfield',
@@ -42,205 +45,212 @@ export default class Element {
      * component.on('componentChange', (changed) => {
      *   console.log('this element is changed.');
      * });
+     *
+     *
      * @param {string} event - The event you wish to register the handler for.
-     * @param {Function} cb - The callback handler to handle this event.
+     * @param {function} cb - The callback handler to handle this event.
      * @param {boolean} [internal] - This is an internal event handler.
      * @param {boolean} [once] - This event should only fire once.
-     * @returns {EventEmitter | void} - The event emitter instance.
      */
-    on(event: string, cb: Function, internal?: boolean | undefined, once?: boolean | undefined): EventEmitter | void;
+    on(event: string, cb: Function, internal?: boolean | undefined, once?: boolean | undefined): EventEmitter | undefined;
     /**
      * Register for a new single-fire event within this component.
+     *
      * @param {string} event - The event you wish to register the handler for.
-     * @param {Function} cb - The callback handler to handle this event.
-     * @param {boolean} internal - This is an internal event handler.
-     * @returns {EventEmitter} - The event emitter instance.
+     * @param {function} cb - The callback handler to handle this event.
      */
-    once(event: string, cb: Function, internal: boolean): EventEmitter;
+    once(event: string, cb: Function, internal: any): EventEmitter | undefined;
     /**
      * Allow catching any event.
-     * @param {Function} cb - The callback handler to handle this event.
-     * @returns {EventEmitter | void} - The event emitter instance.
+     *
+     * @param cb
+     * @returns {this}
      */
-    onAny(cb: Function): EventEmitter | void;
+    onAny(cb: any): this;
     /**
      * Removes the listener that will be fired when any event is emitted.
-     * @param {Function} cb - The callback handler to handle this event.
-     * @returns {EventEmitter | void} - The event emitter instance.
+     *
+     * @param cb
+     * @returns {this}
      */
-    offAny(cb: Function): EventEmitter | void;
+    offAny(cb: any): this;
     /**
      * Removes a listener for a certain event. Not passing the 2nd arg will remove all listeners for that event.
+     *
      * @param {string} event - The event you wish to register the handler for.
-     * @param {Function | undefined} cb - The callback handler to handle this event.
+     * @param {function|undefined} cb - The callback handler to handle this event.
      */
     off(event: string, cb: Function | undefined): void;
     /**
      * Emit a new event.
+     *
      * @param {string} event - The event to emit.
-     * @param {object} data - The data to emit with the handler.
+     * @param {Object} data - The data to emit with the handler.
      */
-    emit(event: string, ...data: object): void;
+    emit(event: string, ...data: Object): void;
     /**
      * Check if the component has an event handler set up for the event.
+     *
      * @param {string} event - The event name.
-     * @returns {boolean} - TRUE if the event is registered, FALSE otherwise.
+     * @returns {boolean}
      */
     hasEventHandler(event: string): boolean;
     /**
      * Wrapper method to add an event listener to an HTML element.
-     * @param {HtmlElement} obj - The DOM element to add the event to.
-     * @param {string} type - The event name to add.
-     * @param {Function} func - The callback function to be executed when the listener is triggered.
-     * @param {boolean} persistent - If this listener should persist beyond "destroy" commands.
-     * @param {boolean} capture - If this listener should be executed in the capture phase.
-     * @returns {void | this} - The instance of the element.
+     *
+     * @param obj
+     *   The DOM element to add the event to.
+     * @param type
+     *   The event name to add.
+     * @param func
+     *   The callback function to be executed when the listener is triggered.
+     * @param persistent
+     *   If this listener should persist beyond "destroy" commands.
      */
-    addEventListener(obj: HtmlElement, type: string, func: Function, persistent: boolean, capture: boolean): void | this;
+    addEventListener(obj: any, type: any, func: any, persistent: any, capture: any): this | undefined;
     /**
      * Remove an event listener from the object.
-     * @param {HTMLElement} obj - The DOM element to remove the event from.
-     * @param {string} type - The event name to remove.
-     * @param {Function} func - The callback function to remove.
-     * @returns {this | void} - The instance of the element.
+     *
+     * @param obj
+     * @param type
      */
-    removeEventListener(obj: HTMLElement, type: string, func?: Function): this | void;
+    removeEventListener(obj: any, type: any, func?: null): this | undefined;
     removeEventListeners(): void;
     removeAllEvents(includeExternal: any): void;
     teardown(): void;
     /**
      * Removes all event listeners attached to this component.
-     * @param {boolean} all - If all events should be removed, including external events.
      */
     destroy(all?: boolean): void;
     /**
      * Append an HTML DOM element to a container.
-     * @param {HTMLElement} element - The DOM element to append.
-     * @param {HTMLElement} container - The DOM element that is the container of the element getting appended.
-     * @returns {this} - The instance of the element.
+     *
+     * @param element
+     * @param container
      */
-    appendTo(element: HTMLElement, container: HTMLElement): this;
+    appendTo(element: any, container: any): this;
     /**
      * Prepend an HTML DOM element to a container.
+     *
      * @param {HTMLElement} element - The DOM element to prepend.
      * @param {HTMLElement} container - The DOM element that is the container of the element getting prepended.
-     * @returns {this} - The instance of the element.
      */
     prependTo(element: HTMLElement, container: HTMLElement): this;
     /**
      * Removes an HTML DOM element from its bounding container.
+     *
      * @param {HTMLElement} element - The element to remove.
      * @param {HTMLElement} container - The DOM element that is the container of the element to remove.
-     * @returns {this} - The instance of the element.
      */
     removeChildFrom(element: HTMLElement, container: HTMLElement): this;
     /**
      * Alias for document.createElement.
+     *
      * @param {string} type - The type of element to create
-     * @param {object} attr - The element attributes to add to the created element.
+     * @param {Object} attr - The element attributes to add to the created element.
      * @param {Various} children - Child elements. Can be a DOM Element, string or array of both.
-     * @returns {HTMLElement} - The created element.
+     *
+     * @return {HTMLElement} - The created element.
      */
-    ce(type: string, attr: object, children?: Various): HTMLElement;
+    ce(type: string, attr: Object, children?: Various): HTMLElement;
     /**
      * Append different types of children.
-     * @param {HTMLElement} element - The element to append to.
-     * @param {HTMLElement} child - The child element to append.
-     * @returns {this} - The instance of the element.
+     *
+     * @param child
      */
-    appendChild(element: HTMLElement, child: HTMLElement): this;
+    appendChild(element: any, child: any): this;
     /**
      * Creates a new input mask placeholder.
      * @param {HTMLElement} mask - The input mask.
      * @returns {string} - The placeholder that will exist within the input as they type.
      */
     maskPlaceholder(mask: HTMLElement): string;
-    /**
-     * Get the placeholder character for the input mask.
-     * @returns {string} - The placeholder character.
-     */
-    get placeholderChar(): string;
+    get placeholderChar(): any;
     /**
      * Sets the input mask for an input.
+     *
      * @param {HTMLElement} input - The html input to apply the mask to.
-     * @param {string} inputMask - The input mask to add to this input.
-     * @param {boolean} usePlaceholder - Set the mask placeholder on the input.
+     * @param {String} inputMask - The input mask to add to this input.
+     * @param {Boolean} usePlaceholder - Set the mask placeholder on the input.
      */
     setInputMask(input: HTMLElement, inputMask: string, usePlaceholder: boolean): void;
     /**
      * Translate a text using the i18n system.
+     *
      * @param {string|Array<string>} text - The i18n identifier.
-     * @param {...any} args - The arguments to pass to the i18n translation.
-     * @returns {string} - The translated text.
+     * @param {Object} params - The i18n parameters to use for translation.
      */
-    t(text: string | Array<string>, ...args: any[]): string;
+    t(text: string | Array<string>, ...args: any[]): any;
     /**
      * Alias to create a text node.
-     * @param {string} text - The text to create.
-     * @returns {HtmlElement} - The created text node.
+     * @param text
+     * @returns {Text}
      */
-    text(text: string): HtmlElement;
+    text(text: any): Text;
     /**
      * Adds an object of attributes onto an element.
      * @param {HtmlElement} element - The element to add the attributes to.
-     * @param {object} attr - The attributes to add to the input element.
+     * @param {Object} attr - The attributes to add to the input element.
      */
-    attr(element: HtmlElement, attr: object): void;
+    attr(element: HtmlElement, attr: Object): void;
     /**
      * Determines if an element has a class.
      *
      * Taken from jQuery https://j11y.io/jquery/#v=1.5.0&fn=jQuery.fn.hasClass
-     * @param {HTMLElement} element - The element to check for the class.
-     * @param {string} className - The class to check for.
-     * @returns {boolean} - TRUE if the element has the class, FALSE otherwise.
      */
-    hasClass(element: HTMLElement, className: string): boolean;
+    hasClass(element: any, className: any): boolean;
     /**
      * Adds a class to a DOM element.
-     * @param {HTMLElement} element - The element to add a class to.
-     * @param {string} className - The name of the class to add.
-     * @returns {this} - The instance of the element.
+     *
+     * @param element
+     *   The element to add a class to.
+     * @param className
+     *   The name of the class to add.
      */
-    addClass(element: HTMLElement, className: string): this;
+    addClass(element: any, className: any): this;
     /**
      * Remove a class from a DOM element.
-     * @param {HTMLElement} element - The DOM element to remove the class from.
-     * @param {string} className - The name of the class that is to be removed.
-     * @returns {this} - The instance of the element.
+     *
+     * @param element
+     *   The DOM element to remove the class from.
+     * @param className
+     *   The name of the class that is to be removed.
      */
-    removeClass(element: HTMLElement, className: string): this;
+    removeClass(element: any, className: any): this;
     /**
      * Empty's an HTML DOM element.
+     *
      * @param {HTMLElement} element - The element you wish to empty.
      */
     empty(element: HTMLElement): void;
     /**
      * Create an evaluation context for all script executions and interpolations.
-     * @param {object} additional - Additional context to apply to the evaluation context.
-     * @returns {*} - The evaluation context.
+     *
+     * @param additional
+     * @return {*}
      */
-    evalContext(additional: object): any;
+    evalContext(additional: any): any;
     /**
      * Performs an interpolation using the evaluation context of this component.
-     * @param {string} string - The string to interpolate.
-     * @param {object} data - The data to use in the interpolation.
-     * @param {object} options - The options to pass to the interpolation.
-     * @returns {XML|string|*|void} - The interpolated string.
+     *
+     * @param string
+     * @param data
+     * @return {XML|string|*|void}
      */
-    interpolate(string: string, data: object, options?: object): XML | string | any | void;
+    interpolate(string: any, data: any, options?: {}): XML | string | any | void;
     /**
      * Performs an evaluation using the evaluation context of this component.
-     * @param {string|Function|object} func - The function or string to evaluate.
-     * @param {object} args - The arguments to pass to the evaluation.
-     * @param {string} ret - The name of the variable within the evaluation context to return.
-     * @param {boolean} interpolate - Determines if it should replace all {{ }} token references with actual data.
-     * @param {import('@formio/core').EvaluatorOptions} options - The options to pass to the evaluation.
-     * @returns {*} - The result of the evaluation.
+     *
+     * @param func
+     * @param args
+     * @param ret
+     * @param tokenize
+     * @return {*}
      */
-    evaluate(func: string | Function | object, args: object, ret: string, interpolate: boolean, options?: import('@formio/core').EvaluatorOptions): any;
+    evaluate(func: any, args: any, ret: any, tokenize: any): any;
     /**
      * Allow for options to hook into the functionality of this renderer.
-     * @returns {*} - The result of the hook function.
+     * @return {*}
      */
     hook(...args: any[]): any;
 }