@base-framework/base 3.0.191 → 3.0.192

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,49 +1,48 @@
1
1
  /**
2
2
  * Strings
3
3
  *
4
- * This will contain methods for working with strings.
4
+ * Contains utility methods for working with strings.
5
5
  *
6
6
  * @module
7
7
  * @name Strings
8
8
  */
9
9
  export class Strings {
10
10
  /**
11
- * This will limit the length of a string.
11
+ * Limits the length of a string.
12
12
  *
13
- * @param {string} str
14
- * @param {number} [maxLength]
15
- * @returns {string}
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.
16
16
  */
17
17
  static limit(str: string, maxLength?: number): string;
18
18
  /**
19
- * This will parse a query string.
19
+ * Parses a query string into an object.
20
20
  *
21
- * @param {string} [str] The string to parse or the global
22
- * location will be parsed.
23
- * @param {boolean} [decode]
24
- * @returns {object}
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.
25
24
  */
26
25
  static parseQueryString(str?: string, decode?: boolean): object;
27
26
  /**
28
- * This will camelCase a string.
27
+ * Converts a string to camelCase.
29
28
  *
30
- * @param {string} str
31
- * @returns {string} The string or false.
29
+ * @param {string} str - The string to convert.
30
+ * @returns {string} The camelCased string.
32
31
  */
33
32
  static camelCase(str: string): string;
34
33
  /**
35
- * This will uncamel-case a string.
34
+ * Converts a camelCase string to a delimited format.
36
35
  *
37
- * @param {string} str
38
- * @param {string} [delimiter]
39
- * @returns {string} The string.
36
+ * @param {string} str - The camelCase string.
37
+ * @param {string} [delimiter="-"] - The delimiter to use.
38
+ * @returns {string} The uncamelCased string.
40
39
  */
41
40
  static uncamelCase(str: string, delimiter?: string): string;
42
41
  /**
43
- * This will title case a string.
42
+ * Converts a string to Title Case.
44
43
  *
45
- * @param {string} str
46
- * @returns {string} The string.
44
+ * @param {string} str - The string to convert.
45
+ * @returns {string} The title-cased string.
47
46
  */
48
47
  static titleCase(str: string): string;
49
48
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@base-framework/base",
3
- "version": "3.0.191",
3
+ "version": "3.0.192",
4
4
  "description": "This is a javascript framework.",
5
5
  "main": "./dist/base.js",
6
6
  "type": "module",