@base-framework/base 3.0.192 → 3.0.193

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,48 +1,49 @@
1
1
  /**
2
2
  * Strings
3
3
  *
4
- * Contains utility methods for working with strings.
4
+ * This will contain methods for working with strings.
5
5
  *
6
6
  * @module
7
7
  * @name Strings
8
8
  */
9
9
  export class Strings {
10
10
  /**
11
- * Limits the length of a string.
11
+ * This will limit the length of a string.
12
12
  *
13
- * @param {string} str - The string to limit.
14
- * @param {number} [maxLength=1000] - The maximum length of the string.
15
- * @returns {string} The truncated string.
13
+ * @param {string} str
14
+ * @param {number} [maxLength]
15
+ * @returns {string}
16
16
  */
17
17
  static limit(str: string, maxLength?: number): string;
18
18
  /**
19
- * Parses a query string into an object.
19
+ * This will parse a query string.
20
20
  *
21
- * @param {string} [str=window.location.search] - The string to parse.
22
- * @param {boolean} [decode=true] - Whether to decode the query values.
23
- * @returns {object} An object representing the query string parameters.
21
+ * @param {string} [str] The string to parse or the global
22
+ * location will be parsed.
23
+ * @param {boolean} [decode]
24
+ * @returns {object}
24
25
  */
25
26
  static parseQueryString(str?: string, decode?: boolean): object;
26
27
  /**
27
- * Converts a string to camelCase.
28
+ * This will camelCase a string.
28
29
  *
29
- * @param {string} str - The string to convert.
30
- * @returns {string} The camelCased string.
30
+ * @param {string} str
31
+ * @returns {string} The string or false.
31
32
  */
32
33
  static camelCase(str: string): string;
33
34
  /**
34
- * Converts a camelCase string to a delimited format.
35
+ * This will uncamel-case a string.
35
36
  *
36
- * @param {string} str - The camelCase string.
37
- * @param {string} [delimiter="-"] - The delimiter to use.
38
- * @returns {string} The uncamelCased string.
37
+ * @param {string} str
38
+ * @param {string} [delimiter]
39
+ * @returns {string} The string.
39
40
  */
40
41
  static uncamelCase(str: string, delimiter?: string): string;
41
42
  /**
42
- * Converts a string to Title Case.
43
+ * This will title case a string.
43
44
  *
44
- * @param {string} str - The string to convert.
45
- * @returns {string} The title-cased string.
45
+ * @param {string} str
46
+ * @returns {string} The string.
46
47
  */
47
48
  static titleCase(str: string): string;
48
49
  }
@@ -1,52 +1,52 @@
1
1
  /**
2
2
  * Types
3
3
  *
4
- * This will contain methods for working with types.
4
+ * Utility class for working with variable types.
5
5
  *
6
6
  * @module
7
7
  * @name Types
8
8
  */
9
9
  export class Types {
10
10
  /**
11
- * This will get the type of a variable.
11
+ * Gets the type of a variable.
12
12
  *
13
- * @param {*} data
14
- * @returns {string}
13
+ * @param {*} data - The data whose type is to be determined.
14
+ * @returns {string} The type of the variable ('undefined', 'object', 'function', 'array', etc.).
15
15
  */
16
16
  static getType(data: any): string;
17
17
  /**
18
- * This will check if a request is undefined.
18
+ * Checks if a value is undefined.
19
19
  *
20
- * @param {*} data
21
- * @returns {boolean}
20
+ * @param {*} data - The data to check.
21
+ * @returns {boolean} True if the data is undefined.
22
22
  */
23
23
  static isUndefined(data: any): boolean;
24
24
  /**
25
- * This will check if the request is an object.
25
+ * Checks if a value is an object (excluding arrays).
26
26
  *
27
- * @param {*} data
28
- * @returns {boolean}
27
+ * @param {*} data - The data to check.
28
+ * @returns {boolean} True if the data is a plain object.
29
29
  */
30
30
  static isObject(data: any): boolean;
31
31
  /**
32
- * This will check if the request is a function.
32
+ * Checks if a value is a function.
33
33
  *
34
- * @param {*} data
35
- * @returns {boolean}
34
+ * @param {*} data - The data to check.
35
+ * @returns {boolean} True if the data is a function.
36
36
  */
37
37
  static isFunction(data: any): boolean;
38
38
  /**
39
- * This will check if the request is a string.
39
+ * Checks if a value is a string.
40
40
  *
41
- * @param {*} data
42
- * @returns {boolean}
41
+ * @param {*} data - The data to check.
42
+ * @returns {boolean} True if the data is a string.
43
43
  */
44
44
  static isString(data: any): boolean;
45
45
  /**
46
- * This will check if the data is an array.
46
+ * Checks if a value is an array.
47
47
  *
48
- * @param {*} data
49
- * @returns {boolean}
48
+ * @param {*} data - The data to check.
49
+ * @returns {boolean} True if the data is an array.
50
50
  */
51
51
  static isArray(data: any): boolean;
52
52
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@base-framework/base",
3
- "version": "3.0.192",
3
+ "version": "3.0.193",
4
4
  "description": "This is a javascript framework.",
5
5
  "main": "./dist/base.js",
6
6
  "type": "module",