@base-framework/base 3.0.190 → 3.0.192

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

@@ -1,62 +1,62 @@
 export namespace Objects {
     /**
-     * This will create a new object.
+     * Creates a new object, optionally extending from another object.
      *
-     * @param {object} [object] An object to extend.
-     * @returns {object}
+     * @param {object} [prototype] - The prototype object to extend from.
+     * @returns {object} The newly created object.
      */
-    function create(object?: any): any;
+    function create(prototype?: any): any;
     /**
-     * This will extend an object to another object.
+     * Extends properties from the source object to the target object.
+     * Only copies properties that are not already defined on the target object.
      *
-     * @param {(function|object)} sourceObj
-     * @param {(function|object)} targetObj
-     * @returns {object}
+     * @param {object} sourceObj - The source object.
+     * @param {object} targetObj - The target object to extend.
+     * @returns {object|false} The extended target object or false if invalid.
      */
     function extendObject(sourceObj: any, targetObj: any): any;
     /**
-     * This will clone an object.
+     * Deep clones an object in a safe and scalable manner.
      *
-     * @param {object} obj
-     * @returns {object}
+     * @param {object} obj - The object to clone.
+     * @returns {object} A deep clone of the object.
      */
     function clone(obj: any): any;
     /**
-     * This will get the class prototype.
+     * Retrieves the prototype of a class or object.
      *
-     * @protected
-     * @param {function|object} object
-     * @returns {object}
+     * @param {function|object} entity - The class or object.
+     * @returns {object} The prototype of the entity.
      */
-    function getClassObject(object: any): any;
+    function getClassObject(entity: any): any;
     /**
-     * This will extend an object to another object.
+     * Extends a class or object with the properties of another class or object.
      *
-     * @param {function|object} sourceClass
-     * @param {function|object} targetClass
-     * @returns {object}
+     * @param {function|object} sourceClass - The source class or object.
+     * @param {function|object} targetClass - The target class or object.
+     * @returns {object|false} The resulting extended object or false if invalid.
      */
     function extendClass(sourceClass: any, targetClass: any): any;
     /**
-     * This will check if an object has a property.
+     * Checks if an object has a specific property.
      *
-     * @param {object} obj
-     * @param {string} prop
-     * @returns {boolean}
+     * @param {object} obj - The object to check.
+     * @param {string} prop - The property to check for.
+     * @returns {boolean} True if the object has the property.
      */
     function hasOwnProp(obj: any, prop: string): boolean;
     /**
-     * This will check if an object is a plain object.
+     * Determines if a value is a plain object.
      *
-     * @param {object} obj
-     * @returns {boolean}
+     * @param {object} obj - The value to check.
+     * @returns {boolean} True if the value is a plain object.
      */
     function isPlainObject(obj: any): boolean;
     /**
-     * This will check if an object is empty.
+     * Checks if an object is empty.
      *
-     * @param {object} obj
-     * @returns {boolean}
+     * @param {object} obj - The object to check.
+     * @returns {boolean} True if the object has no own properties.
      */
     function isEmpty(obj: any): boolean;
 }

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

@@ -1,49 +1,48 @@
 /**
  * Strings
  *
- * This will contain methods for working with strings.
+ * Contains utility methods for working with strings.
  *
  * @module
  * @name Strings
  */
 export class Strings {
     /**
-     * This will limit the length of a string.
+     * Limits the length of a string.
      *
-     * @param {string} str
-     * @param {number} [maxLength]
-     * @returns {string}
+     * @param {string} str - The string to limit.
+     * @param {number} [maxLength=1000] - The maximum length of the string.
+     * @returns {string} The truncated string.
      */
     static limit(str: string, maxLength?: number): string;
     /**
-     * This will parse a query string.
+     * Parses a query string into an object.
      *
-     * @param {string} [str] The string to parse or the global
-     * location will be parsed.
-     * @param {boolean} [decode]
-     * @returns {object}
+     * @param {string} [str=window.location.search] - The string to parse.
+     * @param {boolean} [decode=true] - Whether to decode the query values.
+     * @returns {object} An object representing the query string parameters.
      */
     static parseQueryString(str?: string, decode?: boolean): object;
     /**
-     * This will camelCase a string.
+     * Converts a string to camelCase.
      *
-     * @param {string} str
-     * @returns {string} The string or false.
+     * @param {string} str - The string to convert.
+     * @returns {string} The camelCased string.
      */
     static camelCase(str: string): string;
     /**
-     * This will uncamel-case a string.
+     * Converts a camelCase string to a delimited format.
      *
-     * @param {string} str
-     * @param {string} [delimiter]
-     * @returns {string} The string.
+     * @param {string} str - The camelCase string.
+     * @param {string} [delimiter="-"] - The delimiter to use.
+     * @returns {string} The uncamelCased string.
      */
     static uncamelCase(str: string, delimiter?: string): string;
     /**
-     * This will title case a string.
+     * Converts a string to Title Case.
      *
-     * @param {string} str
-     * @returns {string} The string.
+     * @param {string} str - The string to convert.
+     * @returns {string} The title-cased string.
      */
     static titleCase(str: string): string;
 }

package/package.json

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