@@ -88,59 +88,59 @@ General utility functions that can be useful in any JavaScript/TypeScript projec
8888
8989<details open ><summary >Functions</summary >
9090
91- | Function | Description |
92- | :------------------------| :-------------------------------------------------------------------------------|
93- | ` chunk ` | Splits an array into chunks of a specified size. |
94- | ` decodeHtml ` | Decodes HTML entities. |
95- | ` encodeHtml ` | Encodes a string for safe use in HTML. |
96- | ` escapeHtml ` | Escapes HTML special characters. |
97- | ` escapeRegExp ` | Escapes special characters for use in regular expressions. |
98- | ` escapeXml ` | Escapes XML special characters. |
99- | ` hashCode ` | Calculates a hash code for a string. |
100- | ` is2DArray ` | Checks if a variable is a 2D array. |
101- | ` isBoolean ` | Checks if a variable is a boolean value. |
102- | ` isConsistent2DArray ` | Checks if a 2D array has consistent inner array lengths. |
103- | ` isEmail ` | Checks if a string is a valid email address. |
104- | ` isEmpty ` | Checks if a value is empty (for strings, arrays, objects). |
105- | ` isException ` | Checks if an object is an instance of ` Exception ` or its subclass. |
106- | ` isFunction ` | Checks if a variable is a function. |
107- | ` isLength ` | Checks if a value is "length-like" (arrays, strings, etc.). |
108- | ` isNil ` | Checks if a value is ` null ` or ` undefined ` . |
109- | ` isNull ` | Checks if a value is ` null ` . |
110- | ` isNumber ` | Checks if a variable is a number. |
111- | ` isNumberLike ` | Checks if a value can be converted to a number. |
112- | ` isObject ` | Checks if a variable is an object (but not ` null ` or an array). |
113- | ` isObjectLike ` | Checks if a variable is object-like (objects, arrays, functions). |
114- | ` isRegExp ` | Checks if a variable is a regular expression. |
115- | ` isScalar ` | Checks if a variable is a scalar value (string, number, boolean, symbol). |
116- | ` isString ` | Checks if a variable is a string. |
117- | ` isSymbol ` | Checks if a variable is a symbol. |
118- | ` isUndefined ` | Checks if a value is ` undefined ` . |
119- | ` isUrl ` | Checks if a string is a valid URL. |
120- | ` isValidLocale ` | Checks if a string is a valid locale code. |
121- | ` isValidSlug ` | Checks if a string is a valid "slug" (URL-friendly string). |
122- | ` isValidVersion ` | Checks if a string is a valid version number (semantic versioning). |
123- | ` isVersionCompatible ` | Checks version compatibility. |
124- | ` nonNil ` | Returns the value if not ` null ` or ` undefined ` , otherwise throws an exception. |
125- | ` nonNull ` | Returns the value if not ` null ` , otherwise throws an exception. |
126- | ` nonNumber ` | Returns the value if not a number, otherwise throws an exception. |
127- | ` nonString ` | Returns the value if not a string, otherwise throws an exception. |
128- | ` parseJson ` | Safely parses a JSON string. |
129- | ` requireNonEmptyString ` | Checks if a string is non-empty, otherwise throws an exception. |
130- | ` requireNonNull ` | Checks that a value is not ` null ` , otherwise throws an exception. |
131- | ` requireString ` | Checks that a value is a string, otherwise throws an exception. |
132- | ` requireValidEmail ` | Checks that a string is a valid email, otherwise throws an exception. |
133- | ` stringifyJson ` | Safely converts an object to a JSON string. |
134- | ` toCamelCase ` | Converts a string to camelCase. |
135- | ` toInteger ` | Converts a value to an integer. |
136- | ` toKebabCase ` | Converts a string to kebab-case. |
137- | ` toLowerCase ` | Converts a string to lowercase. |
138- | ` toProperCase ` | Converts a string to Proper Case (first letter of each word capitalized). |
139- | ` toSnakeCase ` | Converts a string to snake_case. |
140- | ` toString ` | Converts a value to a string. |
141- | ` toUpperCase ` | Converts a string to uppercase. |
142- | ` transpose ` | Transposes a 2D array (matrix). |
143- | ` versionCompare ` | Compares two versions. |
91+ | Function | Description |
92+ | :------------------------------------------------------------- | :-------------------------------------------------------------------------------|
93+ | [ ` chunk ` ] ( src/base/chunk.ts ) | Splits an array into chunks of a specified size. |
94+ | [ ` decodeHtml ` ] ( src/base/decodeHtml.ts ) | Decodes HTML entities. |
95+ | [ ` encodeHtml ` ] ( src/base/encodeHtml.ts ) | Encodes a string for safe use in HTML. |
96+ | [ ` escapeHtml ` ] ( src/base/escapeHtml.ts ) | Escapes HTML special characters. |
97+ | [ ` escapeRegExp ` ] ( src/base/escapeRegExp.ts ) | Escapes special characters for use in regular expressions. |
98+ | [ ` escapeXml ` ] ( src/base/escapeXml.ts ) | Escapes XML special characters. |
99+ | [ ` hashCode ` ] ( src/base/hashCode.ts ) | Calculates a hash code for a string. |
100+ | [ ` is2DArray ` ] ( src/base/is2DArray.ts ) | Checks if a variable is a 2D array. |
101+ | [ ` isBoolean ` ] ( src/base/isBoolean.ts ) | Checks if a variable is a boolean value. |
102+ | [ ` isConsistent2DArray ` ] ( src/base/isConsistent2DArray.ts ) | Checks if a 2D array has consistent inner array lengths. |
103+ | [ ` isEmail ` ] ( src/base/isEmail.ts ) | Checks if a string is a valid email address. |
104+ | [ ` isEmpty ` ] ( src/base/isEmpty.ts ) | Checks if a value is empty (for strings, arrays, objects). |
105+ | [ ` isException ` ] ( src/base/isException.ts ) | Checks if an object is an instance of ` Exception ` or its subclass. |
106+ | [ ` isFunction ` ] ( src/base/isFunction.ts ) | Checks if a variable is a function. |
107+ | [ ` isLength ` ] ( src/base/isLength.ts ) ` isLength ` | Checks if a value is "length-like" (arrays, strings, etc.). |
108+ | [ ` isNil ` ] ( src/base/isNil.ts ) ` isNil ` | Checks if a value is ` null ` or ` undefined ` . |
109+ | [ ` isNull ` ] ( src/base/isNull.ts ) ` isNull ` | Checks if a value is ` null ` . |
110+ | [ ` isNumber ` ] ( src/base/isNumber.ts ) | Checks if a variable is a number. |
111+ | [ ` isNumberLike ` ] ( src/base/isNumberLike.ts ) | Checks if a value can be converted to a number. |
112+ | [ ` isObject ` ] ( src/base/isObject.ts ) | Checks if a variable is an object (but not ` null ` or an array). |
113+ | [ ` isObjectLike ` ] ( src/base/isObjectLike.ts ) | Checks if a variable is object-like (objects, arrays, functions). |
114+ | [ ` isRegExp ` ] ( src/base/isRegExp.ts ) | Checks if a variable is a regular expression. |
115+ | [ ` isScalar ` ] ( src/base/isScalar.ts ) | Checks if a variable is a scalar value (string, number, boolean, symbol). |
116+ | [ ` isString ` ] ( src/base/isString.ts ) | Checks if a variable is a string. |
117+ | [ ` isSymbol ` ] ( src/base/isSymbol.ts ) | Checks if a variable is a symbol. |
118+ | [ ` isUndefined ` ] ( src/base/isUndefined.ts ) ` isUndefined ` | Checks if a value is ` undefined ` . |
119+ | [ ` isUrl ` ] ( src/base/isUrl.ts ) | Checks if a string is a valid URL. |
120+ | [ ` isValidLocale ` ] ( src/base/isValidLocale.ts ) | Checks if a string is a valid locale code. |
121+ | [ ` isValidSlug ` ] ( src/base/isValidSlug.ts ) | Checks if a string is a valid "slug" (URL-friendly string). |
122+ | [ ` isValidVersion ` ] ( src/base/isValidVersion.ts ) | Checks if a string is a valid version number (semantic versioning). |
123+ | [ ` isVersionCompatible ` ] ( src/base/isVersionCompatible.ts ) | Checks version compatibility. |
124+ | [ ` nonNil ` ] ( src/base/nonNil.ts ) | Returns the value if not ` null ` or ` undefined ` , otherwise throws an exception. |
125+ | [ ` nonNull ` ] ( src/base/nonNull.ts ) | Returns the value if not ` null ` , otherwise throws an exception. |
126+ | [ ` nonNumber ` ] ( src/base/nonNumber.ts ) | Returns the value if not a number, otherwise throws an exception. |
127+ | [ ` nonString ` ] ( src/base/nonString.ts ) | Returns the value if not a string, otherwise throws an exception. |
128+ | [ ` parseJson ` ] ( src/base/parseJson.ts ) | Safely parses a JSON string. |
129+ | [ ` requireNonEmptyString ` ] ( src/base/requireNonEmptyString.ts ) | Checks if a string is non-empty, otherwise throws an exception. |
130+ | [ ` requireNonNull ` ] ( src/base/requireNonNull.ts ) | Checks that a value is not ` null ` , otherwise throws an exception. |
131+ | [ ` requireString ` ] ( src/base/requireString.ts ) | Checks that a value is a string, otherwise throws an exception. |
132+ | [ ` requireValidEmail ` ] ( src/base/requireValidEmail.ts ) | Checks that a string is a valid email, otherwise throws an exception. |
133+ | [ ` stringifyJson ` ] ( src/base/stringifyJson.ts ) | Safely converts an object to a JSON string. |
134+ | [ ` toCamelCase ` ] ( src/base/toCamelCase.ts ) | Converts a string to camelCase. |
135+ | [ ` toInteger ` ] ( src/base/toInteger.ts ) | Converts a value to an integer. |
136+ | [ ` toKebabCase ` ] ( src/base/toKebabCase.ts ) | Converts a string to kebab-case. |
137+ | [ ` toLowerCase ` ] ( src/base/toLowerCase.ts ) | Converts a string to lowercase. |
138+ | [ ` toProperCase ` ] ( src/base/toProperCase.ts ) | Converts a string to Proper Case (first letter of each word capitalized). |
139+ | [ ` toSnakeCase ` ] ( src/base/toSnakeCase.ts ) | Converts a string to snake_case. |
140+ | [ ` toString ` ] ( src/base/toString.ts ) | Converts a value to a string. |
141+ | [ ` toUpperCase ` ] ( src/base/toUpperCase.ts ) | Converts a string to uppercase. |
142+ | [ ` transpose ` ] ( src/base/transpose.ts ) | Transposes a 2D array (matrix). |
143+ | [ ` versionCompare ` ] ( src/base/versionCompare.ts ) | Compares two versions. |
144144
145145</details >
146146
0 commit comments