@base-framework/base 3.0.262 → 3.0.264

package/dist/types/main/events/event-methods.d.ts

@@ -6,40 +6,40 @@ export namespace EventMethods {
      * @param {string} event The event name.
      * @param {object} obj
      * @param {function} fn
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @returns {object}
      */
-    export function addListener(event: string, obj: object, fn: Function, capture?: boolean): object;
+    export function addListener(event: string, obj: object, fn: Function, capture?: boolean | object): object;
     /**
      * This will add an event to an object.
      *
-     * @param {string} event The event name.
+     * @param {string|array} event The event name.
      * @param {object} obj
      * @param {function} fn
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @returns {object}
      */
-    export function on(event: string, obj: object, fn: Function, capture?: boolean): object;
+    export function on(event: string | any[], obj: object, fn: Function, capture?: boolean | object): object;
     /**
      * This will remove an event from an object.
      *
-     * @param {string} event The event name.
+     * @param {string|array} event The event name.
      * @param {object} obj
      * @param {function} fn
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @returns {object}
      */
-    export function off(event: string, obj: object, fn: Function, capture?: boolean): object;
+    export function off(event: string | any[], obj: object, fn: Function, capture?: boolean | object): object;
     /**
      * This will remove an event from an object.
      *
      * @param {string} event The event name.
      * @param {object} obj
      * @param {function} fn
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @returns {object}
      */
-    export function removeListener(event: string, obj: object, fn: Function, capture?: boolean): object;
+    export function removeListener(event: string, obj: object, fn: Function, capture?: boolean | object): object;
     /**
      * This will create a custom event.
      *
@@ -93,19 +93,19 @@ export namespace EventMethods {
      * @param {function} callBackFn
      * @param {object} [obj]
      * @param {boolean} [cancelDefault]
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @returns {object} base object.
      */
-    export function onMouseWheel(callBackFn: Function, obj?: object, cancelDefault?: boolean, capture?: boolean): object;
+    export function onMouseWheel(callBackFn: Function, obj?: object, cancelDefault?: boolean, capture?: boolean | object): object;
     /**
      * This will remove a mouse event
      *
      * @param {function} callBackFn
      * @param {object} [obj]
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @returns {object} base object.
      */
-    export function offMouseWheel(callBackFn: Function, obj?: object, capture?: boolean): object;
+    export function offMouseWheel(callBackFn: Function, obj?: object, capture?: boolean | object): object;
     /**
      * This will prevent default on an event.
      *

package/dist/types/main/events/events.d.ts

@@ -12,32 +12,32 @@ export namespace Events {
      * @param {string} event The event name.
      * @param {object} obj
      * @param {function} fn
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @param {boolean} [swapped]
      * @param {function} [originalFn]
      * @returns {object}
      */
-    function create(event: string, obj: object, fn: Function, capture?: boolean, swapped?: boolean, originalFn?: Function): object;
+    function create(event: string, obj: object, fn: Function, capture?: boolean | object, swapped?: boolean, originalFn?: Function): object;
     /**
      * This will add an event to an object.
      *
      * @param {string|array} event The event name.
      * @param {object} obj
      * @param {function} fn
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @returns {object} The events object.
      */
-    function on(event: string | any[], obj: object, fn: Function, capture?: boolean): object;
+    function on(event: string | any[], obj: object, fn: Function, capture?: boolean | object): object;
     /**
      * This will remove an event from an object.
      *
      * @param {string|array} event The event name.
      * @param {object} obj
      * @param {function} fn
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @returns {object} The events object.
      */
-    function off(event: string | any[], obj: object, fn: Function, capture?: boolean): object;
+    function off(event: string | any[], obj: object, fn: Function, capture?: boolean | object): object;
     /**
      * This will add an event to an object.
      *
@@ -47,108 +47,9 @@ export namespace Events {
      * @param {object|boolean} [capture]
      * @param {boolean} [swapped]
      * @param {function} [originalFn]
+     * @returns {object} The events object.
      */
-    function add(event: string, obj: object, fn: Function, capture?: object | boolean, swapped?: boolean, originalFn?: Function): {
-        /**
-         * This will get the events on an element.
-         *
-         * @param {object} obj
-         * @returns {array}
-         */
-        getEvents(obj: object): any[];
-        /**
-         * This will create an object to use with the dataTracker.
-         *
-         * @param {string} event The event name.
-         * @param {object} obj
-         * @param {function} fn
-         * @param {boolean} [capture]
-         * @param {boolean} [swapped]
-         * @param {function} [originalFn]
-         * @returns {object}
-         */
-        create(event: string, obj: object, fn: Function, capture?: boolean, swapped?: boolean, originalFn?: Function): object;
-        /**
-         * This will add an event to an object.
-         *
-         * @param {string|array} event The event name.
-         * @param {object} obj
-         * @param {function} fn
-         * @param {boolean} [capture]
-         * @returns {object} The events object.
-         */
-        on(event: string | any[], obj: object, fn: Function, capture?: boolean): object;
-        /**
-         * This will remove an event from an object.
-         *
-         * @param {string|array} event The event name.
-         * @param {object} obj
-         * @param {function} fn
-         * @param {boolean} [capture]
-         * @returns {object} The events object.
-         */
-        off(event: string | any[], obj: object, fn: Function, capture?: boolean): object;
-        add(event: string, obj: object, fn: Function, capture?: object | boolean, swapped?: boolean, originalFn?: Function): /*elided*/ any;
-        /**
-         * This will remove an event from an object.
-         *
-         * @param {string} event The event name.
-         * @param {object} obj
-         * @param {function} fn
-         * @param {object|boolean} [capture]
-         * @returns {object} a reference to the event object.
-         */
-        remove(event: string, obj: object, fn: Function, capture?: object | boolean): object;
-        /**
-         * This will remove an event listener.
-         * @param {object} listener
-         * @returns {object} a reference to the event object.
-         */
-        removeEvent(listener: object): object;
-        /**
-         * This will search for an event.
-         *
-         * @protected
-         * @param {string} event The event name.
-         * @param {object} obj
-         * @param {function} fn
-         * @param {boolean} [capture]
-         * @returns {object|boolean}
-         */
-        getEvent(event: string, obj: object, fn: Function, capture?: boolean): object | boolean;
-        /**
-         * This will search for an event from the object events.
-         *
-         * @param {object} eventObj
-         * @param {array} events
-         * @returns {object|boolean}
-         */
-        search(eventObj: object, events: any[]): object | boolean;
-        /**
-         * This will remove all events on an object.
-         *
-         * @param {object} obj
-         * @returns {object} a reference to the events object.
-         */
-        removeEvents(obj: object): object;
-        /**
-         * @member {array} swap The swappable events.
-         */
-        swap: string[];
-        /**
-         * This will a event type to the swappable array.
-         *
-         * @param {string} type
-         */
-        addSwapped(type: string): void;
-        /**
-         * This will check if an event is swappable.
-         *
-         * @param {string} event
-         * @returns {boolean}
-         */
-        isSwappable(event: string): boolean;
-    };
+    function add(event: string, obj: object, fn: Function, capture?: object | boolean, swapped?: boolean, originalFn?: Function): object;
     /**
      * This will remove an event from an object.
      *
@@ -172,10 +73,10 @@ export namespace Events {
      * @param {string} event The event name.
      * @param {object} obj
      * @param {function} fn
-     * @param {boolean} [capture]
+     * @param {boolean|object} [capture]
      * @returns {object|boolean}
      */
-    function getEvent(event: string, obj: object, fn: Function, capture?: boolean): object | boolean;
+    function getEvent(event: string, obj: object, fn: Function, capture?: boolean | object): object | boolean;
     /**
      * This will search for an event from the object events.
      *

package/dist/types/modules/ajax/ajax.d.ts

@@ -3,9 +3,9 @@
  *
  * @overload
  * @param {string} url
- * @param {string} params
- * @param {function} callBackFn
- * @param {string} responseType
+ * @param {string} [params]
+ * @param {function} [callBackFn]
+ * @param {string} [responseType]
  * @param {string} [method=POST]
  * @param {boolean} [async]
  *
@@ -23,15 +23,15 @@
  *
  * @returns {object} xhr object.
  */
-export function Ajax(url: string, params: string, callBackFn: Function, responseType: string, method?: string, async?: boolean): any;
+export function Ajax(url: string, params?: string, callBackFn?: Function, responseType?: string, method?: string, async?: boolean): any;
 /**
  * This will make an xhr (ajax) request.
  *
  * @overload
  * @param {string} url
- * @param {string} params
- * @param {function} callBackFn
- * @param {string} responseType
+ * @param {string} [params]
+ * @param {function} [callBackFn]
+ * @param {string} [responseType]
  * @param {string} [method=POST]
  * @param {boolean} [async]
  *

package/dist/types/modules/component/jot.d.ts

@@ -1,6 +1,2 @@
-export function Jot(layout: object | Function, extend?: Function): ComponentConstructor | null;
-/**
- * A class constructor that, when instantiated, yields a Component (or subclass).
- */
-export type ComponentConstructor = new (...args: any[]) => Component;
+export function Jot(layout: object | Function, extend?: typeof Component): typeof Component | null;
 import { Component } from './component.js';

package/dist/types/modules/import/import-wrapper.d.ts

@@ -8,4 +8,4 @@
  * @param {object} props
  * @returns {Constructor}
  */
-export const ImportWrapper: import("../component/jot.js").ComponentConstructor;
+export const ImportWrapper: typeof import("../component/component.js").Component;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@base-framework/base",
-	"version": "3.0.262",
+	"version": "3.0.264",
 	"description": "This is a javascript framework.",
 	"main": "./dist/base.js",
 	"type": "module",