es-toolkit 1.47.0 → 1.47.1-dev.1851

package/dist/set/map.d.ts

@@ -7,9 +7,9 @@
  *
  * @template T - The type of elements in the input Set.
  * @template U - The type of elements in the output Set.
- * @param {Set<T>} set - The Set to transform.
- * @param {(value: T, value2: T, set: Set<T>) => U} getNewValue - A function that generates a new value from an element.
- * @returns {Set<U>} A new Set with transformed elements.
+ * @param set - The Set to transform.
+ * @param getNewValue - A function that generates a new value from an element.
+ * @returns A new Set with transformed elements.
  *
  * @example
  * const set = new Set([1, 2, 3]);

package/dist/set/map.js

@@ -7,9 +7,9 @@
 *
 * @template T - The type of elements in the input Set.
 * @template U - The type of elements in the output Set.
-* @param {Set<T>} set - The Set to transform.
-* @param {(value: T, value2: T, set: Set<T>) => U} getNewValue - A function that generates a new value from an element.
-* @returns {Set<U>} A new Set with transformed elements.
+* @param set - The Set to transform.
+* @param getNewValue - A function that generates a new value from an element.
+* @returns A new Set with transformed elements.
 *
 * @example
 * const set = new Set([1, 2, 3]);

package/dist/set/map.mjs

@@ -7,9 +7,9 @@
 *
 * @template T - The type of elements in the input Set.
 * @template U - The type of elements in the output Set.
-* @param {Set<T>} set - The Set to transform.
-* @param {(value: T, value2: T, set: Set<T>) => U} getNewValue - A function that generates a new value from an element.
-* @returns {Set<U>} A new Set with transformed elements.
+* @param set - The Set to transform.
+* @param getNewValue - A function that generates a new value from an element.
+* @returns A new Set with transformed elements.
 *
 * @example
 * const set = new Set([1, 2, 3]);

package/dist/set/reduce.d.mts

@@ -8,10 +8,10 @@
  *
  * @template T - The type of elements in the Set.
  * @template A - The type of the accumulator.
- * @param {Set<T>} set - The Set to reduce.
- * @param {(accumulator: A, value: T, value2: T, set: Set<T>) => A} callback - A function that processes each element and updates the accumulator.
- * @param {A} [initialValue] - The initial value for the accumulator. If not provided, the first element in the Set is used.
- * @returns {A} The final accumulated value.
+ * @param set - The Set to reduce.
+ * @param callback - A function that processes each element and updates the accumulator.
+ * @param [initialValue] - The initial value for the accumulator. If not provided, the first element in the Set is used.
+ * @returns The final accumulated value.
  * @throws {TypeError} If the Set is empty and no initial value is provided.
  *
  * @example

package/dist/set/reduce.d.ts

@@ -8,10 +8,10 @@
  *
  * @template T - The type of elements in the Set.
  * @template A - The type of the accumulator.
- * @param {Set<T>} set - The Set to reduce.
- * @param {(accumulator: A, value: T, value2: T, set: Set<T>) => A} callback - A function that processes each element and updates the accumulator.
- * @param {A} [initialValue] - The initial value for the accumulator. If not provided, the first element in the Set is used.
- * @returns {A} The final accumulated value.
+ * @param set - The Set to reduce.
+ * @param callback - A function that processes each element and updates the accumulator.
+ * @param [initialValue] - The initial value for the accumulator. If not provided, the first element in the Set is used.
+ * @returns The final accumulated value.
  * @throws {TypeError} If the Set is empty and no initial value is provided.
  *
  * @example

package/dist/set/reduce.js

@@ -8,10 +8,10 @@
 *
 * @template T - The type of elements in the Set.
 * @template A - The type of the accumulator.
-* @param {Set<T>} set - The Set to reduce.
-* @param {(accumulator: A, value: T, value2: T, set: Set<T>) => A} callback - A function that processes each element and updates the accumulator.
-* @param {A} [initialValue] - The initial value for the accumulator. If not provided, the first element in the Set is used.
-* @returns {A} The final accumulated value.
+* @param set - The Set to reduce.
+* @param callback - A function that processes each element and updates the accumulator.
+* @param [initialValue] - The initial value for the accumulator. If not provided, the first element in the Set is used.
+* @returns The final accumulated value.
 * @throws {TypeError} If the Set is empty and no initial value is provided.
 *
 * @example

package/dist/set/reduce.mjs

@@ -8,10 +8,10 @@
 *
 * @template T - The type of elements in the Set.
 * @template A - The type of the accumulator.
-* @param {Set<T>} set - The Set to reduce.
-* @param {(accumulator: A, value: T, value2: T, set: Set<T>) => A} callback - A function that processes each element and updates the accumulator.
-* @param {A} [initialValue] - The initial value for the accumulator. If not provided, the first element in the Set is used.
-* @returns {A} The final accumulated value.
+* @param set - The Set to reduce.
+* @param callback - A function that processes each element and updates the accumulator.
+* @param [initialValue] - The initial value for the accumulator. If not provided, the first element in the Set is used.
+* @returns The final accumulated value.
 * @throws {TypeError} If the Set is empty and no initial value is provided.
 *
 * @example

package/dist/set/some.d.mts

@@ -7,9 +7,9 @@
  * and false otherwise.
  *
  * @template T - The type of elements in the Set.
- * @param {Set<T>} set - The Set to test.
- * @param {(value: T, value2: T, set: Set<T>) => boolean} doesMatch - A predicate function that tests each element.
- * @returns {boolean} true if at least one element satisfies the predicate, false otherwise.
+ * @param set - The Set to test.
+ * @param doesMatch - A predicate function that tests each element.
+ * @returns true if at least one element satisfies the predicate, false otherwise.
  *
  * @example
  * const set = new Set([1, 2, 3]);

package/dist/set/some.d.ts

@@ -7,9 +7,9 @@
  * and false otherwise.
  *
  * @template T - The type of elements in the Set.
- * @param {Set<T>} set - The Set to test.
- * @param {(value: T, value2: T, set: Set<T>) => boolean} doesMatch - A predicate function that tests each element.
- * @returns {boolean} true if at least one element satisfies the predicate, false otherwise.
+ * @param set - The Set to test.
+ * @param doesMatch - A predicate function that tests each element.
+ * @returns true if at least one element satisfies the predicate, false otherwise.
  *
  * @example
  * const set = new Set([1, 2, 3]);

package/dist/set/some.js

@@ -7,9 +7,9 @@
 * and false otherwise.
 *
 * @template T - The type of elements in the Set.
-* @param {Set<T>} set - The Set to test.
-* @param {(value: T, value2: T, set: Set<T>) => boolean} doesMatch - A predicate function that tests each element.
-* @returns {boolean} true if at least one element satisfies the predicate, false otherwise.
+* @param set - The Set to test.
+* @param doesMatch - A predicate function that tests each element.
+* @returns true if at least one element satisfies the predicate, false otherwise.
 *
 * @example
 * const set = new Set([1, 2, 3]);

package/dist/set/some.mjs

@@ -7,9 +7,9 @@
 * and false otherwise.
 *
 * @template T - The type of elements in the Set.
-* @param {Set<T>} set - The Set to test.
-* @param {(value: T, value2: T, set: Set<T>) => boolean} doesMatch - A predicate function that tests each element.
-* @returns {boolean} true if at least one element satisfies the predicate, false otherwise.
+* @param set - The Set to test.
+* @param doesMatch - A predicate function that tests each element.
+* @returns true if at least one element satisfies the predicate, false otherwise.
 *
 * @example
 * const set = new Set([1, 2, 3]);

package/dist/string/camelCase.d.mts

@@ -5,8 +5,8 @@
  * Camel case is the naming convention in which the first word is written in lowercase and
  * each subsequent word begins with a capital letter, concatenated without any separator characters.
  *
- * @param {string} str - The string that is to be changed to camel case.
- * @returns {string} - The converted string to camel case.
+ * @param str - The string that is to be changed to camel case.
+ * @returns The converted string to camel case.
  *
  * @example
  * const convertedStr1 = camelCase('camelCase') // returns 'camelCase'

package/dist/string/camelCase.d.ts

@@ -5,8 +5,8 @@
  * Camel case is the naming convention in which the first word is written in lowercase and
  * each subsequent word begins with a capital letter, concatenated without any separator characters.
  *
- * @param {string} str - The string that is to be changed to camel case.
- * @returns {string} - The converted string to camel case.
+ * @param str - The string that is to be changed to camel case.
+ * @returns The converted string to camel case.
  *
  * @example
  * const convertedStr1 = camelCase('camelCase') // returns 'camelCase'

package/dist/string/camelCase.js

@@ -7,8 +7,8 @@ const require_words = require("./words.js");
 * Camel case is the naming convention in which the first word is written in lowercase and
 * each subsequent word begins with a capital letter, concatenated without any separator characters.
 *
-* @param {string} str - The string that is to be changed to camel case.
-* @returns {string} - The converted string to camel case.
+* @param str - The string that is to be changed to camel case.
+* @returns The converted string to camel case.
 *
 * @example
 * const convertedStr1 = camelCase('camelCase') // returns 'camelCase'

package/dist/string/camelCase.mjs

@@ -7,8 +7,8 @@ import { words } from "./words.mjs";
 * Camel case is the naming convention in which the first word is written in lowercase and
 * each subsequent word begins with a capital letter, concatenated without any separator characters.
 *
-* @param {string} str - The string that is to be changed to camel case.
-* @returns {string} - The converted string to camel case.
+* @param str - The string that is to be changed to camel case.
+* @returns The converted string to camel case.
 *
 * @example
 * const convertedStr1 = camelCase('camelCase') // returns 'camelCase'

package/dist/string/capitalize.d.mts

@@ -3,8 +3,8 @@
  * Converts the first character of string to upper case and the remaining to lower case.
  *
  * @template T - Literal type of the string.
- * @param {T} str - The string to be converted to uppercase.
- * @returns {Capitalize<T>} - The capitalized string.
+ * @param str - The string to be converted to uppercase.
+ * @returns The capitalized string.
  *
  * @example
  * const result = capitalize('fred') // returns 'Fred'

package/dist/string/capitalize.d.ts

@@ -3,8 +3,8 @@
  * Converts the first character of string to upper case and the remaining to lower case.
  *
  * @template T - Literal type of the string.
- * @param {T} str - The string to be converted to uppercase.
- * @returns {Capitalize<T>} - The capitalized string.
+ * @param str - The string to be converted to uppercase.
+ * @returns The capitalized string.
  *
  * @example
  * const result = capitalize('fred') // returns 'Fred'

package/dist/string/capitalize.js

@@ -3,8 +3,8 @@
 * Converts the first character of string to upper case and the remaining to lower case.
 *
 * @template T - Literal type of the string.
-* @param {T} str - The string to be converted to uppercase.
-* @returns {Capitalize<T>} - The capitalized string.
+* @param str - The string to be converted to uppercase.
+* @returns The capitalized string.
 *
 * @example
 * const result = capitalize('fred') // returns 'Fred'

package/dist/string/capitalize.mjs

@@ -3,8 +3,8 @@
 * Converts the first character of string to upper case and the remaining to lower case.
 *
 * @template T - Literal type of the string.
-* @param {T} str - The string to be converted to uppercase.
-* @returns {Capitalize<T>} - The capitalized string.
+* @param str - The string to be converted to uppercase.
+* @returns The capitalized string.
 *
 * @example
 * const result = capitalize('fred') // returns 'Fred'

package/dist/string/constantCase.d.mts

@@ -4,8 +4,8 @@
  *
  * Constant case is a naming convention where each word is written in uppercase letters and separated by an underscore (`_`). For example, `CONSTANT_CASE`.
  *
- * @param {string} str - The string that is to be changed to constant case.
- * @returns {string} - The converted string to constant case.
+ * @param str - The string that is to be changed to constant case.
+ * @returns The converted string to constant case.
  *
  * @example
  * const convertedStr1 = constantCase('camelCase') // returns 'CAMEL_CASE'

package/dist/string/constantCase.d.ts

@@ -4,8 +4,8 @@
  *
  * Constant case is a naming convention where each word is written in uppercase letters and separated by an underscore (`_`). For example, `CONSTANT_CASE`.
  *
- * @param {string} str - The string that is to be changed to constant case.
- * @returns {string} - The converted string to constant case.
+ * @param str - The string that is to be changed to constant case.
+ * @returns The converted string to constant case.
  *
  * @example
  * const convertedStr1 = constantCase('camelCase') // returns 'CAMEL_CASE'

package/dist/string/constantCase.js

@@ -5,8 +5,8 @@ const require_words = require("./words.js");
 *
 * Constant case is a naming convention where each word is written in uppercase letters and separated by an underscore (`_`). For example, `CONSTANT_CASE`.
 *
-* @param {string} str - The string that is to be changed to constant case.
-* @returns {string} - The converted string to constant case.
+* @param str - The string that is to be changed to constant case.
+* @returns The converted string to constant case.
 *
 * @example
 * const convertedStr1 = constantCase('camelCase') // returns 'CAMEL_CASE'

package/dist/string/constantCase.mjs

@@ -5,8 +5,8 @@ import { words } from "./words.mjs";
 *
 * Constant case is a naming convention where each word is written in uppercase letters and separated by an underscore (`_`). For example, `CONSTANT_CASE`.
 *
-* @param {string} str - The string that is to be changed to constant case.
-* @returns {string} - The converted string to constant case.
+* @param str - The string that is to be changed to constant case.
+* @returns The converted string to constant case.
 *
 * @example
 * const convertedStr1 = constantCase('camelCase') // returns 'CAMEL_CASE'

package/dist/string/deburr.d.mts

@@ -3,8 +3,8 @@
  * 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/string/deburr.d.ts

@@ -3,8 +3,8 @@
  * 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/string/deburr.js

@@ -34,8 +34,8 @@ const deburrMap = new Map([
 * 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/string/deburr.mjs

@@ -34,8 +34,8 @@ const deburrMap = new Map([
 * 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/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/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/string/escape.js

@@ -10,8 +10,8 @@ const htmlEscapes = {
 * 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/string/escape.mjs

@@ -10,8 +10,8 @@ const htmlEscapes = {
 * 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/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/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/string/escapeRegExp.js

@@ -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/string/escapeRegExp.mjs

@@ -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/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} 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/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} 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/string/kebabCase.js

@@ -5,8 +5,8 @@ const require_words = require("./words.js");
 *
 * Kebab case is the naming convention in which each word is written in lowercase and separated by a dash (-) character.
 *
-* @param {string} 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/string/kebabCase.mjs

@@ -5,8 +5,8 @@ import { words } from "./words.mjs";
 *
 * Kebab case is the naming convention in which each word is written in lowercase and separated by a dash (-) character.
 *
-* @param {string} 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/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} 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/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} 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/string/lowerCase.js

@@ -5,8 +5,8 @@ const require_words = require("./words.js");
 *
 * Lower case is the naming convention in which each word is written in lowercase and separated by an space ( ) character.
 *
-* @param {string} 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/string/lowerCase.mjs

@@ -5,8 +5,8 @@ import { words } from "./words.mjs";
 *
 * Lower case is the naming convention in which each word is written in lowercase and separated by an space ( ) character.
 *
-* @param {string} 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/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/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/string/lowerFirst.js

@@ -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/string/lowerFirst.mjs

@@ -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/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   '