@base-framework/base 3.0.121 → 3.0.123

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

@@ -59,6 +59,22 @@ export class Component extends Unit {
      *
      * @protected
      * @returns {object}
+     *
+     * @example
+     * return {
+     *
+     * 	// simple state
+     * 	action: 'state', // any primitive value
+     *
+     * 	// a more complex state
+     * 	complexAction: {
+     * 		state: 'state', // any primitive value
+     * 		callBack(state, prevState)
+     * 		{
+     * 			// do something
+     * 		}
+     * 	}
+     * };
      */
     protected setupStates(): object;
     /**
@@ -89,6 +105,12 @@ export class Component extends Unit {
      *
      * @protected
      * @returns {array}
+     *
+     * @example
+     * return [
+     * 	// event, element, function, capture
+     * 	['click', this.element, function(e){}, false]
+     * ];
      */
     protected setupEvents(): any[];
     /**

package/dist/types/modules/date/date-time.d.ts

@@ -20,10 +20,10 @@ export namespace DateTime {
      * This will convert a date.
      *
      * @param {string} dateString
-     * @param {boolean} addYear
+     * @param {boolean} [addYear]
      * @returns {string}
      */
-    function convertDate(dateString: string, addYear: boolean): string;
+    function convertDate(dateString: string, addYear?: boolean): string;
     /**
      * This will add leading zero to number less than 10.
      *
@@ -41,11 +41,11 @@ export namespace DateTime {
     /**
      * This will format a date.
      *
-     * @param {string} type
+     * @param {string} formatType
      * @param {string} dateString
      * @returns {string}
      */
-    function format(type: string, dateString: string): string;
+    function format(formatType: string, dateString: string): string;
     /**
      * This will format time.
      *
@@ -54,6 +54,48 @@ export namespace DateTime {
      * @returns {string}
      */
     function formatTime(dateString: string, format: number): string;
+    /**
+     * This will get the meridian.
+     *
+     * @param {number|string} hours
+     * @returns {string}
+     */
+    function getMeridian(hours: string | number): string;
+    /**
+     * This will convert 24 hour time to 12 hour time.
+     *
+     * @param {number|string} hours
+     * @returns {number}
+     */
+    function convert24To12(hours: string | number): number;
+    /**
+     * This will convert 12 hour time to 24 hour time.
+     *
+     * @param {number|string} hours
+     * @param {string} meridian
+     * @returns {number}
+     */
+    function convert12To24(hours: string | number, meridian: string): number;
+    /**
+     * This will render a date.
+     *
+     * @param {number} year
+     * @param {number|string} month
+     * @param {number|string} day
+     * @param {string} [format='sql']
+     * @returns {string}
+     */
+    function renderDate(year: number, month: string | number, day: string | number, format?: string): string;
+    /**
+     * This will render time.
+     *
+     * @param {number} hours
+     * @param {number} minutes
+     * @param {number} [seconds=0]
+     * @param {string} [format='sql']
+     * @returns {string}
+     */
+    function renderTime(hours: number, minutes: number, seconds?: number, format?: string): string;
     /**
      * This will check for leap year.
      *
@@ -84,6 +126,24 @@ export namespace DateTime {
      * @returns {array}
      */
     function getMonthsLength(year?: number): any[];
+    /**
+     * This will get the local date.
+     *
+     * @param {string} remoteData
+     * @param {string} [remoteTimeZone]
+     * @returns {Date}
+     */
+    function getLocalDate(remoteData: string, remoteTimeZone?: string): Date;
+    /**
+     * This will convert a remote date to local time.
+     *
+     * @param {string} remoteData
+     * @param {boolean} sqlformat
+     * @param {boolean} timeOnly
+     * @param {string} [remoteTimeZone]
+     * @returns {string}
+     */
+    function getLocalTime(remoteData: string, sqlformat?: boolean, timeOnly?: boolean, remoteTimeZone?: string): string;
     /**
      * This will get the difference from now.
      *

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

@@ -38,11 +38,11 @@ export class Html {
      * This will add an element attribute.
      *
      * @param {object} obj
-     * @param {object} attr
+     * @param {string} attr
      * @param {*} value
      * @returns {void}
      */
-    static addAttr(obj: object, attr: object, value: any): void;
+    static addAttr(obj: object, attr: string, value: any): void;
     /**
      * This will create a doc fragment.
      *

package/dist/types/modules/layout/html-helper.d.ts

@@ -32,11 +32,11 @@ export class HtmlHelper extends Html {
      * This will add an element attribute.
      *
      * @param {object} ele
-     * @param {object} attr
+     * @param {string} attr
      * @param {*} value
      * @returns {void}
      */
-    static addAttr(ele: object, attr: object, value: any, parent: any): void;
+    static addAttr(ele: object, attr: string, value: any, parent: any): void;
     /**
      * This will add content to an element.
      *

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

@@ -240,6 +240,25 @@ export class Router {
      * @returns {void}
      */
     select(route: object): void;
+    /**
+     * This will check to scroll to the top of the page.
+     *
+     * @returns {void}
+     */
+    checkToScroll(): void;
+    /**
+     * This will clean the path.
+     *
+     * @param {string|null} path
+     * @returns {string}
+     */
+    cleanPath(path: string | null): string;
+    /**
+     * This will scroll to the top of the page if the route has changed.
+     *
+     * @returns {boolean}
+     */
+    shouldScrollToTop(): boolean;
     /**
      * This will get the endpoint.
      *

package/dist/types/shared/strings.d.ts

@@ -7,6 +7,14 @@
  * @name Strings
  */
 export class Strings {
+    /**
+     * This will limit the length of a string.
+     *
+     * @param {string} str
+     * @param {number} [maxLength]
+     * @returns {string}
+     */
+    static limit(str: string, maxLength?: number): string;
     /**
      * This will parse a query string.
      *
@@ -31,4 +39,11 @@ export class Strings {
      * @returns {string} The string.
      */
     static uncamelCase(str: string, delimiter?: string): string;
+    /**
+     * This will title case a string.
+     *
+     * @param {string} str
+     * @returns {string} The string.
+     */
+    static titleCase(str: string): string;
 }

package/package.json

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