es-toolkit 1.47.0 → 1.47.1-dev.1853

package/dist/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/string/pad.js

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

@@ -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/string/pascalCase.d.mts

@@ -4,8 +4,8 @@
  *
  * Pascal case is the naming convention in which each word is capitalized and concatenated without any separator characters.
  *
- * @param {string} str - The string that is to be changed to pascal case.
- * @returns {string} - The converted string to Pascal case.
+ * @param str - The string that is to be changed to pascal case.
+ * @returns The converted string to Pascal case.
  *
  * @example
  * const convertedStr1 = pascalCase('pascalCase') // returns 'PascalCase'

package/dist/string/pascalCase.d.ts

@@ -4,8 +4,8 @@
  *
  * Pascal case is the naming convention in which each word is capitalized and concatenated without any separator characters.
  *
- * @param {string} str - The string that is to be changed to pascal case.
- * @returns {string} - The converted string to Pascal case.
+ * @param str - The string that is to be changed to pascal case.
+ * @returns The converted string to Pascal case.
  *
  * @example
  * const convertedStr1 = pascalCase('pascalCase') // returns 'PascalCase'

package/dist/string/pascalCase.js

@@ -6,8 +6,8 @@ const require_words = require("./words.js");
 *
 * Pascal case is the naming convention in which each word is capitalized and concatenated without any separator characters.
 *
-* @param {string} str - The string that is to be changed to pascal case.
-* @returns {string} - The converted string to Pascal case.
+* @param str - The string that is to be changed to pascal case.
+* @returns The converted string to Pascal case.
 *
 * @example
 * const convertedStr1 = pascalCase('pascalCase') // returns 'PascalCase'

package/dist/string/pascalCase.mjs

@@ -6,8 +6,8 @@ import { words } from "./words.mjs";
 *
 * Pascal case is the naming convention in which each word is capitalized and concatenated without any separator characters.
 *
-* @param {string} str - The string that is to be changed to pascal case.
-* @returns {string} - The converted string to Pascal case.
+* @param str - The string that is to be changed to pascal case.
+* @returns The converted string to Pascal case.
 *
 * @example
 * const convertedStr1 = pascalCase('pascalCase') // returns 'PascalCase'

package/dist/string/reverseString.d.mts

@@ -4,8 +4,8 @@
  *
  * This function takes a string as input and returns a new string that is the reverse of the input.
  *
- * @param {string} value - The string that is to be reversed.
- * @returns {string} - The reversed string.
+ * @param value - The string that is to be reversed.
+ * @returns The reversed string.
  *
  * @example
  * const reversedStr1 = reverseString('hello') // returns 'olleh'

package/dist/string/reverseString.d.ts

@@ -4,8 +4,8 @@
  *
  * This function takes a string as input and returns a new string that is the reverse of the input.
  *
- * @param {string} value - The string that is to be reversed.
- * @returns {string} - The reversed string.
+ * @param value - The string that is to be reversed.
+ * @returns The reversed string.
  *
  * @example
  * const reversedStr1 = reverseString('hello') // returns 'olleh'

package/dist/string/reverseString.js

@@ -4,8 +4,8 @@
 *
 * This function takes a string as input and returns a new string that is the reverse of the input.
 *
-* @param {string} value - The string that is to be reversed.
-* @returns {string} - The reversed string.
+* @param value - The string that is to be reversed.
+* @returns The reversed string.
 *
 * @example
 * const reversedStr1 = reverseString('hello') // returns 'olleh'

package/dist/string/reverseString.mjs

@@ -4,8 +4,8 @@
 *
 * This function takes a string as input and returns a new string that is the reverse of the input.
 *
-* @param {string} value - The string that is to be reversed.
-* @returns {string} - The reversed string.
+* @param value - The string that is to be reversed.
+* @returns The reversed string.
 *
 * @example
 * const reversedStr1 = reverseString('hello') // returns 'olleh'

package/dist/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} 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/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} 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/string/snakeCase.js

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

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

@@ -4,8 +4,8 @@ const require_words = require("./words.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} 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/string/startCase.mjs

@@ -4,8 +4,8 @@ import { words } from "./words.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} 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/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 characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the string. Can be a single character or an array of characters.
- * @returns {string} - The resulting string after the specified characters have been removed.
+ * @param str - The string from which characters will be trimmed.
+ * @param chars - The character(s) to remove from the string. Can be a single character or an array of characters.
+ * @returns The resulting string after the specified characters have been removed.
  *
  * @example
  * trim("  hello  "); // "hello"

package/dist/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 characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the string. Can be a single character or an array of characters.
- * @returns {string} - The resulting string after the specified characters have been removed.
+ * @param str - The string from which characters will be trimmed.
+ * @param chars - The character(s) to remove from the string. Can be a single character or an array of characters.
+ * @returns The resulting string after the specified characters have been removed.
  *
  * @example
  * trim("  hello  "); // "hello"

package/dist/string/trim.js

@@ -4,9 +4,9 @@ const require_trimStart = require("./trimStart.js");
 /**
 * Removes leading and trailing whitespace or specified characters from a string.
 *
-* @param {string} str - The string from which characters will be trimmed.
-* @param {string | string[]} chars - The character(s) to remove from the string. Can be a single character or an array of characters.
-* @returns {string} - The resulting string after the specified characters have been removed.
+* @param str - The string from which characters will be trimmed.
+* @param chars - The character(s) to remove from the string. Can be a single character or an array of characters.
+* @returns The resulting string after the specified characters have been removed.
 *
 * @example
 * trim("  hello  "); // "hello"

package/dist/string/trim.mjs

@@ -4,9 +4,9 @@ import { trimStart } from "./trimStart.mjs";
 /**
 * Removes leading and trailing whitespace or specified characters from a string.
 *
-* @param {string} str - The string from which characters will be trimmed.
-* @param {string | string[]} chars - The character(s) to remove from the string. Can be a single character or an array of characters.
-* @returns {string} - The resulting string after the specified characters have been removed.
+* @param str - The string from which characters will be trimmed.
+* @param chars - The character(s) to remove from the string. Can be a single character or an array of characters.
+* @returns The resulting string after the specified characters have been removed.
 *
 * @example
 * trim("  hello  "); // "hello"

package/dist/string/trimEnd.d.mts

@@ -5,9 +5,9 @@
  * If `chars` is a string, it should be a single character. To trim a string with multiple characters,
  * provide an array instead.
  *
- * @param {string} str - The string from which trailing characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the end of the string.
- * @returns {string} - The resulting string after the specified trailing character has been removed.
+ * @param str - The string from which trailing characters will be trimmed.
+ * @param chars - The character(s) to remove from the end of the string.
+ * @returns The resulting string after the specified trailing character has been removed.
  *
  * @example
  * const trimmedStr1 = trimEnd('hello---', '-') // returns 'hello'

package/dist/string/trimEnd.d.ts

@@ -5,9 +5,9 @@
  * If `chars` is a string, it should be a single character. To trim a string with multiple characters,
  * provide an array instead.
  *
- * @param {string} str - The string from which trailing characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the end of the string.
- * @returns {string} - The resulting string after the specified trailing character has been removed.
+ * @param str - The string from which trailing characters will be trimmed.
+ * @param chars - The character(s) to remove from the end of the string.
+ * @returns The resulting string after the specified trailing character has been removed.
  *
  * @example
  * const trimmedStr1 = trimEnd('hello---', '-') // returns 'hello'

package/dist/string/trimEnd.js

@@ -5,9 +5,9 @@
 * If `chars` is a string, it should be a single character. To trim a string with multiple characters,
 * provide an array instead.
 *
-* @param {string} str - The string from which trailing characters will be trimmed.
-* @param {string | string[]} chars - The character(s) to remove from the end of the string.
-* @returns {string} - The resulting string after the specified trailing character has been removed.
+* @param str - The string from which trailing characters will be trimmed.
+* @param chars - The character(s) to remove from the end of the string.
+* @returns The resulting string after the specified trailing character has been removed.
 *
 * @example
 * const trimmedStr1 = trimEnd('hello---', '-') // returns 'hello'

package/dist/string/trimEnd.mjs

@@ -5,9 +5,9 @@
 * If `chars` is a string, it should be a single character. To trim a string with multiple characters,
 * provide an array instead.
 *
-* @param {string} str - The string from which trailing characters will be trimmed.
-* @param {string | string[]} chars - The character(s) to remove from the end of the string.
-* @returns {string} - The resulting string after the specified trailing character has been removed.
+* @param str - The string from which trailing characters will be trimmed.
+* @param chars - The character(s) to remove from the end of the string.
+* @returns The resulting string after the specified trailing character has been removed.
 *
 * @example
 * const trimmedStr1 = trimEnd('hello---', '-') // returns 'hello'

package/dist/string/trimStart.d.mts

@@ -5,9 +5,9 @@
  * If `chars` is a string, it should be a single character. To trim a string with multiple characters,
  * provide an array instead.
  *
- * @param {string} str - The string from which leading characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the start of the string.
- * @returns {string} - The resulting string after the specified leading character has been removed.
+ * @param str - The string from which leading characters will be trimmed.
+ * @param chars - The character(s) to remove from the start of the string.
+ * @returns The resulting string after the specified leading character has been removed.
  *
  * @example
  * const trimmedStr1 = trimStart('---hello', '-') // returns 'hello'

package/dist/string/trimStart.d.ts

@@ -5,9 +5,9 @@
  * If `chars` is a string, it should be a single character. To trim a string with multiple characters,
  * provide an array instead.
  *
- * @param {string} str - The string from which leading characters will be trimmed.
- * @param {string | string[]} chars - The character(s) to remove from the start of the string.
- * @returns {string} - The resulting string after the specified leading character has been removed.
+ * @param str - The string from which leading characters will be trimmed.
+ * @param chars - The character(s) to remove from the start of the string.
+ * @returns The resulting string after the specified leading character has been removed.
  *
  * @example
  * const trimmedStr1 = trimStart('---hello', '-') // returns 'hello'

package/dist/string/trimStart.js

@@ -5,9 +5,9 @@
 * If `chars` is a string, it should be a single character. To trim a string with multiple characters,
 * provide an array instead.
 *
-* @param {string} str - The string from which leading characters will be trimmed.
-* @param {string | string[]} chars - The character(s) to remove from the start of the string.
-* @returns {string} - The resulting string after the specified leading character has been removed.
+* @param str - The string from which leading characters will be trimmed.
+* @param chars - The character(s) to remove from the start of the string.
+* @returns The resulting string after the specified leading character has been removed.
 *
 * @example
 * const trimmedStr1 = trimStart('---hello', '-') // returns 'hello'

package/dist/string/trimStart.mjs

@@ -5,9 +5,9 @@
 * If `chars` is a string, it should be a single character. To trim a string with multiple characters,
 * provide an array instead.
 *
-* @param {string} str - The string from which leading characters will be trimmed.
-* @param {string | string[]} chars - The character(s) to remove from the start of the string.
-* @returns {string} - The resulting string after the specified leading character has been removed.
+* @param str - The string from which leading characters will be trimmed.
+* @param chars - The character(s) to remove from the start of the string.
+* @returns The resulting string after the specified leading character has been removed.
 *
 * @example
 * const trimmedStr1 = trimStart('---hello', '-') // returns 'hello'

package/dist/string/unescape.d.mts

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

package/dist/string/unescape.d.ts

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

package/dist/string/unescape.js

@@ -10,8 +10,8 @@ const htmlUnescapes = {
 * Converts the HTML entities `&`, `<`, `>`, `"`, and `'` in `str` to their corresponding characters.
 * It is the inverse of `escape`.
 *
-* @param {string} str The string to unescape.
-* @returns {string} Returns the unescaped string.
+* @param str The string to unescape.
+* @returns Returns the unescaped string.
 *
 * @example
 * unescape('This is a &lt;div&gt; element.'); // returns 'This is a <div> element.'

package/dist/string/unescape.mjs

@@ -10,8 +10,8 @@ const htmlUnescapes = {
 * Converts the HTML entities `&`, `<`, `>`, `"`, and `'` in `str` to their corresponding characters.
 * It is the inverse of `escape`.
 *
-* @param {string} str The string to unescape.
-* @returns {string} Returns the unescaped string.
+* @param str The string to unescape.
+* @returns Returns the unescaped string.
 *
 * @example
 * unescape('This is a &lt;div&gt; element.'); // returns 'This is a <div> element.'

package/dist/string/upperCase.d.mts

@@ -4,8 +4,8 @@
  *
  * Upper case is the naming convention in which each word is written in uppercase and separated by an space ( ) character.
  *
- * @param {string} str - The string that is to be changed to upper case.
- * @returns {string} - The converted string to upper case.
+ * @param str - The string that is to be changed to upper case.
+ * @returns The converted string to upper case.
  *
  * @example
  * const convertedStr1 = upperCase('camelCase') // returns 'CAMEL CASE'

package/dist/string/upperCase.d.ts

@@ -4,8 +4,8 @@
  *
  * Upper case is the naming convention in which each word is written in uppercase and separated by an space ( ) character.
  *
- * @param {string} str - The string that is to be changed to upper case.
- * @returns {string} - The converted string to upper case.
+ * @param str - The string that is to be changed to upper case.
+ * @returns The converted string to upper case.
  *
  * @example
  * const convertedStr1 = upperCase('camelCase') // returns 'CAMEL CASE'

package/dist/string/upperCase.js

@@ -5,8 +5,8 @@ const require_words = require("./words.js");
 *
 * Upper case is the naming convention in which each word is written in uppercase and separated by an space ( ) character.
 *
-* @param {string} str - The string that is to be changed to upper case.
-* @returns {string} - The converted string to upper case.
+* @param str - The string that is to be changed to upper case.
+* @returns The converted string to upper case.
 *
 * @example
 * const convertedStr1 = upperCase('camelCase') // returns 'CAMEL CASE'

package/dist/string/upperCase.mjs

@@ -5,8 +5,8 @@ import { words } from "./words.mjs";
 *
 * Upper case is the naming convention in which each word is written in uppercase and separated by an space ( ) character.
 *
-* @param {string} str - The string that is to be changed to upper case.
-* @returns {string} - The converted string to upper case.
+* @param str - The string that is to be changed to upper case.
+* @returns The converted string to upper case.
 *
 * @example
 * const convertedStr1 = upperCase('camelCase') // returns 'CAMEL CASE'

package/dist/string/upperFirst.d.mts

@@ -2,8 +2,8 @@
 /**
  * Converts the first character of string to upper 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 = upperFirst('fred') // returns 'Fred'

package/dist/string/upperFirst.d.ts

@@ -2,8 +2,8 @@
 /**
  * Converts the first character of string to upper 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 = upperFirst('fred') // returns 'Fred'

package/dist/string/upperFirst.js

@@ -2,8 +2,8 @@
 /**
 * Converts the first character of string to upper 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 = upperFirst('fred') // returns 'Fred'

package/dist/string/upperFirst.mjs

@@ -2,8 +2,8 @@
 /**
 * Converts the first character of string to upper 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 = upperFirst('fred') // returns 'Fred'

package/dist/string/words.d.mts

@@ -20,9 +20,9 @@ declare const CASE_SPLIT_PATTERN: RegExp;
 /**
  * Splits `string` into an array of its words, treating spaces and punctuation marks as separators.
  *
- * @param {string} str The string to inspect.
- * @param {RegExp | string} [pattern] The pattern to match words.
- * @returns {string[]} Returns the words of `string`.
+ * @param str The string to inspect.
+ * @param [pattern] The pattern to match words.
+ * @returns Returns the words of `string`.
  *
  * @example
  * words('fred, barney, & pebbles');

package/dist/string/words.d.ts

@@ -20,9 +20,9 @@ declare const CASE_SPLIT_PATTERN: RegExp;
 /**
  * Splits `string` into an array of its words, treating spaces and punctuation marks as separators.
  *
- * @param {string} str The string to inspect.
- * @param {RegExp | string} [pattern] The pattern to match words.
- * @returns {string[]} Returns the words of `string`.
+ * @param str The string to inspect.
+ * @param [pattern] The pattern to match words.
+ * @returns Returns the words of `string`.
  *
  * @example
  * words('fred, barney, & pebbles');

package/dist/string/words.js

@@ -20,9 +20,9 @@ const CASE_SPLIT_PATTERN = /\p{Lu}?\p{Ll}+|[0-9]+|\p{Lu}+(?!\p{Ll})|\p{Emoji_Pre
 /**
 * Splits `string` into an array of its words, treating spaces and punctuation marks as separators.
 *
-* @param {string} str The string to inspect.
-* @param {RegExp | string} [pattern] The pattern to match words.
-* @returns {string[]} Returns the words of `string`.
+* @param str The string to inspect.
+* @param [pattern] The pattern to match words.
+* @returns Returns the words of `string`.
 *
 * @example
 * words('fred, barney, & pebbles');

package/dist/string/words.mjs

@@ -20,9 +20,9 @@ const CASE_SPLIT_PATTERN = /\p{Lu}?\p{Ll}+|[0-9]+|\p{Lu}+(?!\p{Ll})|\p{Emoji_Pre
 /**
 * Splits `string` into an array of its words, treating spaces and punctuation marks as separators.
 *
-* @param {string} str The string to inspect.
-* @param {RegExp | string} [pattern] The pattern to match words.
-* @returns {string[]} Returns the words of `string`.
+* @param str The string to inspect.
+* @param [pattern] The pattern to match words.
+* @returns Returns the words of `string`.
 *
 * @example
 * words('fred, barney, & pebbles');