@base-framework/base 3.0.117 → 3.0.119

package/dist/types/modules/animations/animation.d.ts

@@ -1,9 +1,14 @@
 /**
- * Class representing an animation.
+ * Animation
+ *
+ * This will setup the animation.
+ *
+ * @class
  */
 export class Animation {
     /**
      * Create an animation.
+     *
      * @param {HTMLElement} element - The element to animate.
      * @param {Object} settings - The settings for the animation.
      */
@@ -12,17 +17,23 @@ export class Animation {
     movements: any[];
     /**
      * Setup the animation with the given settings.
+     *
      * @param {Object} settings - The settings for the animation.
+     * @returns {void}
      */
     setup(settings: any): void;
     /**
      * Add a movement to the animation.
+     *
      * @param {Object} property - The property to animate.
+     * @returns {void}
      */
     addMovement(property: any): void;
     /**
      * Setup the movements for the animation.
+     *
      * @param {Object} settings - The settings for the animation.
+     * @returns {void}
      */
     setupMovements(settings: any): void;
 }

package/dist/types/modules/animations/attr-movement.d.ts

@@ -1,5 +1,39 @@
+/**
+ * AttrMovement
+ *
+ * This will animate an attribute.
+ *
+ * @class
+ */
 export class AttrMovement extends Movement {
+    /**
+     * Create an attribute movement.
+     *
+     * @param {object} element - The element to animate.
+     * @param {object} settings - The settings
+     */
+    constructor(element: object, settings: object);
     filter: any;
+    /**
+     * This will get the value of the element property.
+     *
+     * @param {*} value - The value to get.
+     * @param {*} end - The end value.
+     * @returns {*} The value.
+     */
+    getStartValue(value: any, end: any): any;
+    /**
+     * This will get the value of the element property.
+     *
+     * @param {*} value - The value to get.
+     * @returns {*} The value.
+     */
     filterValue(value: any, ...args: any[]): any;
+    /**
+     * This will update the value of the element property.
+     *
+     * @param {*} value
+     */
+    update(value: any): void;
 }
 import { Movement } from './movement.js';

package/dist/types/modules/component/prop-utils.d.ts

@@ -0,0 +1,4 @@
+export function DefaultProps(): object;
+export function StringProp(value: string): object;
+export function ArrayProp(value: any[]): object;
+export function ObjectProp(args: any[]): object;

package/dist/types/modules/router/history/history-controller.d.ts

@@ -2,20 +2,21 @@
  * HistoryController
  *
  * This will setup the history controller.
+ *
  * @class
  */
 export class HistoryController {
     /**
      * This will check if browser based navigation is supported
      *
-     * @returns boolean
+     * @returns {boolean}
      */
     static browserIsSupported(): boolean;
     /**
      * This will create a History Object based on navigation support
      *
      * @param {object} router
-     * @returns History
+     * @returns {object}
      */
-    static setup(router: object): any;
+    static setup(router: object): object;
 }

package/dist/types/modules/router/history/history.d.ts

@@ -26,6 +26,19 @@ export class History {
      * @param {object} evt
      */
     check(evt: object): void;
+    /**
+     * This will get the current scroll position.
+     *
+     * @returns {object}
+     */
+    getScrollPosition(): object;
+    /**
+     * This will scroll to a position.
+     *
+     * @param {object} scrollPosition
+     * @returns {void}
+     */
+    scrollTo(scrollPosition: object): void;
     /**
      * This will add the events.
      *

package/dist/types/modules/router/utils.d.ts

@@ -1,9 +1,8 @@
-export namespace Utils {
-    /**
-     * This will remove the begining and ending slashes from a url.
-     *
-     * @param {string} uri
-     * @returns {string}
-     */
-    function removeSlashes(uri: string): string;
-}
+/**
+ * Utils
+ *
+ * These are some helper functions for the router.
+ *
+ * @type {object} Utils
+ */
+export const Utils: object;

package/package.json

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