es-toolkit 1.47.0-dev.1841 → 1.47.0-dev.1842

package/dist/compat/string/deburr.mjs

@@ -5,8 +5,8 @@ import { toString } from "../util/toString.mjs";
 * Converts a string by replacing special characters and diacritical marks with their ASCII equivalents.
 * For example, "Crème brûlée" becomes "Creme brulee".
 *
-* @param {string} str - The input string to be deburred.
-* @returns {string} - The deburred string with special characters replaced by their ASCII equivalents.
+* @param str - The input string to be deburred.
+* @returns The deburred string with special characters replaced by their ASCII equivalents.
 *
 * @example
 * // Basic usage:

package/dist/compat/string/endsWith.d.mts

@@ -4,10 +4,10 @@
  *
  * Checks if one string endsWith another string. Optional position parameter to offset searching before a certain index.
  *
- * @param {string} str - The string that might contain the target string.
- * @param {string} target - The string to search for.
- * @param {number} position - An optional position from the start to search up to this index
- * @returns {boolean} - True if the str string ends with the target string.
+ * @param str - The string that might contain the target string.
+ * @param target - The string to search for.
+ * @param position - An optional position from the start to search up to this index
+ * @returns True if the str string ends with the target string.
  *
  * @example
  * const isPrefix = endsWith('fooBar', 'foo') // returns true

package/dist/compat/string/endsWith.d.ts

@@ -4,10 +4,10 @@
  *
  * Checks if one string endsWith another string. Optional position parameter to offset searching before a certain index.
  *
- * @param {string} str - The string that might contain the target string.
- * @param {string} target - The string to search for.
- * @param {number} position - An optional position from the start to search up to this index
- * @returns {boolean} - True if the str string ends with the target string.
+ * @param str - The string that might contain the target string.
+ * @param target - The string to search for.
+ * @param position - An optional position from the start to search up to this index
+ * @returns True if the str string ends with the target string.
  *
  * @example
  * const isPrefix = endsWith('fooBar', 'foo') // returns true

package/dist/compat/string/endsWith.js

@@ -4,10 +4,10 @@
 *
 * Checks if one string endsWith another string. Optional position parameter to offset searching before a certain index.
 *
-* @param {string} str - The string that might contain the target string.
-* @param {string} target - The string to search for.
-* @param {number} position - An optional position from the start to search up to this index
-* @returns {boolean} - True if the str string ends with the target string.
+* @param str - The string that might contain the target string.
+* @param target - The string to search for.
+* @param position - An optional position from the start to search up to this index
+* @returns True if the str string ends with the target string.
 *
 * @example
 * const isPrefix = endsWith('fooBar', 'foo') // returns true

package/dist/compat/string/endsWith.mjs

@@ -4,10 +4,10 @@
 *
 * Checks if one string endsWith another string. Optional position parameter to offset searching before a certain index.
 *
-* @param {string} str - The string that might contain the target string.
-* @param {string} target - The string to search for.
-* @param {number} position - An optional position from the start to search up to this index
-* @returns {boolean} - True if the str string ends with the target string.
+* @param str - The string that might contain the target string.
+* @param target - The string to search for.
+* @param position - An optional position from the start to search up to this index
+* @returns True if the str string ends with the target string.
 *
 * @example
 * const isPrefix = endsWith('fooBar', 'foo') // returns true

package/dist/compat/string/escape.d.mts

@@ -3,8 +3,8 @@
  * Converts the characters "&", "<", ">", '"', and "'" in `str` to their corresponding HTML entities.
  * For example, "<" becomes "&lt;".
  *
- * @param {string} str  The string to escape.
- * @returns {string} Returns the escaped string.
+ * @param str  The string to escape.
+ * @returns Returns the escaped string.
  *
  * @example
  * escape('This is a <div> element.'); // returns 'This is a &lt;div&gt; element.'

package/dist/compat/string/escape.d.ts

@@ -3,8 +3,8 @@
  * Converts the characters "&", "<", ">", '"', and "'" in `str` to their corresponding HTML entities.
  * For example, "<" becomes "&lt;".
  *
- * @param {string} str  The string to escape.
- * @returns {string} Returns the escaped string.
+ * @param str  The string to escape.
+ * @returns Returns the escaped string.
  *
  * @example
  * escape('This is a <div> element.'); // returns 'This is a &lt;div&gt; element.'

package/dist/compat/string/escape.js

@@ -5,8 +5,8 @@ const require_toString = require("../util/toString.js");
 * Converts the characters "&", "<", ">", '"', and "'" in `str` to their corresponding HTML entities.
 * For example, "<" becomes "&lt;".
 *
-* @param {string} str  The string to escape.
-* @returns {string} Returns the escaped string.
+* @param str  The string to escape.
+* @returns Returns the escaped string.
 *
 * @example
 * escape('This is a <div> element.'); // returns 'This is a &lt;div&gt; element.'

package/dist/compat/string/escape.mjs

@@ -5,8 +5,8 @@ import { toString } from "../util/toString.mjs";
 * Converts the characters "&", "<", ">", '"', and "'" in `str` to their corresponding HTML entities.
 * For example, "<" becomes "&lt;".
 *
-* @param {string} str  The string to escape.
-* @returns {string} Returns the escaped string.
+* @param str  The string to escape.
+* @returns Returns the escaped string.
 *
 * @example
 * escape('This is a <div> element.'); // returns 'This is a &lt;div&gt; element.'

package/dist/compat/string/escapeRegExp.d.mts

@@ -2,8 +2,8 @@
 /**
  * Escapes the RegExp special characters "^", "$", "\\", ".", "*", "+", "?", "(", ")", "[", "]", "{", "}", and "|" in `str`.
  *
- * @param {string} str The string to escape.
- * @returns {string} Returns the escaped string.
+ * @param str The string to escape.
+ * @returns Returns the escaped string.
  *
  * @example
  * import { escapeRegExp } from 'es-toolkit/string';

package/dist/compat/string/escapeRegExp.d.ts

@@ -2,8 +2,8 @@
 /**
  * Escapes the RegExp special characters "^", "$", "\\", ".", "*", "+", "?", "(", ")", "[", "]", "{", "}", and "|" in `str`.
  *
- * @param {string} str The string to escape.
- * @returns {string} Returns the escaped string.
+ * @param str The string to escape.
+ * @returns Returns the escaped string.
  *
  * @example
  * import { escapeRegExp } from 'es-toolkit/string';

package/dist/compat/string/escapeRegExp.js

@@ -4,8 +4,8 @@ const require_toString = require("../util/toString.js");
 /**
 * Escapes the RegExp special characters "^", "$", "\\", ".", "*", "+", "?", "(", ")", "[", "]", "{", "}", and "|" in `str`.
 *
-* @param {string} str The string to escape.
-* @returns {string} Returns the escaped string.
+* @param str The string to escape.
+* @returns Returns the escaped string.
 *
 * @example
 * import { escapeRegExp } from 'es-toolkit/string';

package/dist/compat/string/escapeRegExp.mjs

@@ -4,8 +4,8 @@ import { toString } from "../util/toString.mjs";
 /**
 * Escapes the RegExp special characters "^", "$", "\\", ".", "*", "+", "?", "(", ")", "[", "]", "{", "}", and "|" in `str`.
 *
-* @param {string} str The string to escape.
-* @returns {string} Returns the escaped string.
+* @param str The string to escape.
+* @returns Returns the escaped string.
 *
 * @example
 * import { escapeRegExp } from 'es-toolkit/string';

package/dist/compat/string/kebabCase.d.mts

@@ -4,8 +4,8 @@
  *
  * Kebab case is the naming convention in which each word is written in lowercase and separated by a dash (-) character.
  *
- * @param {string | object} str - The string that is to be changed to kebab case.
- * @returns {string} - The converted string to kebab case.
+ * @param str - The string that is to be changed to kebab case.
+ * @returns The converted string to kebab case.
  *
  * @example
  * const convertedStr1 = kebabCase('camelCase') // returns 'camel-case'

package/dist/compat/string/kebabCase.d.ts

@@ -4,8 +4,8 @@
  *
  * Kebab case is the naming convention in which each word is written in lowercase and separated by a dash (-) character.
  *
- * @param {string | object} str - The string that is to be changed to kebab case.
- * @returns {string} - The converted string to kebab case.
+ * @param str - The string that is to be changed to kebab case.
+ * @returns The converted string to kebab case.
  *
  * @example
  * const convertedStr1 = kebabCase('camelCase') // returns 'camel-case'

package/dist/compat/string/kebabCase.js

@@ -7,8 +7,8 @@ const require_normalizeForCase = require("../_internal/normalizeForCase.js");
 *
 * Kebab case is the naming convention in which each word is written in lowercase and separated by a dash (-) character.
 *
-* @param {string | object} str - The string that is to be changed to kebab case.
-* @returns {string} - The converted string to kebab case.
+* @param str - The string that is to be changed to kebab case.
+* @returns The converted string to kebab case.
 *
 * @example
 * const convertedStr1 = kebabCase('camelCase') // returns 'camel-case'

package/dist/compat/string/kebabCase.mjs

@@ -7,8 +7,8 @@ import { normalizeForCase } from "../_internal/normalizeForCase.mjs";
 *
 * Kebab case is the naming convention in which each word is written in lowercase and separated by a dash (-) character.
 *
-* @param {string | object} str - The string that is to be changed to kebab case.
-* @returns {string} - The converted string to kebab case.
+* @param str - The string that is to be changed to kebab case.
+* @returns The converted string to kebab case.
 *
 * @example
 * const convertedStr1 = kebabCase('camelCase') // returns 'camel-case'

package/dist/compat/string/lowerCase.d.mts

@@ -4,8 +4,8 @@
  *
  * Lower case is the naming convention in which each word is written in lowercase and separated by an space ( ) character.
  *
- * @param {string | object} str - The string that is to be changed to lower case.
- * @returns {string} - The converted string to lower case.
+ * @param str - The string that is to be changed to lower case.
+ * @returns The converted string to lower case.
  *
  * @example
  * const convertedStr1 = lowerCase('camelCase') // returns 'camel case'

package/dist/compat/string/lowerCase.d.ts

@@ -4,8 +4,8 @@
  *
  * Lower case is the naming convention in which each word is written in lowercase and separated by an space ( ) character.
  *
- * @param {string | object} str - The string that is to be changed to lower case.
- * @returns {string} - The converted string to lower case.
+ * @param str - The string that is to be changed to lower case.
+ * @returns The converted string to lower case.
  *
  * @example
  * const convertedStr1 = lowerCase('camelCase') // returns 'camel case'

package/dist/compat/string/lowerCase.js

@@ -7,8 +7,8 @@ const require_normalizeForCase = require("../_internal/normalizeForCase.js");
 *
 * Lower case is the naming convention in which each word is written in lowercase and separated by an space ( ) character.
 *
-* @param {string | object} str - The string that is to be changed to lower case.
-* @returns {string} - The converted string to lower case.
+* @param str - The string that is to be changed to lower case.
+* @returns The converted string to lower case.
 *
 * @example
 * const convertedStr1 = lowerCase('camelCase') // returns 'camel case'

package/dist/compat/string/lowerCase.mjs

@@ -7,8 +7,8 @@ import { normalizeForCase } from "../_internal/normalizeForCase.mjs";
 *
 * Lower case is the naming convention in which each word is written in lowercase and separated by an space ( ) character.
 *
-* @param {string | object} str - The string that is to be changed to lower case.
-* @returns {string} - The converted string to lower case.
+* @param str - The string that is to be changed to lower case.
+* @returns The converted string to lower case.
 *
 * @example
 * const convertedStr1 = lowerCase('camelCase') // returns 'camel case'

package/dist/compat/string/lowerFirst.d.mts

@@ -2,8 +2,8 @@
 /**
  * Converts the first character of string to lower case.
  *
- * @param {string} str - The string that is to be changed
- * @returns {string} - The converted string.
+ * @param str - The string that is to be changed
+ * @returns The converted string.
  *
  * @example
  * const convertedStr1 = lowerCase('fred') // returns 'fred'

package/dist/compat/string/lowerFirst.d.ts

@@ -2,8 +2,8 @@
 /**
  * Converts the first character of string to lower case.
  *
- * @param {string} str - The string that is to be changed
- * @returns {string} - The converted string.
+ * @param str - The string that is to be changed
+ * @returns The converted string.
  *
  * @example
  * const convertedStr1 = lowerCase('fred') // returns 'fred'

package/dist/compat/string/lowerFirst.js

@@ -4,8 +4,8 @@ const require_toString = require("../util/toString.js");
 /**
 * Converts the first character of string to lower case.
 *
-* @param {string} str - The string that is to be changed
-* @returns {string} - The converted string.
+* @param str - The string that is to be changed
+* @returns The converted string.
 *
 * @example
 * const convertedStr1 = lowerCase('fred') // returns 'fred'

package/dist/compat/string/lowerFirst.mjs

@@ -4,8 +4,8 @@ import { toString } from "../util/toString.mjs";
 /**
 * Converts the first character of string to lower case.
 *
-* @param {string} str - The string that is to be changed
-* @returns {string} - The converted string.
+* @param str - The string that is to be changed
+* @returns The converted string.
 *
 * @example
 * const convertedStr1 = lowerCase('fred') // returns 'fred'

package/dist/compat/string/pad.d.mts

@@ -3,10 +3,10 @@
  * Pads string on the left and right sides if it's shorter than length. Padding characters are truncated if they can't be evenly divided by length.
  * If the length is less than or equal to the original string's length, or if the padding character is an empty string, the original string is returned unchanged.
  *
- * @param {string} str - The string to pad.
- * @param {number} [length] - The length of the resulting string once padded.
- * @param {string} [chars] - The character(s) to use for padding.
- * @returns {string} - The padded string, or the original string if padding is not required.
+ * @param str - The string to pad.
+ * @param [length] - The length of the resulting string once padded.
+ * @param [chars] - The character(s) to use for padding.
+ * @returns The padded string, or the original string if padding is not required.
  *
  * @example
  * const result1 = pad('abc', 8);         // result will be '  abc   '

package/dist/compat/string/pad.d.ts

@@ -3,10 +3,10 @@
  * Pads string on the left and right sides if it's shorter than length. Padding characters are truncated if they can't be evenly divided by length.
  * If the length is less than or equal to the original string's length, or if the padding character is an empty string, the original string is returned unchanged.
  *
- * @param {string} str - The string to pad.
- * @param {number} [length] - The length of the resulting string once padded.
- * @param {string} [chars] - The character(s) to use for padding.
- * @returns {string} - The padded string, or the original string if padding is not required.
+ * @param str - The string to pad.
+ * @param [length] - The length of the resulting string once padded.
+ * @param [chars] - The character(s) to use for padding.
+ * @returns The padded string, or the original string if padding is not required.
  *
  * @example
  * const result1 = pad('abc', 8);         // result will be '  abc   '

package/dist/compat/string/pad.js

@@ -5,10 +5,10 @@ const require_toString = require("../util/toString.js");
 * Pads string on the left and right sides if it's shorter than length. Padding characters are truncated if they can't be evenly divided by length.
 * If the length is less than or equal to the original string's length, or if the padding character is an empty string, the original string is returned unchanged.
 *
-* @param {string} str - The string to pad.
-* @param {number} [length] - The length of the resulting string once padded.
-* @param {string} [chars] - The character(s) to use for padding.
-* @returns {string} - The padded string, or the original string if padding is not required.
+* @param str - The string to pad.
+* @param [length] - The length of the resulting string once padded.
+* @param [chars] - The character(s) to use for padding.
+* @returns The padded string, or the original string if padding is not required.
 *
 * @example
 * const result1 = pad('abc', 8);         // result will be '  abc   '

package/dist/compat/string/pad.mjs

@@ -5,10 +5,10 @@ import { toString } from "../util/toString.mjs";
 * Pads string on the left and right sides if it's shorter than length. Padding characters are truncated if they can't be evenly divided by length.
 * If the length is less than or equal to the original string's length, or if the padding character is an empty string, the original string is returned unchanged.
 *
-* @param {string} str - The string to pad.
-* @param {number} [length] - The length of the resulting string once padded.
-* @param {string} [chars] - The character(s) to use for padding.
-* @returns {string} - The padded string, or the original string if padding is not required.
+* @param str - The string to pad.
+* @param [length] - The length of the resulting string once padded.
+* @param [chars] - The character(s) to use for padding.
+* @returns The padded string, or the original string if padding is not required.
 *
 * @example
 * const result1 = pad('abc', 8);         // result will be '  abc   '

package/dist/compat/string/padEnd.d.mts

@@ -5,10 +5,10 @@
  * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
  * the original string is returned unchanged.
  *
- * @param {string} str - The string to pad.
- * @param {number} [length] - The length of the resulting string once padded.
- * @param {string} [chars] - The character(s) to use for padding.
- * @returns {string} - The padded string, or the original string if padding is not required.
+ * @param str - The string to pad.
+ * @param [length] - The length of the resulting string once padded.
+ * @param [chars] - The character(s) to use for padding.
+ * @returns The padded string, or the original string if padding is not required.
  *
  * @example
  * const result1 = padEnd('abc', 6);          // result will be 'abc   '

package/dist/compat/string/padEnd.d.ts

@@ -5,10 +5,10 @@
  * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
  * the original string is returned unchanged.
  *
- * @param {string} str - The string to pad.
- * @param {number} [length] - The length of the resulting string once padded.
- * @param {string} [chars] - The character(s) to use for padding.
- * @returns {string} - The padded string, or the original string if padding is not required.
+ * @param str - The string to pad.
+ * @param [length] - The length of the resulting string once padded.
+ * @param [chars] - The character(s) to use for padding.
+ * @returns The padded string, or the original string if padding is not required.
  *
  * @example
  * const result1 = padEnd('abc', 6);          // result will be 'abc   '

package/dist/compat/string/padEnd.js

@@ -6,10 +6,10 @@ const require_toString = require("../util/toString.js");
 * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
 * the original string is returned unchanged.
 *
-* @param {string} str - The string to pad.
-* @param {number} [length] - The length of the resulting string once padded.
-* @param {string} [chars] - The character(s) to use for padding.
-* @returns {string} - The padded string, or the original string if padding is not required.
+* @param str - The string to pad.
+* @param [length] - The length of the resulting string once padded.
+* @param [chars] - The character(s) to use for padding.
+* @returns The padded string, or the original string if padding is not required.
 *
 * @example
 * const result1 = padEnd('abc', 6);          // result will be 'abc   '

package/dist/compat/string/padEnd.mjs

@@ -6,10 +6,10 @@ import { toString } from "../util/toString.mjs";
 * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
 * the original string is returned unchanged.
 *
-* @param {string} str - The string to pad.
-* @param {number} [length] - The length of the resulting string once padded.
-* @param {string} [chars] - The character(s) to use for padding.
-* @returns {string} - The padded string, or the original string if padding is not required.
+* @param str - The string to pad.
+* @param [length] - The length of the resulting string once padded.
+* @param [chars] - The character(s) to use for padding.
+* @returns The padded string, or the original string if padding is not required.
 *
 * @example
 * const result1 = padEnd('abc', 6);          // result will be 'abc   '

package/dist/compat/string/padStart.d.mts

@@ -5,10 +5,10 @@
  * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
  * the original string is returned unchanged.
  *
- * @param {string} str - The string to pad.
- * @param {number} [length] - The length of the resulting string once padded.
- * @param {string} [chars] - The character(s) to use for padding.
- * @returns {string} - The padded string, or the original string if padding is not required.
+ * @param str - The string to pad.
+ * @param [length] - The length of the resulting string once padded.
+ * @param [chars] - The character(s) to use for padding.
+ * @returns The padded string, or the original string if padding is not required.
  *
  * @example
  * const result1 = padStart('abc', 6);          // result will be '   abc'

package/dist/compat/string/padStart.d.ts

@@ -5,10 +5,10 @@
  * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
  * the original string is returned unchanged.
  *
- * @param {string} str - The string to pad.
- * @param {number} [length] - The length of the resulting string once padded.
- * @param {string} [chars] - The character(s) to use for padding.
- * @returns {string} - The padded string, or the original string if padding is not required.
+ * @param str - The string to pad.
+ * @param [length] - The length of the resulting string once padded.
+ * @param [chars] - The character(s) to use for padding.
+ * @returns The padded string, or the original string if padding is not required.
  *
  * @example
  * const result1 = padStart('abc', 6);          // result will be '   abc'

package/dist/compat/string/padStart.js

@@ -6,10 +6,10 @@ const require_toString = require("../util/toString.js");
 * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
 * the original string is returned unchanged.
 *
-* @param {string} str - The string to pad.
-* @param {number} [length] - The length of the resulting string once padded.
-* @param {string} [chars] - The character(s) to use for padding.
-* @returns {string} - The padded string, or the original string if padding is not required.
+* @param str - The string to pad.
+* @param [length] - The length of the resulting string once padded.
+* @param [chars] - The character(s) to use for padding.
+* @returns The padded string, or the original string if padding is not required.
 *
 * @example
 * const result1 = padStart('abc', 6);          // result will be '   abc'

package/dist/compat/string/padStart.mjs

@@ -6,10 +6,10 @@ import { toString } from "../util/toString.mjs";
 * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
 * the original string is returned unchanged.
 *
-* @param {string} str - The string to pad.
-* @param {number} [length] - The length of the resulting string once padded.
-* @param {string} [chars] - The character(s) to use for padding.
-* @returns {string} - The padded string, or the original string if padding is not required.
+* @param str - The string to pad.
+* @param [length] - The length of the resulting string once padded.
+* @param [chars] - The character(s) to use for padding.
+* @returns The padded string, or the original string if padding is not required.
 *
 * @example
 * const result1 = padStart('abc', 6);          // result will be '   abc'

package/dist/compat/string/repeat.d.mts

@@ -5,9 +5,9 @@
  * If n is less than 1, an empty string is returned, or if the string is an empty string,
  * the original string is returned unchanged.
  *
- * @param {string} str - The string to repeat.
- * @param {number} n - The number of times to repeat the string.
- * @returns {string} - The repeated string, or an empty string if n is less than 1.
+ * @param str - The string to repeat.
+ * @param n - The number of times to repeat the string.
+ * @returns The repeated string, or an empty string if n is less than 1.
  *
  * @example
  * repeat('abc', 0); // ''

package/dist/compat/string/repeat.d.ts

@@ -5,9 +5,9 @@
  * If n is less than 1, an empty string is returned, or if the string is an empty string,
  * the original string is returned unchanged.
  *
- * @param {string} str - The string to repeat.
- * @param {number} n - The number of times to repeat the string.
- * @returns {string} - The repeated string, or an empty string if n is less than 1.
+ * @param str - The string to repeat.
+ * @param n - The number of times to repeat the string.
+ * @returns The repeated string, or an empty string if n is less than 1.
  *
  * @example
  * repeat('abc', 0); // ''

package/dist/compat/string/repeat.js

@@ -9,9 +9,9 @@ const require_MAX_SAFE_INTEGER = require("../_internal/MAX_SAFE_INTEGER.js");
 * If n is less than 1, an empty string is returned, or if the string is an empty string,
 * the original string is returned unchanged.
 *
-* @param {string} str - The string to repeat.
-* @param {number} n - The number of times to repeat the string.
-* @returns {string} - The repeated string, or an empty string if n is less than 1.
+* @param str - The string to repeat.
+* @param n - The number of times to repeat the string.
+* @returns The repeated string, or an empty string if n is less than 1.
 *
 * @example
 * repeat('abc', 0); // ''

package/dist/compat/string/repeat.mjs

@@ -9,9 +9,9 @@ import { MAX_SAFE_INTEGER } from "../_internal/MAX_SAFE_INTEGER.mjs";
 * If n is less than 1, an empty string is returned, or if the string is an empty string,
 * the original string is returned unchanged.
 *
-* @param {string} str - The string to repeat.
-* @param {number} n - The number of times to repeat the string.
-* @returns {string} - The repeated string, or an empty string if n is less than 1.
+* @param str - The string to repeat.
+* @param n - The number of times to repeat the string.
+* @returns The repeated string, or an empty string if n is less than 1.
 *
 * @example
 * repeat('abc', 0); // ''

package/dist/compat/string/replace.js

@@ -6,7 +6,7 @@ const require_toString = require("../util/toString.js");
 * @param {} target - The target string.
 * @param {} pattern - The pattern to match.
 * @param {} replacement - The replacement string or a function that returns the replacement string.
-* @returns {string} The new string with the matched pattern replaced.
+* @returns The new string with the matched pattern replaced.
 *
 * @example
 * replace('abcde', 'de', '123'); // 'abc123'

package/dist/compat/string/replace.mjs

@@ -6,7 +6,7 @@ import { toString } from "../util/toString.mjs";
 * @param {} target - The target string.
 * @param {} pattern - The pattern to match.
 * @param {} replacement - The replacement string or a function that returns the replacement string.
-* @returns {string} The new string with the matched pattern replaced.
+* @returns The new string with the matched pattern replaced.
 *
 * @example
 * replace('abcde', 'de', '123'); // 'abc123'

package/dist/compat/string/snakeCase.d.mts

@@ -4,8 +4,8 @@
  *
  * Snake case is the naming convention in which each word is written in lowercase and separated by an underscore (_) character.
  *
- * @param {string | object} str - The string that is to be changed to snake case.
- * @returns {string} - The converted string to snake case.
+ * @param str - The string that is to be changed to snake case.
+ * @returns The converted string to snake case.
  *
  * @example
  * const convertedStr1 = snakeCase('camelCase') // returns 'camel_case'

package/dist/compat/string/snakeCase.d.ts

@@ -4,8 +4,8 @@
  *
  * Snake case is the naming convention in which each word is written in lowercase and separated by an underscore (_) character.
  *
- * @param {string | object} str - The string that is to be changed to snake case.
- * @returns {string} - The converted string to snake case.
+ * @param str - The string that is to be changed to snake case.
+ * @returns The converted string to snake case.
  *
  * @example
  * const convertedStr1 = snakeCase('camelCase') // returns 'camel_case'