es-toolkit 1.16.0-dev.491 → 1.16.0-dev.492

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,8 +1,21 @@
1
1
  /**
2
- * Deburrs `str` by converting [Latin-1 Supplement](<https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)#Character_table>) and [Latin Extended-A](https://en.wikipedia.org/wiki/Latin_Extended-A) letters to basic Latin letters and removing [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks).
2
+ * Converts a string by replacing special characters and diacritical marks with their ASCII equivalents.
3
+ * For example, "Crème brûlée" becomes "Creme brulee".
3
4
  *
4
- * @param {string} str The string to deburr.
5
- * @returns {string} Returns the deburred string.
5
+ * @param {string} str - The input string to be deburred.
6
+ * @returns {string} - The deburred string with special characters replaced by their ASCII equivalents.
7
+ *
8
+ * @example
9
+ * // Basic usage:
10
+ * deburr('Æthelred') // returns 'Aethelred'
11
+ *
12
+ * @example
13
+ * // Handling diacritical marks:
14
+ * deburr('München') // returns 'Munchen'
15
+ *
16
+ * @example
17
+ * // Special characters:
18
+ * deburr('Crème brûlée') // returns 'Creme brulee'
6
19
  */
7
20
  declare function deburr(str: string): string;
8
21
 
@@ -1,8 +1,21 @@
1
1
  /**
2
- * Deburrs `str` by converting [Latin-1 Supplement](<https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)#Character_table>) and [Latin Extended-A](https://en.wikipedia.org/wiki/Latin_Extended-A) letters to basic Latin letters and removing [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks).
2
+ * Converts a string by replacing special characters and diacritical marks with their ASCII equivalents.
3
+ * For example, "Crème brûlée" becomes "Creme brulee".
3
4
  *
4
- * @param {string} str The string to deburr.
5
- * @returns {string} Returns the deburred string.
5
+ * @param {string} str - The input string to be deburred.
6
+ * @returns {string} - The deburred string with special characters replaced by their ASCII equivalents.
7
+ *
8
+ * @example
9
+ * // Basic usage:
10
+ * deburr('Æthelred') // returns 'Aethelred'
11
+ *
12
+ * @example
13
+ * // Handling diacritical marks:
14
+ * deburr('München') // returns 'Munchen'
15
+ *
16
+ * @example
17
+ * // Special characters:
18
+ * deburr('Crème brûlée') // returns 'Creme brulee'
6
19
  */
7
20
  declare function deburr(str: string): string;
8
21
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "es-toolkit",
3
3
  "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
4
- "version": "1.16.0-dev.491+58d1cb2f",
4
+ "version": "1.16.0-dev.492+c7d12a1c",
5
5
  "homepage": "https://es-toolkit.slash.page",
6
6
  "bugs": "https://github.com/toss/es-toolkit/issues",
7
7
  "repository": {