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

package/dist/compat/string/snakeCase.js

@@ -7,8 +7,8 @@ const require_normalizeForCase = require("../_internal/normalizeForCase.js");
 *
 * 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.mjs

@@ -7,8 +7,8 @@ import { normalizeForCase } from "../_internal/normalizeForCase.mjs";
 *
 * 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/split.d.mts

@@ -3,10 +3,10 @@
  * Splits the input string by the specified `separator`
  * and returns a new array containing the split segments.
  *
- * @param {string | null | undefined} [string=''] The string to split.
- * @param {RegExp|string} [separator] The separator pattern to split by.
- * @param {number} [limit] The length to truncate results to.
- * @returns {Array} Returns the string segments.
+ * @param [string=''] The string to split.
+ * @param [separator] The separator pattern to split by.
+ * @param [limit] The length to truncate results to.
+ * @returns Returns the string segments.
  *
  * @example
  * split('a-b-c', '-');
@@ -20,10 +20,10 @@ declare function split(string: string | null | undefined, separator?: RegExp | s
  * Splits the input string by the specified `separator`
  * and returns a new array containing the split segments.
  *
- * @param {string | null | undefined} [string=''] The string to split.
- * @param {RegExp|string} [separator] The separator pattern to split by.
- * @param {number} [limit] The length to truncate results to.
- * @returns {Array} Returns the string segments.
+ * @param [string=''] The string to split.
+ * @param [separator] The separator pattern to split by.
+ * @param [limit] The length to truncate results to.
+ * @returns Returns the string segments.
  *
  * @example
  * split('a-b-c', '-');

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

@@ -3,10 +3,10 @@
  * Splits the input string by the specified `separator`
  * and returns a new array containing the split segments.
  *
- * @param {string | null | undefined} [string=''] The string to split.
- * @param {RegExp|string} [separator] The separator pattern to split by.
- * @param {number} [limit] The length to truncate results to.
- * @returns {Array} Returns the string segments.
+ * @param [string=''] The string to split.
+ * @param [separator] The separator pattern to split by.
+ * @param [limit] The length to truncate results to.
+ * @returns Returns the string segments.
  *
  * @example
  * split('a-b-c', '-');
@@ -20,10 +20,10 @@ declare function split(string: string | null | undefined, separator?: RegExp | s
  * Splits the input string by the specified `separator`
  * and returns a new array containing the split segments.
  *
- * @param {string | null | undefined} [string=''] The string to split.
- * @param {RegExp|string} [separator] The separator pattern to split by.
- * @param {number} [limit] The length to truncate results to.
- * @returns {Array} Returns the string segments.
+ * @param [string=''] The string to split.
+ * @param [separator] The separator pattern to split by.
+ * @param [limit] The length to truncate results to.
+ * @returns Returns the string segments.
  *
  * @example
  * split('a-b-c', '-');

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

@@ -3,8 +3,8 @@
  * Converts the first character of each word in a string to uppercase and the remaining characters to lowercase.
  *
  * Start case is the naming convention in which each word is written with an initial capital letter.
- * @param {string | object} str - The string to convert.
- * @returns {string} The converted string.
+ * @param str - The string to convert.
+ * @returns The converted string.
  *
  * @example
  * const result1 = startCase('hello world');  // result will be 'Hello World'

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

@@ -3,8 +3,8 @@
  * Converts the first character of each word in a string to uppercase and the remaining characters to lowercase.
  *
  * Start case is the naming convention in which each word is written with an initial capital letter.
- * @param {string | object} str - The string to convert.
- * @returns {string} The converted string.
+ * @param str - The string to convert.
+ * @returns The converted string.
  *
  * @example
  * const result1 = startCase('hello world');  // result will be 'Hello World'

package/dist/compat/string/startCase.js

@@ -6,8 +6,8 @@ const require_normalizeForCase = require("../_internal/normalizeForCase.js");
 * Converts the first character of each word in a string to uppercase and the remaining characters to lowercase.
 *
 * Start case is the naming convention in which each word is written with an initial capital letter.
-* @param {string | object} str - The string to convert.
-* @returns {string} The converted string.
+* @param str - The string to convert.
+* @returns The converted string.
 *
 * @example
 * const result1 = startCase('hello world');  // result will be 'Hello World'

package/dist/compat/string/startCase.mjs

@@ -6,8 +6,8 @@ import { normalizeForCase } from "../_internal/normalizeForCase.mjs";
 * Converts the first character of each word in a string to uppercase and the remaining characters to lowercase.
 *
 * Start case is the naming convention in which each word is written with an initial capital letter.
-* @param {string | object} str - The string to convert.
-* @returns {string} The converted string.
+* @param str - The string to convert.
+* @returns The converted string.
 *
 * @example
 * const result1 = startCase('hello world');  // result will be 'Hello World'

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

@@ -4,10 +4,10 @@
  *
  * Checks if one string startsWith another string. Optional position parameter to start searching from 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 offset to start searching in the str string
- * @returns {boolean} - True if the str string starts 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 offset to start searching in the str string
+ * @returns True if the str string starts with the target string.
  *
  * @example
  * const isPrefix = startsWith('fooBar', 'foo') // returns true

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

@@ -4,10 +4,10 @@
  *
  * Checks if one string startsWith another string. Optional position parameter to start searching from 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 offset to start searching in the str string
- * @returns {boolean} - True if the str string starts 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 offset to start searching in the str string
+ * @returns True if the str string starts with the target string.
  *
  * @example
  * const isPrefix = startsWith('fooBar', 'foo') // returns true

package/dist/compat/string/startsWith.js

@@ -4,10 +4,10 @@
 *
 * Checks if one string startsWith another string. Optional position parameter to start searching from 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 offset to start searching in the str string
-* @returns {boolean} - True if the str string starts 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 offset to start searching in the str string
+* @returns True if the str string starts with the target string.
 *
 * @example
 * const isPrefix = startsWith('fooBar', 'foo') // returns true

package/dist/compat/string/startsWith.mjs

@@ -4,10 +4,10 @@
 *
 * Checks if one string startsWith another string. Optional position parameter to start searching from 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 offset to start searching in the str string
-* @returns {boolean} - True if the str string starts 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 offset to start searching in the str string
+* @returns True if the str string starts with the target string.
 *
 * @example
 * const isPrefix = startsWith('fooBar', 'foo') // returns true

package/dist/compat/string/template.js

@@ -35,16 +35,16 @@ const templateSettings = {
 * evaluating, and interpolating values. It can also handle custom variable names and
 * imported functions.
 *
-* @param {string} string - The template string.
-* @param {TemplateOptions} [options] - The options object.
-* @param {RegExp | null | undefined} [options.escape] - The regular expression for "escape" delimiter.
-* @param {RegExp | null | undefined} [options.evaluate] - The regular expression for "evaluate" delimiter.
-* @param {RegExp | null | undefined} [options.interpolate] - The regular expression for "interpolate" delimiter.
-* @param {string | undefined} [options.variable] - The data object variable name.
-* @param {Record<string, any> | undefined} [options.imports] - The object of imported functions.
-* @param {string | undefined} [options.sourceURL] - The source URL of the template.
-* @param {object} [guard] - The guard to detect if the function is called with `options`.
-* @returns {TemplateExecutor} Returns the compiled template function.
+* @param string - The template string.
+* @param [options] - The options object.
+* @param [options.escape] - The regular expression for "escape" delimiter.
+* @param [options.evaluate] - The regular expression for "evaluate" delimiter.
+* @param [options.interpolate] - The regular expression for "interpolate" delimiter.
+* @param [options.variable] - The data object variable name.
+* @param [options.imports] - The object of imported functions.
+* @param [options.sourceURL] - The source URL of the template.
+* @param [guard] - The guard to detect if the function is called with `options`.
+* @returns Returns the compiled template function.
 *
 * @example
 * // Use the "escape" delimiter to escape data properties.

package/dist/compat/string/template.mjs

@@ -35,16 +35,16 @@ const templateSettings = {
 * evaluating, and interpolating values. It can also handle custom variable names and
 * imported functions.
 *
-* @param {string} string - The template string.
-* @param {TemplateOptions} [options] - The options object.
-* @param {RegExp | null | undefined} [options.escape] - The regular expression for "escape" delimiter.
-* @param {RegExp | null | undefined} [options.evaluate] - The regular expression for "evaluate" delimiter.
-* @param {RegExp | null | undefined} [options.interpolate] - The regular expression for "interpolate" delimiter.
-* @param {string | undefined} [options.variable] - The data object variable name.
-* @param {Record<string, any> | undefined} [options.imports] - The object of imported functions.
-* @param {string | undefined} [options.sourceURL] - The source URL of the template.
-* @param {object} [guard] - The guard to detect if the function is called with `options`.
-* @returns {TemplateExecutor} Returns the compiled template function.
+* @param string - The template string.
+* @param [options] - The options object.
+* @param [options.escape] - The regular expression for "escape" delimiter.
+* @param [options.evaluate] - The regular expression for "evaluate" delimiter.
+* @param [options.interpolate] - The regular expression for "interpolate" delimiter.
+* @param [options.variable] - The data object variable name.
+* @param [options.imports] - The object of imported functions.
+* @param [options.sourceURL] - The source URL of the template.
+* @param [guard] - The guard to detect if the function is called with `options`.
+* @returns Returns the compiled template function.
 *
 * @example
 * // Use the "escape" delimiter to escape data properties.

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

@@ -3,8 +3,8 @@
  * Converts the given value to a string and transforms it to lower case.
  * The function can handle various input types by first converting them to strings.
  *
- * @param {unknown} [value=''] The value to convert.
- * @returns {string} Returns the lower cased string.
+ * @param [value=''] The value to convert.
+ * @returns Returns the lower cased string.
  * @example
  *
  * toLower('--FOO-BAR--');

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

@@ -3,8 +3,8 @@
  * Converts the given value to a string and transforms it to lower case.
  * The function can handle various input types by first converting them to strings.
  *
- * @param {unknown} [value=''] The value to convert.
- * @returns {string} Returns the lower cased string.
+ * @param [value=''] The value to convert.
+ * @returns Returns the lower cased string.
  * @example
  *
  * toLower('--FOO-BAR--');

package/dist/compat/string/toLower.js

@@ -4,8 +4,8 @@ const require_toString = require("../util/toString.js");
 * Converts the given value to a string and transforms it to lower case.
 * The function can handle various input types by first converting them to strings.
 *
-* @param {unknown} [value=''] The value to convert.
-* @returns {string} Returns the lower cased string.
+* @param [value=''] The value to convert.
+* @returns Returns the lower cased string.
 * @example
 *
 * toLower('--FOO-BAR--');

package/dist/compat/string/toLower.mjs

@@ -4,8 +4,8 @@ import { toString } from "../util/toString.mjs";
 * Converts the given value to a string and transforms it to lower case.
 * The function can handle various input types by first converting them to strings.
 *
-* @param {unknown} [value=''] The value to convert.
-* @returns {string} Returns the lower cased string.
+* @param [value=''] The value to convert.
+* @returns Returns the lower cased string.
 * @example
 *
 * toLower('--FOO-BAR--');

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

@@ -3,8 +3,8 @@
  * Converts `string`, as a whole, to upper case just like
  * [String#toUpperCase](https://mdn.io/toUpperCase).
  *
- * @param {unknown} [value=''] The value to convert.
- * @returns {string} Returns the upper cased string.
+ * @param [value=''] The value to convert.
+ * @returns Returns the upper cased string.
  * @example
  *
  * toUpper('--foo-bar--');

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

@@ -3,8 +3,8 @@
  * Converts `string`, as a whole, to upper case just like
  * [String#toUpperCase](https://mdn.io/toUpperCase).
  *
- * @param {unknown} [value=''] The value to convert.
- * @returns {string} Returns the upper cased string.
+ * @param [value=''] The value to convert.
+ * @returns Returns the upper cased string.
  * @example
  *
  * toUpper('--foo-bar--');

package/dist/compat/string/toUpper.js

@@ -4,8 +4,8 @@ const require_toString = require("../util/toString.js");
 * Converts `string`, as a whole, to upper case just like
 * [String#toUpperCase](https://mdn.io/toUpperCase).
 *
-* @param {unknown} [value=''] The value to convert.
-* @returns {string} Returns the upper cased string.
+* @param [value=''] The value to convert.
+* @returns Returns the upper cased string.
 * @example
 *
 * toUpper('--foo-bar--');

package/dist/compat/string/toUpper.mjs

@@ -4,8 +4,8 @@ import { toString } from "../util/toString.mjs";
 * Converts `string`, as a whole, to upper case just like
 * [String#toUpperCase](https://mdn.io/toUpperCase).
 *
-* @param {unknown} [value=''] The value to convert.
-* @returns {string} Returns the upper cased string.
+* @param [value=''] The value to convert.
+* @returns Returns the upper cased string.
 * @example
 *
 * toUpper('--foo-bar--');

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

@@ -2,9 +2,9 @@
 /**
  * Removes leading and trailing whitespace or specified characters from a string.
  *
- * @param {string} str - The string from which leading and trailing characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @returns {string} - The resulting string after the specified leading and trailing characters have been removed.
+ * @param str - The string from which leading and trailing characters will be trimmed.
+ * @param chars - The character(s) to remove from the end of the string. Defaults to `" "`.
+ * @returns The resulting string after the specified leading and trailing characters have been removed.
  *
  * @example
  * trim("  hello  "); // "hello"
@@ -15,9 +15,9 @@ declare function trim(string?: string, chars?: string): string;
 /**
  * Removes leading and trailing whitespace or specified characters from a string.
  *
- * @param {string} str - The string from which leading and trailing characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @returns {string} - The resulting string after the specified leading and trailing characters have been removed.
+ * @param str - The string from which leading and trailing characters will be trimmed.
+ * @param chars - The character(s) to remove from the end of the string. Defaults to `" "`.
+ * @returns The resulting string after the specified leading and trailing characters have been removed.
  *
  * @example
  * trim("  hello  "); // "hello"

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

@@ -2,9 +2,9 @@
 /**
  * Removes leading and trailing whitespace or specified characters from a string.
  *
- * @param {string} str - The string from which leading and trailing characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @returns {string} - The resulting string after the specified leading and trailing characters have been removed.
+ * @param str - The string from which leading and trailing characters will be trimmed.
+ * @param chars - The character(s) to remove from the end of the string. Defaults to `" "`.
+ * @returns The resulting string after the specified leading and trailing characters have been removed.
  *
  * @example
  * trim("  hello  "); // "hello"
@@ -15,9 +15,9 @@ declare function trim(string?: string, chars?: string): string;
 /**
  * Removes leading and trailing whitespace or specified characters from a string.
  *
- * @param {string} str - The string from which leading and trailing characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @returns {string} - The resulting string after the specified leading and trailing characters have been removed.
+ * @param str - The string from which leading and trailing characters will be trimmed.
+ * @param chars - The character(s) to remove from the end of the string. Defaults to `" "`.
+ * @returns The resulting string after the specified leading and trailing characters have been removed.
  *
  * @example
  * trim("  hello  "); // "hello"

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

@@ -2,9 +2,9 @@
 /**
  * Removes trailing whitespace or specified characters from a string.
  *
- * @param {string} string - The string to trim.
- * @param {string} chars - The characters to trim from the end of the string.
- * @returns {string} Returns the trimmed string.
+ * @param string - The string to trim.
+ * @param chars - The characters to trim from the end of the string.
+ * @returns Returns the trimmed string.
  *
  * @example
  * trimEnd('  abc  ');
@@ -17,10 +17,10 @@ declare function trimEnd(string?: string, chars?: string): string;
 /**
  * Removes trailing whitespace or specified characters from a string.
  *
- * @param {string} string - The string to trim.
- * @param {string | number} index - The index parameter (used with guard).
- * @param {object} guard - Enables use as an iteratee for methods like `map`.
- * @returns {string} Returns the trimmed string.
+ * @param string - The string to trim.
+ * @param index - The index parameter (used with guard).
+ * @param guard - Enables use as an iteratee for methods like `map`.
+ * @returns Returns the trimmed string.
  *
  * @example
  * trimEnd('  abc  ', 0, {});

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

@@ -2,9 +2,9 @@
 /**
  * Removes trailing whitespace or specified characters from a string.
  *
- * @param {string} string - The string to trim.
- * @param {string} chars - The characters to trim from the end of the string.
- * @returns {string} Returns the trimmed string.
+ * @param string - The string to trim.
+ * @param chars - The characters to trim from the end of the string.
+ * @returns Returns the trimmed string.
  *
  * @example
  * trimEnd('  abc  ');
@@ -17,10 +17,10 @@ declare function trimEnd(string?: string, chars?: string): string;
 /**
  * Removes trailing whitespace or specified characters from a string.
  *
- * @param {string} string - The string to trim.
- * @param {string | number} index - The index parameter (used with guard).
- * @param {object} guard - Enables use as an iteratee for methods like `map`.
- * @returns {string} Returns the trimmed string.
+ * @param string - The string to trim.
+ * @param index - The index parameter (used with guard).
+ * @param guard - Enables use as an iteratee for methods like `map`.
+ * @returns Returns the trimmed string.
  *
  * @example
  * trimEnd('  abc  ', 0, {});

package/dist/compat/string/trimEnd.js

@@ -3,10 +3,10 @@ const require_trimEnd = require("../../string/trimEnd.js");
 /**
 * Removes trailing whitespace or specified characters from a string.
 *
-* @param {string} str - The string from which trailing characters will be trimmed.
-* @param {string | number} chars - The character(s) to remove from the end of the string.
-* @param {object} guard - Enables use as an iteratee for methods like `map`.
-* @returns {string} Returns the trimmed string.
+* @param str - The string from which trailing characters will be trimmed.
+* @param chars - The character(s) to remove from the end of the string.
+* @param guard - Enables use as an iteratee for methods like `map`.
+* @returns Returns the trimmed string.
 *
 * @example
 * trimEnd('  abc  ');

package/dist/compat/string/trimEnd.mjs

@@ -3,10 +3,10 @@ import { trimEnd as trimEnd$1 } from "../../string/trimEnd.mjs";
 /**
 * Removes trailing whitespace or specified characters from a string.
 *
-* @param {string} str - The string from which trailing characters will be trimmed.
-* @param {string | number} chars - The character(s) to remove from the end of the string.
-* @param {object} guard - Enables use as an iteratee for methods like `map`.
-* @returns {string} Returns the trimmed string.
+* @param str - The string from which trailing characters will be trimmed.
+* @param chars - The character(s) to remove from the end of the string.
+* @param guard - Enables use as an iteratee for methods like `map`.
+* @returns Returns the trimmed string.
 *
 * @example
 * trimEnd('  abc  ');

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

@@ -2,9 +2,9 @@
 /**
  * Removes leading whitespace or specified characters from a string.
  *
- * @param {string} string - The string to trim.
- * @param {string} chars - The characters to trim from the start of the string.
- * @returns {string} Returns the trimmed string.
+ * @param string - The string to trim.
+ * @param chars - The characters to trim from the start of the string.
+ * @returns Returns the trimmed string.
  *
  * @example
  * trimStart('  abc  ');
@@ -17,10 +17,10 @@ declare function trimStart(string?: string, chars?: string): string;
 /**
  * Removes leading whitespace or specified characters from a string.
  *
- * @param {string} string - The string to trim.
- * @param {string | number} index - The index parameter (used with guard).
- * @param {object} guard - Enables use as an iteratee for methods like `map`.
- * @returns {string} Returns the trimmed string.
+ * @param string - The string to trim.
+ * @param index - The index parameter (used with guard).
+ * @param guard - Enables use as an iteratee for methods like `map`.
+ * @returns Returns the trimmed string.
  *
  * @example
  * trimStart('  abc  ', 0, {});

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

@@ -2,9 +2,9 @@
 /**
  * Removes leading whitespace or specified characters from a string.
  *
- * @param {string} string - The string to trim.
- * @param {string} chars - The characters to trim from the start of the string.
- * @returns {string} Returns the trimmed string.
+ * @param string - The string to trim.
+ * @param chars - The characters to trim from the start of the string.
+ * @returns Returns the trimmed string.
  *
  * @example
  * trimStart('  abc  ');
@@ -17,10 +17,10 @@ declare function trimStart(string?: string, chars?: string): string;
 /**
  * Removes leading whitespace or specified characters from a string.
  *
- * @param {string} string - The string to trim.
- * @param {string | number} index - The index parameter (used with guard).
- * @param {object} guard - Enables use as an iteratee for methods like `map`.
- * @returns {string} Returns the trimmed string.
+ * @param string - The string to trim.
+ * @param index - The index parameter (used with guard).
+ * @param guard - Enables use as an iteratee for methods like `map`.
+ * @returns Returns the trimmed string.
  *
  * @example
  * trimStart('  abc  ', 0, {});

package/dist/compat/string/trimStart.js

@@ -3,10 +3,10 @@ const require_trimStart = require("../../string/trimStart.js");
 /**
 * Removes leading whitespace or specified characters from a string.
 *
-* @param {string} str - The string from which leading characters will be trimmed.
-* @param {string | number} chars - The character(s) to remove from the start of the string.
-* @param {object} guard - Enables use as an iteratee for methods like `map`.
-* @returns {string} Returns the trimmed string.
+* @param str - The string from which leading characters will be trimmed.
+* @param chars - The character(s) to remove from the start of the string.
+* @param guard - Enables use as an iteratee for methods like `map`.
+* @returns Returns the trimmed string.
 *
 * @example
 * trimStart('  abc  ');

package/dist/compat/string/trimStart.mjs

@@ -3,10 +3,10 @@ import { trimStart as trimStart$1 } from "../../string/trimStart.mjs";
 /**
 * Removes leading whitespace or specified characters from a string.
 *
-* @param {string} str - The string from which leading characters will be trimmed.
-* @param {string | number} chars - The character(s) to remove from the start of the string.
-* @param {object} guard - Enables use as an iteratee for methods like `map`.
-* @returns {string} Returns the trimmed string.
+* @param str - The string from which leading characters will be trimmed.
+* @param chars - The character(s) to remove from the start of the string.
+* @param guard - Enables use as an iteratee for methods like `map`.
+* @returns Returns the trimmed string.
 *
 * @example
 * trimStart('  abc  ');

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

@@ -13,11 +13,11 @@ type TruncateOptions = {
  * The last characters of the truncated string are replaced with the omission
  * string which defaults to "...".
  *
- * @param {string} [string=''] The string to truncate.
- * @param {Object} [options={}] The options object.
- * @param {number} [options.length=30] The maximum string length.
- * @param {string} [options.omission='...'] The string to indicate text is omitted.
- * @param {RegExp|string} [options.separator] The separator pattern to truncate to.
+ * @param [string=''] The string to truncate.
+ * @param [options={}] The options object.
+ * @param [options.length=30] The maximum string length.
+ * @param [options.omission='...'] The string to indicate text is omitted.
+ * @param [options.separator] The separator pattern to truncate to.
  *
  * @example
  * const test = 'hi-diddly-ho there, neighborino';

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

@@ -13,11 +13,11 @@ type TruncateOptions = {
  * The last characters of the truncated string are replaced with the omission
  * string which defaults to "...".
  *
- * @param {string} [string=''] The string to truncate.
- * @param {Object} [options={}] The options object.
- * @param {number} [options.length=30] The maximum string length.
- * @param {string} [options.omission='...'] The string to indicate text is omitted.
- * @param {RegExp|string} [options.separator] The separator pattern to truncate to.
+ * @param [string=''] The string to truncate.
+ * @param [options={}] The options object.
+ * @param [options.length=30] The maximum string length.
+ * @param [options.omission='...'] The string to indicate text is omitted.
+ * @param [options.separator] The separator pattern to truncate to.
  *
  * @example
  * const test = 'hi-diddly-ho there, neighborino';