@rzl-zone/utils-js 3.0.2-beta.2 → 3.1.1-beta.0

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.
Files changed (164) hide show
  1. package/dist/NumberRangeUnion-DC-C3_Kq.d.ts +23 -23
  2. package/dist/any-BmdI8UbK.d.ts +56 -56
  3. package/dist/arrays-normalize-recursive-CnjYJ9xg.d.ts +66 -66
  4. package/dist/assertions/index.cjs +1 -1
  5. package/dist/assertions/index.d.ts +398 -418
  6. package/dist/assertions/index.js +1 -1
  7. package/dist/chunk-26W3VZIK.cjs +1 -0
  8. package/dist/chunk-2KRCHXFG.cjs +2 -0
  9. package/dist/chunk-33ZLH266.js +1 -0
  10. package/dist/{chunk-EXZ47NOW.js → chunk-4L4EJTNZ.js} +1 -1
  11. package/dist/chunk-5Q37AP7P.js +1 -0
  12. package/dist/chunk-7CHFAMS2.js +1 -0
  13. package/dist/chunk-7MMJZ6HS.js +1 -0
  14. package/dist/chunk-7TC6DE3J.cjs +1 -0
  15. package/dist/{chunk-XH6MCRLP.js → chunk-7VX33E3V.js} +1 -1
  16. package/dist/chunk-BEZPD44N.cjs +1 -0
  17. package/dist/chunk-BI263OHW.js +1 -0
  18. package/dist/chunk-CII6WWLO.cjs +1 -0
  19. package/dist/chunk-D5TYPCWU.cjs +1 -0
  20. package/dist/chunk-EEQY5QUG.js +1 -0
  21. package/dist/chunk-ESJYBIYH.js +1 -0
  22. package/dist/chunk-EWYPSKKM.js +1 -0
  23. package/dist/chunk-EXCOQLWX.cjs +1 -0
  24. package/dist/chunk-FWQVTMYA.cjs +1 -0
  25. package/dist/chunk-G4EWCRKS.js +1 -0
  26. package/dist/chunk-G7R5XZRM.cjs +1 -0
  27. package/dist/chunk-GGEV7LXX.cjs +1 -0
  28. package/dist/chunk-HJOZOENU.cjs +1 -0
  29. package/dist/{chunk-BYZAD3XN.cjs → chunk-IRDZVLNZ.cjs} +1 -1
  30. package/dist/chunk-IW73G523.cjs +1 -0
  31. package/dist/chunk-IY5OZAB3.cjs +1 -0
  32. package/dist/chunk-J4NCYYGS.js +1 -0
  33. package/dist/chunk-J7JAZAJD.js +1 -0
  34. package/dist/{chunk-FF76ISQ2.js → chunk-JYNSO7ZY.js} +1 -1
  35. package/dist/chunk-K3UVKYEU.js +1 -0
  36. package/dist/chunk-LQ76EDZG.js +1 -0
  37. package/dist/chunk-MROH35V3.cjs +1 -0
  38. package/dist/chunk-NJSAV73S.js +1 -0
  39. package/dist/chunk-NR44SNYE.js +1 -0
  40. package/dist/chunk-NXMTWY77.js +1 -0
  41. package/dist/chunk-OZCQZO2V.cjs +4 -0
  42. package/dist/chunk-Q3NTKN5I.cjs +1 -0
  43. package/dist/chunk-QDNSC57Z.js +4 -0
  44. package/dist/chunk-QGXTL5ZH.js +2 -0
  45. package/dist/{chunk-JWHM3WZQ.cjs → chunk-QSQDP7L2.cjs} +1 -1
  46. package/dist/{chunk-RN3TP3S3.js → chunk-S5M33A4O.js} +1 -1
  47. package/dist/chunk-SGTHOQQ2.js +1 -0
  48. package/dist/chunk-SL3RQOWA.js +1 -0
  49. package/dist/chunk-SZPWZZYG.cjs +1 -0
  50. package/dist/chunk-UA4B7JBO.cjs +1 -0
  51. package/dist/chunk-UQDJF5RR.cjs +1 -0
  52. package/dist/chunk-UTQUYABU.cjs +1 -0
  53. package/dist/chunk-VPW3DRV5.js +1 -0
  54. package/dist/chunk-W32WALNU.js +1 -0
  55. package/dist/chunk-XGZ6K753.cjs +1 -0
  56. package/dist/chunk-YFTR64N5.cjs +1 -0
  57. package/dist/chunk-ZFDS7W6B.cjs +1 -0
  58. package/dist/chunk-ZQOLZE6Z.cjs +1 -0
  59. package/dist/conversions/index.cjs +1 -1
  60. package/dist/conversions/index.d.ts +1307 -1504
  61. package/dist/conversions/index.js +1 -1
  62. package/dist/env/index.d.ts +14 -17
  63. package/dist/events/index.cjs +1 -1
  64. package/dist/events/index.d.ts +111 -108
  65. package/dist/events/index.js +1 -1
  66. package/dist/extends-Bk_SBGdT.d.ts +367 -0
  67. package/dist/formatting/index.cjs +1 -1
  68. package/dist/formatting/index.d.ts +878 -840
  69. package/dist/formatting/index.js +1 -1
  70. package/dist/generator/index.cjs +1 -1
  71. package/dist/generator/index.d.ts +173 -150
  72. package/dist/generator/index.js +1 -1
  73. package/dist/if-CvT4R7Kh.d.ts +16 -16
  74. package/dist/index.cjs +1 -1
  75. package/dist/index.d.ts +1 -1
  76. package/dist/index.js +1 -1
  77. package/dist/is-array--YjXV-Wx.d.ts +1207 -0
  78. package/dist/isPlainObject-BVhBAPHX.d.ts +169 -0
  79. package/dist/never-BfayMBF9.d.ts +64 -64
  80. package/dist/next/index.cjs +6 -6
  81. package/dist/next/index.d.ts +196 -176
  82. package/dist/next/index.js +5 -5
  83. package/dist/next/server/index.cjs +1 -1
  84. package/dist/next/server/index.d.ts +26 -40
  85. package/dist/next/server/index.js +1 -1
  86. package/dist/nils-DMz3kU7M.d.ts +155 -155
  87. package/dist/omit-VvmIsZmX.d.ts +25 -25
  88. package/dist/operations/index.cjs +1 -1
  89. package/dist/operations/index.d.ts +121 -176
  90. package/dist/operations/index.js +1 -1
  91. package/dist/parsers/index.cjs +1 -1
  92. package/dist/parsers/index.d.ts +35 -36
  93. package/dist/parsers/index.js +1 -1
  94. package/dist/predicates/index.cjs +1 -1
  95. package/dist/predicates/index.d.ts +1701 -1675
  96. package/dist/predicates/index.js +1 -1
  97. package/dist/prettify-C4xLcYOP.d.ts +328 -328
  98. package/dist/promise/index.cjs +1 -1
  99. package/dist/promise/index.d.ts +29 -38
  100. package/dist/promise/index.js +1 -1
  101. package/dist/rzl-utils.global.js +3 -3
  102. package/dist/string-XA-til3C.d.ts +351 -0
  103. package/dist/strings/index.cjs +1 -1
  104. package/dist/strings/index.d.ts +712 -787
  105. package/dist/strings/index.js +1 -1
  106. package/dist/stylings/index.cjs +1 -1
  107. package/dist/stylings/index.d.ts +37 -45
  108. package/dist/stylings/index.js +1 -1
  109. package/dist/type-data-DDs-u2kq.d.ts +241 -241
  110. package/dist/types/index.d.ts +3266 -3266
  111. package/dist/urls/index.cjs +1 -1
  112. package/dist/urls/index.d.ts +384 -409
  113. package/dist/urls/index.js +1 -1
  114. package/package.json +53 -11
  115. package/dist/array-CIZRbqTF.d.ts +0 -223
  116. package/dist/chunk-2TRAPBZ7.cjs +0 -1
  117. package/dist/chunk-3D74QO5D.cjs +0 -1
  118. package/dist/chunk-4DK3RCC4.js +0 -2
  119. package/dist/chunk-4JOQ45HL.js +0 -1
  120. package/dist/chunk-55CZALRS.js +0 -1
  121. package/dist/chunk-5JFV3GDE.cjs +0 -4
  122. package/dist/chunk-62HX5Z45.cjs +0 -1
  123. package/dist/chunk-7NA6DUHR.cjs +0 -2
  124. package/dist/chunk-BVPMMWDL.cjs +0 -1
  125. package/dist/chunk-CEFYHEM4.cjs +0 -1
  126. package/dist/chunk-CN53M4QZ.cjs +0 -1
  127. package/dist/chunk-D47MHBSD.cjs +0 -1
  128. package/dist/chunk-DGH75GJD.js +0 -1
  129. package/dist/chunk-E5NUI7PN.js +0 -1
  130. package/dist/chunk-FDITZ5C6.cjs +0 -1
  131. package/dist/chunk-FSSV24W7.cjs +0 -1
  132. package/dist/chunk-GCGU2WB7.js +0 -1
  133. package/dist/chunk-GECI2YBP.js +0 -1
  134. package/dist/chunk-GQE4OVHC.cjs +0 -1
  135. package/dist/chunk-GRVZXQXL.cjs +0 -1
  136. package/dist/chunk-I4AVNHPA.cjs +0 -1
  137. package/dist/chunk-JFRL7NKU.js +0 -4
  138. package/dist/chunk-KCQDDZJE.cjs +0 -1
  139. package/dist/chunk-L54ZPSYJ.js +0 -1
  140. package/dist/chunk-LVKAYEZ4.js +0 -1
  141. package/dist/chunk-MBDWTK54.cjs +0 -1
  142. package/dist/chunk-MNGGDB2G.js +0 -1
  143. package/dist/chunk-MY7BA4GI.cjs +0 -1
  144. package/dist/chunk-N2IJPIND.cjs +0 -1
  145. package/dist/chunk-NIMNTEGV.js +0 -1
  146. package/dist/chunk-PVJF2JHM.js +0 -1
  147. package/dist/chunk-QCFXEUKL.js +0 -1
  148. package/dist/chunk-QFCGBBSY.js +0 -1
  149. package/dist/chunk-QQYAUPSK.cjs +0 -1
  150. package/dist/chunk-TC4VBE4Y.cjs +0 -1
  151. package/dist/chunk-TUXDINHF.cjs +0 -1
  152. package/dist/chunk-U5Y2FXMN.cjs +0 -1
  153. package/dist/chunk-UUPQI6ND.cjs +0 -1
  154. package/dist/chunk-VYCGZ2S6.js +0 -1
  155. package/dist/chunk-W5EDKJK3.js +0 -1
  156. package/dist/chunk-WHAVUFEU.js +0 -1
  157. package/dist/chunk-XCFIOTCV.js +0 -1
  158. package/dist/chunk-XE27XPJR.js +0 -1
  159. package/dist/chunk-XVB3ZZEB.js +0 -1
  160. package/dist/chunk-ZBSIGJFO.cjs +0 -1
  161. package/dist/chunk-ZYAML74V.js +0 -1
  162. package/dist/extends-Mp81Hq9-.d.ts +0 -145
  163. package/dist/is-array-Ckm_47hw.d.ts +0 -1557
  164. package/dist/isPlainObject-BKYaI6a8.d.ts +0 -182
@@ -1,816 +1,741 @@
1
- import{c as Nilable}from'../nils-DMz3kU7M.js';
2
- /** ----------------------------------------------------------
3
- * * Capitalizes the first letter of a string.
4
- * * Optionally lowercases the rest and trims whitespace.
5
- * ----------------------------------------------------------
6
- *
7
- * @param string - The string to be processed.
8
- * @param options - Options to control behavior.
9
- * @param options.lowerCaseNextRest - If true, lowercases the rest (next first letter) (default: true).
10
- * @param options.trim - If true, trims the string before processing (default: false).
11
- * @returns The processed string. Returns "" if input is null, undefined, or not a valid string.
12
- *
13
- * @example
14
- * capitalizeFirst(" hello WORLD ") // " Hello world"
15
- * capitalizeFirst(" hello WORLD ", { trim: true }) // "Hello world"
16
- * capitalizeFirst("FOO", { lowerCaseNextRest: false }) // "FOO"
17
- * capitalizeFirst(" foo BAR ", { trim: true, lowerCaseNextRest: false }) // "Foo BAR"
18
- */
19
- declare const capitalizeFirst:(string?:string|null,options?:{
20
- /**
21
- * @description If true, the rest of the string will be converted to lowercase after capitalizing the first letter.
22
- * @default true
23
- */
1
+ import{c as Nilable}from'../nils-DMz3kU7M.js';import{E as Extends}from'../extends-Bk_SBGdT.js';import'../if-CvT4R7Kh.js';import'../never-BfayMBF9.js';type CapitalizeFirstOptions={
2
+ /** If true **(default)**, the rest of the string will be converted to lowercase after capitalizing the first letter.
3
+ *
4
+ * @default true
5
+ */
24
6
  lowerCaseNextRest?:boolean;
25
- /**
26
- * @description If true, the string will trimmed.
27
- * @default false
28
- */
29
- trim?:boolean;})=>string;
7
+ /** If true, the string will trimmed, default: `false`.
8
+ *
9
+ * @default false
10
+ */
11
+ trim?:boolean;};
30
12
  /** ----------------------------------------------------------
31
- * * ***Capitalizes the first letter of each word in a string
32
- * while converting the rest to lowercase.***
33
- * ----------------------------------------------------------
34
- *
35
- * @param value - The input string to be processed. If `null` or `undefined`, returns an empty string.
36
- * @param options - Optional settings to control the output:
37
- * - `trim`: If `true`, removes leading and trailing spaces, defaultValue: `false`.
38
- * - `collapseSpaces`: If `true`, collapses multiple spaces **between words** into a single space (while preserving leading/trailing spaces), defaultValue: `false`.
39
- *
40
- * @returns A new string where each word starts with an uppercase letter
41
- * and the remaining letters are lowercase. If `value` is empty, `null`, or `undefined`,
42
- * returns an empty string.
43
- *
44
- * @example
45
- * capitalizeWords(" hello world ");
46
- * // => " Hello World "
47
- *
48
- * capitalizeWords(" hello world ", { trim: true });
49
- * // => "Hello World"
50
- *
51
- * capitalizeWords(" hello world ", { collapseSpaces: true });
52
- * // => " Hello World "
53
- *
54
- * capitalizeWords(" hello world ", { trim: true, collapseSpaces: true });
55
- * // => "Hello World"
56
- */
57
- declare const capitalizeWords:(value?:string|null,options?:{
58
- /** If `true`, removes leading and trailing spaces, default `false`. */
13
+ * * ***Utility: `capitalizeFirst`.***
14
+ * ----------------------------------------------------------
15
+ * **Capitalizes the first letter of a string, with optionally lowercases the rest and trims whitespace.**
16
+ * @param {string | null | undefined} string - The string to be processed.
17
+ * @param {CapitalizeFirstOptions} [options] - Options to control behavior.
18
+ * @param {CapitalizeFirstOptions["lowerCaseNextRest"]} [options.lowerCaseNextRest=true] - If true, lowercases the rest (next first letter), default: `true`.
19
+ * @param {CapitalizeFirstOptions["trim"]} [options.trim=false] - If true, trims the string before processing, default: `false`.
20
+ * @returns {string} The processed string, returns `""` if input is `null`, `undefined`, or `not a valid string`.
21
+ * @example
22
+ * ```ts
23
+ * capitalizeFirst(" hello WORLD ")
24
+ * // " Hello world"
25
+ * capitalizeFirst(" hello WORLD ", { trim: true })
26
+ * // ➔ "Hello world"
27
+ * capitalizeFirst("FOO", { lowerCaseNextRest: false })
28
+ * // "FOO"
29
+ * capitalizeFirst(" foo BAR ", { trim: true, lowerCaseNextRest: false })
30
+ * // "Foo BAR"
31
+ * ```
32
+ * #### ℹ️ If null, undefined, or not a valid string input, return `""`.
33
+ * ```ts
34
+ * capitalizeFirst(123)
35
+ * capitalizeFirst(null)
36
+ * capitalizeFirst(undefined)
37
+ * // ""
38
+ * ```
39
+ */
40
+ declare const capitalizeFirst:(string:string|null|undefined,options?:CapitalizeFirstOptions)=>string;type CapitalizeWordsOptions={
41
+ /** If `true`, removes leading and trailing spaces, default `false`.
42
+ *
43
+ * @default false
44
+ */
59
45
  trim?:boolean;
60
- /** If `true`, collapses multiple spaces **between words** into a single space (while preserving leading/trailing spaces), default `false`. */
61
- collapseSpaces?:boolean;})=>string;
46
+ /** If `true`, collapses multiple spaces **between words** into a single space (while preserving leading/trailing spaces), default `false`.
47
+ *
48
+ * @default false
49
+ */
50
+ collapseSpaces?:boolean;};
51
+ /** ----------------------------------------------------------
52
+ * * ***Utility: `capitalizeWords`.***
53
+ * ----------------------------------------------------------
54
+ * **Capitalizes the first letter of each word in a string while converting the rest to lowercase.**
55
+ * @param {string | null | undefined} value
56
+ * The input string to be processed.
57
+ * - If `null` or `undefined`, returns an empty-string (`""`).
58
+ * @param {CapitalizeWordsOptions} [options]
59
+ * Optional settings to control the output:
60
+ * - `trim`: If `true`, removes leading and trailing spaces, defaultValue: `false`.
61
+ * - `collapseSpaces`: If `true`, collapses multiple spaces **between words** into a single space (while preserving leading/trailing spaces), defaultValue: `false`.
62
+ * @returns {string} A new string where each word starts with an uppercase letter
63
+ * and the remaining letters are lowercase.
64
+ * - If `value` is `empty`, `null`, or `undefined`, returns an `empty-string`.
65
+ * @example
66
+ * ```ts
67
+ * capitalizeWords(" hello world ");
68
+ * // ➔ " Hello World "
69
+ * capitalizeWords(" hello world ", { trim: true });
70
+ * // ➔ "Hello World"
71
+ * capitalizeWords(" hello world ", { collapseSpaces: true });
72
+ * // ➔ " Hello World "
73
+ * capitalizeWords(" hello world ", { trim: true, collapseSpaces: true });
74
+ * // ➔ "Hello World"
75
+ * ```
76
+ * #### ℹ️ If null, undefined, or not a valid string input, return "".
77
+ * ```ts
78
+ * capitalizeWords(123);
79
+ * capitalizeWords(null);
80
+ * capitalizeWords(undefined);
81
+ * // ➔ ""
82
+ * ```
83
+ */
84
+ declare const capitalizeWords:(value:string|null|undefined,options?:CapitalizeWordsOptions)=>string;
62
85
  /** --------------------------------------------------
63
- * * ***Represents a string input that may be:***
64
- * - a single string,
65
- * - an array of strings,
66
- * - a readonly array of strings,
67
- * - or `null` / `undefined`.
68
- * --------------------------------------------------
69
- *
70
- * @template T A string or array of strings.
71
- */
86
+ * * ***Represents a string input.***
87
+ * --------------------------------------------------
88
+ *
89
+ * - **Can be one of:**
90
+ * - A single `string`
91
+ * - An array of strings (`string[]`)
92
+ * - A readonly array of strings (`readonly string[]`)
93
+ * - `null` or `undefined`
94
+ *
95
+ * @template T - A string or array of strings.
96
+ */
72
97
  type StringLike=Nilable<string|string[]|ReadonlyArray<string>>;
73
98
  /** --------------------------------------------------
74
- * * ***Represents a collection of strings, which can be:***
75
- * - a single string,
76
- * - an array of strings,
77
- * - a readonly array of strings,
78
- * - a `Set` of strings, or
79
- * - a `ReadonlySet` of strings.
80
- * --------------------------------------------------
81
- */
99
+ * * ***Represents a collection of strings.***
100
+ * --------------------------------------------------
101
+ *
102
+ * - **Can be one of:**
103
+ * - A single `string`
104
+ * - An array of strings (`string[]`)
105
+ * - A readonly array of strings (`readonly string[]`)
106
+ * - A `Set<string>`
107
+ * - A `ReadonlySet<string>`
108
+ */
82
109
  type StringCollection=string|string[]|ReadonlyArray<string>|Set<string>|ReadonlySet<string>;
83
110
  /** ----------------------------------------------------------
84
- * * ***Converts a string (or array of strings) into `camelCase`, with optionally leaving specific words unchanged.***
85
- * ----------------------------------------------------------
86
- *
87
- * @description
88
- * - Accepts a `string` or an array of `strings`:
89
- * - If an array is provided, elements are trimmed, empty ones removed,
90
- * then joined with `"-"` before conversion.
91
- * - Splits the input by non-alphanumeric characters
92
- * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
93
- * - The first word is fully lowercase; subsequent words are capitalized.
94
- * - Words listed in `ignoreWord` remain unchanged in the output.
95
- * - `ignoreWord` is normalized (trimmed, delimiters removed); empty values ignored.
96
- * - `ignoreWord` accepts:
97
- * - a single string,
98
- * - an array of strings, or
99
- * - a `Set` of strings.
100
- * - Multiple delimiters collapse into one; empty segments ignored.
101
- * - Returns `""` if the input is `null`, `undefined`, or empty.
102
- *
103
- * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
104
- * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
105
- * @returns {string} The camelCase formatted string.
106
- *
107
- * @example
108
- * // Basic usage
109
- * toCamelCase("hello world");
110
- * // "helloWorld"
111
- *
112
- * @example
113
- * // Array input is joined before conversion
114
- * toCamelCase(["Join", "Words", "Here"]);
115
- * // "joinWordsHere"
116
- *
117
- * @example
118
- * // Supports mixed delimiters
119
- * toCamelCase("convert_to-camel case");
120
- * // ➔ "convertToCamelCase"
121
- *
122
- * @example
123
- * // Words in ignoreWord stay unchanged
124
- * toCamelCase("this URL path will ignore", "URL");
125
- * // ➔ "thisURLPathWillIgnore"
126
- *
127
- * @example
128
- * // Multiple ignored words
129
- * toCamelCase("ignore API and URL", ["API", "URL"]);
130
- * // "ignoreAPIAndURL"
131
- *
132
- * @example
133
- * // Set can also be used
134
- * toCamelCase("ignore API and URL", new Set(["API", "URL"]));
135
- * // ➔ "ignoreAPIAndURL"
136
- *
137
- * @example
138
- * // Null or empty input returns empty string
139
- * toCamelCase(null);
140
- * // ➔ ""
141
- */
111
+ * * ***Utility: `toCamelCase`.***
112
+ * ----------------------------------------------------------
113
+ * **Converts a string (or array of strings) into `camelCase`, with optionally leaving specific words unchanged.**
114
+ * - **Behavior:**
115
+ * - Accepts a `string` or an `array of strings`:
116
+ * - If an array is provided, elements are trimmed, empty ones removed,
117
+ * then joined with `"-"` before conversion.
118
+ * - Splits the input by non-alphanumeric characters
119
+ * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
120
+ * - The first word is fully lowercase; subsequent words are capitalized.
121
+ * - Words listed in `ignoreWord` remain unchanged in the output.
122
+ * - `ignoreWord` is normalized (trimmed, delimiters removed), empty values ignored.
123
+ * - `ignoreWord` accepts:
124
+ * - a single string,
125
+ * - an array of strings, or
126
+ * - a `Set` of strings.
127
+ * - Multiple delimiters collapse into one; empty segments ignored.
128
+ * - Returns `""` if the input is `null`, `undefined`, or empty.
129
+ * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
130
+ * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
131
+ * @returns {string} The camelCase formatted string.
132
+ * @example
133
+ * // Basic usage
134
+ * toCamelCase("hello world");
135
+ * // "helloWorld"
136
+ *
137
+ * // Array input is joined before conversion
138
+ * toCamelCase(["Join", "Words", "Here"]);
139
+ * // ➔ "joinWordsHere"
140
+ *
141
+ * // Supports mixed delimiters
142
+ * toCamelCase("convert_to-camel case");
143
+ * // ➔ "convertToCamelCase"
144
+ *
145
+ * // Words in ignoreWord stay unchanged
146
+ * toCamelCase("this URL path will ignore", "URL");
147
+ * // ➔ "thisURLPathWillIgnore"
148
+ *
149
+ * // Multiple ignored words
150
+ * toCamelCase("ignore API and URL", ["API", "URL"]);
151
+ * // "ignoreAPIAndURL"
152
+ *
153
+ * // Set can also be used
154
+ * toCamelCase("ignore API and URL", new Set(["API", "URL"]));
155
+ * // "ignoreAPIAndURL"
156
+ *
157
+ * // Null, Undefined or empty (string or array) input returns empty string
158
+ * toCamelCase(null);
159
+ * // ➔ ""
160
+ */
142
161
  declare const toCamelCase:(input:StringLike,ignoreWord?:StringCollection)=>string;
143
162
  /** ----------------------------------------------------------
144
- * * ***Converts a string (or array of strings) into `PascalCaseSpace`, with optionally leaving specific words unchanged.***
145
- * ----------------------------------------------------------
146
- *
147
- * @description
148
- * - Accepts a `string` or an array of `strings`:
149
- * - If an array is provided, elements are trimmed, empty ones removed,
150
- * then joined with `"-"` before conversion.
151
- * - Splits the input by non-alphanumeric characters
152
- * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
153
- * - The first word is fully lowercase; subsequent words are capitalized.
154
- * - Words listed in `ignoreWord` remain unchanged in the output.
155
- * - `ignoreWord` is normalized (trimmed, delimiters removed); empty values ignored.
156
- * - `ignoreWord` accepts:
157
- * - a single string,
158
- * - an array of strings, or
159
- * - a `Set` of strings.
160
- * - Multiple delimiters collapse into one; empty segments ignored.
161
- * - Returns `""` if the input is `null`, `undefined`, or empty.
162
- *
163
- * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
164
- * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
165
- * @returns {string} The PascalCaseSpace formatted string.
166
- *
167
- * @example
168
- * // Basic usage
169
- * toPascalCaseSpace("hello world");
170
- * // "Hello World"
171
- *
172
- * @example
173
- * // Array input is joined before conversion
174
- * toPascalCaseSpace(["Join", "Words", "Here"]);
175
- * // ➔ "Join Words Here"
176
- *
177
- * @example
178
- * // Handles underscores and hyphens
179
- * toPascalCaseSpace("convert_to-pascal case");
180
- * // ➔ "Convert To Pascal Case Space"
181
- *
182
- * @example
183
- * // Trims extra delimiters
184
- * toPascalCaseSpace("___hello--world__ again!!");
185
- * // ➔ "Hello World Again"
186
- *
187
- * @example
188
- * // Supports emojis and symbols
189
- * toPascalCaseSpace("🔥fire_and-ice❄️");
190
- * // "Fire And Ice"
191
- *
192
- * @example
193
- * // Ignore single word
194
- * toPascalCaseSpace("this URL path will ignore", "URL");
195
- * // "This URL Path Will Ignore"
196
- *
197
- * @example
198
- * // Ignore multiple words
199
- * toPascalCaseSpace("ignore API and URL", ["API", "URL"]);
200
- * // ➔ "Ignore API And URL"
201
- *
202
- * @example
203
- * // Ignore using Set
204
- * toPascalCaseSpace("ignore API and URL", new Set(["API", "URL"]));
205
- * // ➔ "Ignore API And URL"
206
- *
207
- * @example
208
- * // Null or empty returns empty string
209
- * toPascalCaseSpace(undefined);
210
- * // ➔ ""
211
- */
163
+ * * ***Utility: `toPascalCaseSpace`.***
164
+ * ----------------------------------------------------------
165
+ * **Converts a string (or array of strings) into `PascalCaseSpace`, with optionally leaving specific words unchanged.**
166
+ * - **Behavior:**
167
+ * - Accepts a `string` or an `array of strings`:
168
+ * - If an array is provided, elements are trimmed, empty ones removed,
169
+ * then joined with `"-"` before conversion.
170
+ * - Splits the input by non-alphanumeric characters
171
+ * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
172
+ * - The first word is fully lowercase; subsequent words are capitalized.
173
+ * - Words listed in `ignoreWord` remain unchanged in the output.
174
+ * - `ignoreWord` is normalized (trimmed, delimiters removed), empty values ignored.
175
+ * - `ignoreWord` accepts:
176
+ * - a single string,
177
+ * - an array of strings, or
178
+ * - a `Set` of strings.
179
+ * - Multiple delimiters collapse into one; empty segments ignored.
180
+ * - Returns `""` if the input is `null`, `undefined`, or empty.
181
+ * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
182
+ * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
183
+ * @returns {string} The PascalCaseSpace formatted string.
184
+ * @example
185
+ * // Basic usage
186
+ * toPascalCaseSpace("hello world");
187
+ * // "Hello World"
188
+ *
189
+ * // Array input is joined before conversion
190
+ * toPascalCaseSpace(["Join", "Words", "Here"]);
191
+ * // ➔ "Join Words Here"
192
+ *
193
+ * // Handles underscores and hyphens
194
+ * toPascalCaseSpace("convert_to-pascal case");
195
+ * // ➔ "Convert To Pascal Case Space"
196
+ *
197
+ * // Trims extra delimiters
198
+ * toPascalCaseSpace("___hello--world__ again!!");
199
+ * // ➔ "Hello World Again"
200
+ *
201
+ * // Supports emojis and symbols
202
+ * toPascalCaseSpace("🔥fire_and-ice❄️");
203
+ * // ➔ "Fire And Ice"
204
+ *
205
+ * // Ignore single word
206
+ * toPascalCaseSpace("this URL path will ignore", "URL");
207
+ * // "This URL Path Will Ignore"
208
+ *
209
+ * // Ignore multiple words
210
+ * toPascalCaseSpace("ignore API and URL", ["API", "URL"]);
211
+ * // ➔ "Ignore API And URL"
212
+ *
213
+ * // Ignore using Set
214
+ * toPascalCaseSpace("ignore API and URL", new Set(["API", "URL"]));
215
+ * // ➔ "Ignore API And URL"
216
+ *
217
+ * // Null, Undefined or empty (string or array) input returns empty string
218
+ * toPascalCaseSpace(undefined);
219
+ * // ➔ ""
220
+ */
212
221
  declare const toPascalCaseSpace:(input:StringLike,ignoreWord?:StringCollection)=>string;
213
222
  /** ----------------------------------------------------------
214
- * * ***Converts a string (or array of strings) into `PascalCase`, with optionally leaving specific words unchanged.***
215
- * ----------------------------------------------------------
216
- *
217
- * @description
218
- * - Accepts a `string` or an array of `strings`:
219
- * - If an array is provided, elements are trimmed, empty ones removed,
220
- * then joined with `"-"` before conversion.
221
- * - Splits the input by non-alphanumeric characters
222
- * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
223
- * - The first word is fully lowercase; subsequent words are capitalized.
224
- * - Words listed in `ignoreWord` remain unchanged in the output.
225
- * - `ignoreWord` is normalized (trimmed, delimiters removed); empty values ignored.
226
- * - `ignoreWord` accepts:
227
- * - a single string,
228
- * - an array of strings, or
229
- * - a `Set` of strings.
230
- * - Multiple delimiters collapse into one; empty segments ignored.
231
- * - Returns `""` if the input is `null`, `undefined`, or empty.
232
- *
233
- * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
234
- * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
235
- * @returns {string} The PascalCase formatted string.
236
- *
237
- * @example
238
- * // Basic usage
239
- * toPascalCase("hello world");
240
- * // "HelloWorld"
241
- *
242
- * @example
243
- * // Array input is joined before conversion
244
- * toPascalCase(["Join", "Words", "Here"]);
245
- * // "JoinWordsHere"
246
- *
247
- * @example
248
- * // Handles underscores and hyphens
249
- * toPascalCase("convert_to-pascal case");
250
- * // ➔ "ConvertToPascalCase"
251
- *
252
- * @example
253
- * // Trims extra delimiters
254
- * toPascalCase("___hello--world__ again!!");
255
- * // ➔ "HelloWorldAgain"
256
- *
257
- * @example
258
- * // Supports emojis and symbols
259
- * toPascalCase("🔥fire_and-ice❄️");
260
- * // "FireAndIce"
261
- *
262
- * @example
263
- * // Ignore single word
264
- * toPascalCase("this URL path will ignore", "URL");
265
- * // "ThisURLPathWillIgnore"
266
- *
267
- * @example
268
- * // Ignore multiple words
269
- * toPascalCase("ignore API and URL", ["API", "URL"]);
270
- * // ➔ "IgnoreAPIAndURL"
271
- *
272
- * @example
273
- * // Ignore using Set
274
- * toPascalCase("ignore API and URL", new Set(["API", "URL"]));
275
- * // ➔ "IgnoreAPIAndURL"
276
- *
277
- * @example
278
- * // Null or empty returns empty string
279
- * toPascalCase(undefined);
280
- * // ➔ ""
281
- */
223
+ * * ***Utility: `toPascalCase`.***
224
+ * ----------------------------------------------------------
225
+ * **Converts a string (or array of strings) into `PascalCase`, with optionally leaving specific words unchanged.**
226
+ * - **Behavior:**
227
+ * - Accepts a `string` or an `array of strings`:
228
+ * - If an array is provided, elements are trimmed, empty ones removed,
229
+ * then joined with `"-"` before conversion.
230
+ * - Splits the input by non-alphanumeric characters
231
+ * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
232
+ * - The first word is fully lowercase; subsequent words are capitalized.
233
+ * - Words listed in `ignoreWord` remain unchanged in the output.
234
+ * - `ignoreWord` is normalized (trimmed, delimiters removed), empty values ignored.
235
+ * - `ignoreWord` accepts:
236
+ * - a single string,
237
+ * - an array of strings, or
238
+ * - a `Set` of strings.
239
+ * - Multiple delimiters collapse into one; empty segments ignored.
240
+ * - Returns `""` if the input is `null`, `undefined`, or empty.
241
+ * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
242
+ * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
243
+ * @returns {string} The PascalCase formatted string.
244
+ * @example
245
+ * // Basic usage
246
+ * toPascalCase("hello world");
247
+ * // "HelloWorld"
248
+ *
249
+ * // Array input is joined before conversion
250
+ * toPascalCase(["Join", "Words", "Here"]);
251
+ * // ➔ "JoinWordsHere"
252
+ *
253
+ * // Handles underscores and hyphens
254
+ * toPascalCase("convert_to-pascal case");
255
+ * // ➔ "ConvertToPascalCase"
256
+ *
257
+ * // Trims extra delimiters
258
+ * toPascalCase("___hello--world__ again!!");
259
+ * // ➔ "HelloWorldAgain"
260
+ *
261
+ * // Supports emojis and symbols
262
+ * toPascalCase("🔥fire_and-ice❄️");
263
+ * // "FireAndIce"
264
+ *
265
+ * // Ignore single word
266
+ * toPascalCase("this URL path will ignore", "URL");
267
+ * // "ThisURLPathWillIgnore"
268
+ *
269
+ * // Ignore multiple words
270
+ * toPascalCase("ignore API and URL", ["API", "URL"]);
271
+ * // ➔ "IgnoreAPIAndURL"
272
+ *
273
+ * // Ignore using Set
274
+ * toPascalCase("ignore API and URL", new Set(["API", "URL"]));
275
+ * // ➔ "IgnoreAPIAndURL"
276
+ *
277
+ * // Null, Undefined or empty (string or array) input returns empty string
278
+ * toPascalCase(undefined);
279
+ * // ➔ ""
280
+ */
282
281
  declare const toPascalCase:(input:StringLike,ignoreWord?:StringCollection)=>string;
283
282
  /** ----------------------------------------------------------
284
- * * ***Converts a string (or array of strings) into `LowerCase`, with optionally leaving specific words unchanged.***
285
- * ----------------------------------------------------------
286
- *
287
- * @description
288
- * - Accepts a `string` or an array of `strings`:
289
- * - If an array is provided, elements are trimmed, empty ones removed,
290
- * then joined with `"-"` before conversion.
291
- * - Splits the input by non-alphanumeric characters
292
- * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
293
- * - The first word is fully lowercase; subsequent words are capitalized.
294
- * - Words listed in `ignoreWord` remain unchanged in the output.
295
- * - `ignoreWord` is normalized (trimmed, delimiters removed); empty values ignored.
296
- * - `ignoreWord` accepts:
297
- * - a single string,
298
- * - an array of strings, or
299
- * - a `Set` of strings.
300
- * - Multiple delimiters collapse into one; empty segments ignored.
301
- * - Returns `""` if the input is `null`, `undefined`, or empty.
302
- *
303
- * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
304
- * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
305
- * @returns {string} The LowerCase formatted string.
306
- *
307
- * @example
308
- * // Basic usage
309
- * toLowerCase("Hello World");
310
- * // "hello world"
311
- *
312
- * @example
313
- * // Array input is joined before conversion
314
- * toLowerCase(["Join", "WORLD", "Here"]);
315
- * // ➔ "join words here"
316
- *
317
- * @example
318
- * // Handles underscores and hyphens
319
- * toLowerCase("convert_to-pascal case");
320
- * // ➔ "convert to lower case"
321
- *
322
- * @example
323
- * // Trims extra delimiters
324
- * toLowerCase("___hello--world__ again!!");
325
- * // ➔ "hello world again"
326
- *
327
- * @example
328
- * // Supports emojis and symbols
329
- * toLowerCase("🔥fire_and-ice❄️");
330
- * // "fire and ice"
331
- *
332
- * @example
333
- * // Ignore single word
334
- * toLowerCase("this URL path will ignore", "URL");
335
- * // "this URL path will ignore"
336
- *
337
- * @example
338
- * // Ignore multiple words
339
- * toLowerCase("ignore API and URL", ["API", "URL"]);
340
- * // ➔ "ignore API and URL"
341
- *
342
- * @example
343
- * // Ignore using Set
344
- * toLowerCase("ignore API and URL", new Set(["API", "URL"]));
345
- * // ➔ "ignore API and URL"
346
- *
347
- * @example
348
- * // Null or empty returns empty string
349
- * toLowerCase(undefined);
350
- * // ➔ ""
351
- */
283
+ * * ***Utility: `toLowerCase`.***
284
+ * ----------------------------------------------------------
285
+ * **Converts a string (or array of strings) into `lower case`, with optionally leaving specific words unchanged.**
286
+ * - **Behavior:**
287
+ * - Accepts a `string` or an `array of strings`:
288
+ * - If an array is provided, elements are trimmed, empty ones removed,
289
+ * then joined with `"-"` before conversion.
290
+ * - Splits the input by non-alphanumeric characters
291
+ * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
292
+ * - The first word is fully lowercase; subsequent words are capitalized.
293
+ * - Words listed in `ignoreWord` remain unchanged in the output.
294
+ * - `ignoreWord` is normalized (trimmed, delimiters removed), empty values ignored.
295
+ * - `ignoreWord` accepts:
296
+ * - a single string,
297
+ * - an array of strings, or
298
+ * - a `Set` of strings.
299
+ * - Multiple delimiters collapse into one; empty segments ignored.
300
+ * - Returns `""` if the input is `null`, `undefined`, or empty.
301
+ * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
302
+ * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
303
+ * @returns {string} The LowerCase formatted string.
304
+ * @example
305
+ * // Basic usage
306
+ * toLowerCase("Hello World");
307
+ * // "hello world"
308
+ *
309
+ * // Array input is joined before conversion
310
+ * toLowerCase(["Join", "WORLD", "Here"]);
311
+ * // ➔ "join words here"
312
+ *
313
+ * // Handles underscores and hyphens
314
+ * toLowerCase("convert_to-pascal case");
315
+ * // ➔ "convert to lower case"
316
+ *
317
+ * // Trims extra delimiters
318
+ * toLowerCase("___hello--world__ again!!");
319
+ * // ➔ "hello world again"
320
+ *
321
+ * // Supports emojis and symbols
322
+ * toLowerCase("🔥fire_and-ice❄️");
323
+ * // ➔ "fire and ice"
324
+ *
325
+ * // Ignore single word
326
+ * toLowerCase("this URL path will ignore", "URL");
327
+ * // "this URL path will ignore"
328
+ *
329
+ * // Ignore multiple words
330
+ * toLowerCase("ignore API and URL", ["API", "URL"]);
331
+ * // ➔ "ignore API and URL"
332
+ *
333
+ * // Ignore using Set
334
+ * toLowerCase("ignore API and URL", new Set(["API", "URL"]));
335
+ * // ➔ "ignore API and URL"
336
+ *
337
+ * // Null, Undefined or empty (string or array) input returns empty string
338
+ * toLowerCase(undefined);
339
+ * // ➔ ""
340
+ */
352
341
  declare const toLowerCase:(input:StringLike,ignoreWord?:StringCollection)=>string;
353
342
  /** ----------------------------------------------------------
354
- * * ***Converts a string (or array of strings) into `kebab-case`, with optionally leaving specific words unchanged.***
355
- * ----------------------------------------------------------
356
- *
357
- * @description
358
- * - Accepts a `string` or an array of `strings`:
359
- * - If an array is provided, elements are trimmed, empty ones removed,
360
- * then joined with `"-"` before conversion.
361
- * - Splits the input by non-alphanumeric characters
362
- * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
363
- * - The first word is fully lowercase; subsequent words are capitalized.
364
- * - Words listed in `ignoreWord` remain unchanged in the output.
365
- * - `ignoreWord` is normalized (trimmed, delimiters removed); empty values ignored.
366
- * - `ignoreWord` accepts:
367
- * - a single string,
368
- * - an array of strings, or
369
- * - a `Set` of strings.
370
- * - Multiple delimiters collapse into one; empty segments ignored.
371
- * - Returns `""` if the input is `null`, `undefined`, or empty.
372
- *
373
- * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
374
- * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
375
- * @returns {string} The kebab-case formatted string.
376
- *
377
- * @example
378
- * // Basic usage
379
- * toKebabCase("Hello World");
380
- * // "hello-world"
381
- *
382
- * @example
383
- * // Array input is joined before conversion
384
- * toKebabCase(["Join", "Words", "Here"]);
385
- * // ➔ "join-words-here"
386
- *
387
- * @example
388
- * // Handles underscores and hyphens
389
- * toKebabCase("convert_to-kebab case");
390
- * // ➔ "convert-to-kebab-case"
391
- *
392
- * @example
393
- * // Handles emojis and symbols
394
- * toKebabCase("🔥fire___and--ice❄️");
395
- * // ➔ "fire-and-ice"
396
- *
397
- * @example
398
- * // Ignore specific word
399
- * toKebabCase("ignore URL case", "URL");
400
- * // "ignore-URL-case"
401
- *
402
- * @example
403
- * // Ignore multiple words
404
- * toKebabCase("ignore API and URL", ["API", "URL"]);
405
- * // ➔ "ignore-API-and-URL"
406
- *
407
- * @example
408
- * // Ignore with Set
409
- * toKebabCase("ignore API and URL", new Set(["API", "URL"]));
410
- * // ➔ "ignore-API-and-URL"
411
- *
412
- * @example
413
- * // Null or empty input
414
- * toKebabCase(null);
415
- * // ➔ ""
416
- */
343
+ * * ***Utility: `toKebabCase`.***
344
+ * ----------------------------------------------------------
345
+ * **Converts a string (or array of strings) into `kebab-case`, with optionally leaving specific words unchanged.**
346
+ * - **Behavior:**
347
+ * - Accepts a `string` or an `array of strings`:
348
+ * - If an array is provided, elements are trimmed, empty ones removed,
349
+ * then joined with `"-"` before conversion.
350
+ * - Splits the input by non-alphanumeric characters
351
+ * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
352
+ * - The first word is fully lowercase; subsequent words are capitalized.
353
+ * - Words listed in `ignoreWord` remain unchanged in the output.
354
+ * - `ignoreWord` is normalized (trimmed, delimiters removed), empty values ignored.
355
+ * - `ignoreWord` accepts:
356
+ * - a single string,
357
+ * - an array of strings, or
358
+ * - a `Set` of strings.
359
+ * - Multiple delimiters collapse into one; empty segments ignored.
360
+ * - Returns `""` if the input is `null`, `undefined`, or empty.
361
+ * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
362
+ * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
363
+ * @returns {string} The kebab-case formatted string.
364
+ * @example
365
+ * // Basic usage
366
+ * toKebabCase("Hello World");
367
+ * // "hello-world"
368
+ *
369
+ * // Array input is joined before conversion
370
+ * toKebabCase(["Join", "Words", "Here"]);
371
+ * // ➔ "join-words-here"
372
+ *
373
+ * // Handles underscores and hyphens
374
+ * toKebabCase("convert_to-kebab case");
375
+ * // ➔ "convert-to-kebab-case"
376
+ *
377
+ * // Handles emojis and symbols
378
+ * toKebabCase("🔥fire___and--ice❄️");
379
+ * // ➔ "fire-and-ice"
380
+ *
381
+ * // Ignore specific word
382
+ * toKebabCase("ignore URL case", "URL");
383
+ * // ➔ "ignore-URL-case"
384
+ *
385
+ * // Ignore multiple words
386
+ * toKebabCase("ignore API and URL", ["API", "URL"]);
387
+ * // "ignore-API-and-URL"
388
+ *
389
+ * // Ignore with Set
390
+ * toKebabCase("ignore API and URL", new Set(["API", "URL"]));
391
+ * // ➔ "ignore-API-and-URL"
392
+ *
393
+ * // Null, Undefined or empty (string or array) input returns empty string
394
+ * toKebabCase(null);
395
+ * // ➔ ""
396
+ */
417
397
  declare const toKebabCase:(input:StringLike,ignoreWord?:StringCollection)=>string;
418
398
  /** ----------------------------------------------------------
419
- * * ***Converts a string (or array of strings) into `snake_case`, with optionally leaving specific words unchanged.***
420
- * ----------------------------------------------------------
421
- *
422
- * @description
423
- * - Accepts a `string` or an array of `strings`:
424
- * - If an array is provided, elements are trimmed, empty ones removed,
425
- * then joined with `"-"` before conversion.
426
- * - Splits the input by non-alphanumeric characters
427
- * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
428
- * - The first word is fully lowercase; subsequent words are capitalized.
429
- * - Words listed in `ignoreWord` remain unchanged in the output.
430
- * - `ignoreWord` is normalized (trimmed, delimiters removed); empty values ignored.
431
- * - `ignoreWord` accepts:
432
- * - a single string,
433
- * - an array of strings, or
434
- * - a `Set` of strings.
435
- * - Multiple delimiters collapse into one; empty segments ignored.
436
- * - Returns `""` if the input is `null`, `undefined`, or empty.
437
- *
438
- * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
439
- * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
440
- * @returns {string} The snake_case formatted string.
441
- *
442
- * @example
443
- * // Basic usage
444
- * toSnakeCase("Hello World");
445
- * // "hello_world"
446
- *
447
- * @example
448
- * // Array input is joined before conversion
449
- * toSnakeCase(["Join", "Words", "Here"]);
450
- * // "join_words_here"
451
- *
452
- * @example
453
- * // Handles underscores, hyphens, spaces
454
- * toSnakeCase("convert-to_snake case");
455
- * // ➔ "convert_to_snake_case"
456
- *
457
- * @example
458
- * // Handles emojis and symbols
459
- * toSnakeCase("🔥fire___and--ice❄️");
460
- * // ➔ "fire_and_ice"
461
- *
462
- * @example
463
- * // Ignore specific word
464
- * toSnakeCase("ignore URL case", "URL");
465
- * // "ignore_URL_case"
466
- *
467
- * @example
468
- * // Ignore multiple words
469
- * toSnakeCase("ignore API and URL", ["API", "URL"]);
470
- * // ➔ "ignore_API_and_URL"
471
- *
472
- * @example
473
- * // Ignore with Set
474
- * toSnakeCase("ignore API and URL", new Set(["API", "URL"]));
475
- * // ➔ "ignore_API_and_URL"
476
- *
477
- * @example
478
- * // Null or empty input
479
- * toSnakeCase(null);
480
- * // ➔ ""
481
- */
399
+ * * ***Utility: `toSnakeCase`.***
400
+ * ----------------------------------------------------------
401
+ * **Converts a string (or array of strings) into `snake_case`, with optionally leaving specific words unchanged.**
402
+ * - **Behavior:**
403
+ * - Accepts a `string` or an `array of strings`:
404
+ * - If an array is provided, elements are trimmed, empty ones removed,
405
+ * then joined with `"-"` before conversion.
406
+ * - Splits the input by non-alphanumeric characters
407
+ * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
408
+ * - The first word is fully lowercase; subsequent words are capitalized.
409
+ * - Words listed in `ignoreWord` remain unchanged in the output.
410
+ * - `ignoreWord` is normalized (trimmed, delimiters removed), empty values ignored.
411
+ * - `ignoreWord` accepts:
412
+ * - a single string,
413
+ * - an array of strings, or
414
+ * - a `Set` of strings.
415
+ * - Multiple delimiters collapse into one; empty segments ignored.
416
+ * - Returns `""` if the input is `null`, `undefined`, or empty.
417
+ * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
418
+ * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
419
+ * @returns {string} The snake_case formatted string.
420
+ * @example
421
+ * // Basic usage
422
+ * toSnakeCase("Hello World");
423
+ * // "hello_world"
424
+ *
425
+ * // Array input is joined before conversion
426
+ * toSnakeCase(["Join", "Words", "Here"]);
427
+ * // ➔ "join_words_here"
428
+ *
429
+ * // Handles underscores, hyphens, spaces
430
+ * toSnakeCase("convert-to_snake case");
431
+ * // ➔ "convert_to_snake_case"
432
+ *
433
+ * // Handles emojis and symbols
434
+ * toSnakeCase("🔥fire___and--ice❄️");
435
+ * // ➔ "fire_and_ice"
436
+ *
437
+ * // Ignore specific word
438
+ * toSnakeCase("ignore URL case", "URL");
439
+ * // ➔ "ignore_URL_case"
440
+ *
441
+ * // Ignore multiple words
442
+ * toSnakeCase("ignore API and URL", ["API", "URL"]);
443
+ * // "ignore_API_and_URL"
444
+ *
445
+ * // Ignore with Set
446
+ * toSnakeCase("ignore API and URL", new Set(["API", "URL"]));
447
+ * // ➔ "ignore_API_and_URL"
448
+ *
449
+ * // Null, Undefined or empty (string or array) input returns empty string
450
+ * toSnakeCase(null);
451
+ * // ➔ ""
452
+ */
482
453
  declare const toSnakeCase:(input:StringLike,ignoreWord?:StringCollection)=>string;
483
454
  /** ----------------------------------------------------------
484
- * * ***Converts a string (or array of strings) into `dot.case`, with optionally leaving specific words unchanged.***
485
- * ----------------------------------------------------------
486
- *
487
- * @description
488
- * - Accepts a `string` or an array of `strings`:
489
- * - If an array is provided, elements are trimmed, empty ones removed,
490
- * then joined with `"-"` before conversion.
491
- * - Splits the input by non-alphanumeric characters
492
- * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
493
- * - The first word is fully lowercase; subsequent words are capitalized.
494
- * - Words listed in `ignoreWord` remain unchanged in the output.
495
- * - `ignoreWord` is normalized (trimmed, delimiters removed); empty values ignored.
496
- * - `ignoreWord` accepts:
497
- * - a single string,
498
- * - an array of strings, or
499
- * - a `Set` of strings.
500
- * - Multiple delimiters collapse into one; empty segments ignored.
501
- * - Returns `""` if the input is `null`, `undefined`, or empty.
502
- *
503
- * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
504
- * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
505
- * @returns {string} The dot.case formatted string.
506
- *
507
- * @example
508
- * // Basic usage
509
- * toDotCase("Hello World");
510
- * // "hello.world"
511
- *
512
- * @example
513
- * // Array input is joined before conversion
514
- * toDotCase(["Join", "Words", "Here"]);
515
- * // "join.words.here"
516
- *
517
- * @example
518
- * // Handles underscores and hyphens
519
- * toDotCase("convert-to_dot case");
520
- * // ➔ "convert.to.dot.case"
521
- *
522
- * @example
523
- * // Multiple delimiters and trimming
524
- * toDotCase("___Hello--World__ again!!");
525
- * // ➔ "hello.world.again"
526
- *
527
- * @example
528
- * // Supports emojis and symbols
529
- * toDotCase("🔥Fire_and-ice❄️");
530
- * // "fire.and.ice"
531
- *
532
- * @example
533
- * // Ignore single word
534
- * toDotCase("this URL path", "URL");
535
- * // "this.URL.path"
536
- *
537
- * @example
538
- * // Ignore multiple words
539
- * toDotCase("ignore API and URL", ["API", "URL"]);
540
- * // ➔ "ignore.API.and.URL"
541
- *
542
- * @example
543
- * // Ignore using Set
544
- * toDotCase("ignore API and URL", new Set(["API", "URL"]));
545
- * // ➔ "ignore.API.and.URL"
546
- *
547
- * @example
548
- * // Null or empty returns empty string
549
- * toDotCase(undefined);
550
- * // ➔ ""
551
- */
455
+ * * ***Utility: `toDotCase`.***
456
+ * ----------------------------------------------------------
457
+ * **Converts a string (or array of strings) into `dot.case`, with optionally leaving specific words unchanged.**
458
+ * - **Behavior:**
459
+ * - Accepts a `string` or an `array of strings`:
460
+ * - If an array is provided, elements are trimmed, empty ones removed,
461
+ * then joined with `"-"` before conversion.
462
+ * - Splits the input by non-alphanumeric characters
463
+ * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
464
+ * - The first word is fully lowercase; subsequent words are capitalized.
465
+ * - Words listed in `ignoreWord` remain unchanged in the output.
466
+ * - `ignoreWord` is normalized (trimmed, delimiters removed), empty values ignored.
467
+ * - `ignoreWord` accepts:
468
+ * - a single string,
469
+ * - an array of strings, or
470
+ * - a `Set` of strings.
471
+ * - Multiple delimiters collapse into one; empty segments ignored.
472
+ * - Returns `""` if the input is `null`, `undefined`, or empty.
473
+ * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
474
+ * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
475
+ * @returns {string} The dot.case formatted string.
476
+ * @example
477
+ * // Basic usage
478
+ * toDotCase("Hello World");
479
+ * // "hello.world"
480
+ *
481
+ * // Array input is joined before conversion
482
+ * toDotCase(["Join", "Words", "Here"]);
483
+ * // ➔ "join.words.here"
484
+ *
485
+ * // Handles underscores and hyphens
486
+ * toDotCase("convert-to_dot case");
487
+ * // ➔ "convert.to.dot.case"
488
+ *
489
+ * // Multiple delimiters and trimming
490
+ * toDotCase("___Hello--World__ again!!");
491
+ * // ➔ "hello.world.again"
492
+ *
493
+ * // Supports emojis and symbols
494
+ * toDotCase("🔥Fire_and-ice❄️");
495
+ * // "fire.and.ice"
496
+ *
497
+ * // Ignore single word
498
+ * toDotCase("this URL path", "URL");
499
+ * // "this.URL.path"
500
+ *
501
+ * // Ignore multiple words
502
+ * toDotCase("ignore API and URL", ["API", "URL"]);
503
+ * // ➔ "ignore.API.and.URL"
504
+ *
505
+ * // Ignore using Set
506
+ * toDotCase("ignore API and URL", new Set(["API", "URL"]));
507
+ * // ➔ "ignore.API.and.URL"
508
+ *
509
+ * // Null, Undefined or empty (string or array) input returns empty string
510
+ * toDotCase(undefined);
511
+ * // ➔ ""
512
+ */
552
513
  declare const toDotCase:(input:StringLike,ignoreWord?:StringCollection)=>string;
553
514
  /** ----------------------------------------------------------
554
- * * ***Slugifies a string (or array of strings) for safe use in URLs, with optionally leaving specific words unchanged.***
555
- * ----------------------------------------------------------
556
- *
557
- * @description
558
- * - Accepts a `string` or an array of `strings`:
559
- * - If an array is provided, elements are trimmed, empty ones removed,
560
- * then joined with `"-"` before conversion.
561
- * - Splits the input by non-alphanumeric characters
562
- * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
563
- * - The first word is fully lowercase; subsequent words are capitalized.
564
- * - Words listed in `ignoreWord` remain unchanged in the output.
565
- * - `ignoreWord` is normalized (trimmed, delimiters removed); empty values ignored.
566
- * - `ignoreWord` accepts:
567
- * - a single string,
568
- * - an array of strings, or
569
- * - a `Set` of strings.
570
- * - Multiple delimiters collapse into one; empty segments ignored.
571
- * - Returns `""` if the input is `null`, `undefined`, or empty.
572
- *
573
- * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
574
- * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
575
- * @returns {string} The slugified string.
576
- *
577
- * @example
578
- * // Basic usage
579
- * slugify("Hello World!");
580
- * // "hello-world"
581
- *
582
- * @example
583
- * // Array input is joined before conversion
584
- * slugify(["Join", "Words", "Here"]);
585
- * // "join-words-here"
586
- *
587
- * @example
588
- * // Trims and cleans input
589
- * slugify(" --- Convert to Slug? --- ");
590
- * // ➔ "convert-to-slug"
591
- *
592
- * @example
593
- * // Ignore single word
594
- * slugify("This URL path", "URL");
595
- * // ➔ "this-URL-path"
596
- *
597
- * @example
598
- * // Ignore multiple words
599
- * slugify("ignore API and URL", ["API", "URL"]);
600
- * // "ignore-API-and-URL"
601
- *
602
- * @example
603
- * // Ignore using Set
604
- * slugify("ignore API and URL", new Set(["API", "URL"]));
605
- * // ➔ "ignore-API-and-URL"
606
- *
607
- * @example
608
- * // Supports emojis and symbols
609
- * slugify("🔥 Fire_and_ice ❄️");
610
- * // ➔ "fire-and-ice"
611
- *
612
- * @example
613
- * // Null or empty returns empty string
614
- * slugify(undefined);
615
- * // ➔ ""
616
- */
617
- declare const slugify:(input:StringLike,ignoreWord?:StringCollection)=>string;
618
- /** ----------------------------------------------------------
619
- * * ***Normalizes whitespace in a string by reducing multiple spaces
620
- * to a single space, optionally trims, or only trims based on options.***
621
- * ----------------------------------------------------------
622
- *
623
- * - ✅ Collapses all consecutive whitespace (spaces, tabs, newlines) into a single space.
624
- * - ✅ Can trim leading/trailing spaces (default behavior), or preserve them with `withTrim: false`.
625
- * - ✅ Can skip normalization entirely and only trim using `trimOnly: true`.
626
- * - ✅ Returns an empty string if input is `null` or `undefined`.
627
- *
628
- * @param {string} [value] - The input string to be processed. If `null` or `undefined`, returns an empty string.
629
- * @param {object} [options] - Configuration options.
630
- * @param {boolean} [options.trimOnly=false] - If `true`, skips normalization and only trims the string.
631
- * @param {boolean} [options.withTrim=true] - If `false`, preserves leading/trailing whitespace.
632
- *
633
- * @returns {string} The processed string.
634
- *
635
- * @example
636
- * normalizeSpaces(" Hello World\tthis is\n\nok ");
637
- * // ➔ "Hello World this is ok"
638
- *
639
- * normalizeSpaces(" Hello World\tthis is\n\nok ", { trimOnly: true });
640
- * // ➔ "Hello World this is\n\nok"
641
- *
642
- * normalizeSpaces(" Hello World ", { withTrim: false });
643
- * // ➔ " Hello World "
644
- *
645
- * normalizeSpaces(null);
646
- * // ➔ ""
647
- */
648
- declare const normalizeSpaces:(value?:string|null,options?:{
649
- /**
650
- * If `true`, skips normalization and only trims whitespace from start & end.
651
- * @default false */
515
+ * * ***Utility: `slugify`.***
516
+ * ----------------------------------------------------------
517
+ * **Slugifies a string (or array of strings) for safe use in URLs, with optionally leaving specific words unchanged.**
518
+ * - **Behavior:**
519
+ * - Accepts a `string` or an `array of strings`:
520
+ * - If an array is provided, elements are trimmed, empty ones removed,
521
+ * then joined with `"-"` before conversion.
522
+ * - Splits the input by non-alphanumeric characters
523
+ * (spaces, punctuation, symbols, hyphens, underscores, emojis, etc.).
524
+ * - The first word is fully lowercase; subsequent words are capitalized.
525
+ * - Words listed in `ignoreWord` remain unchanged in the output.
526
+ * - `ignoreWord` is normalized (trimmed, delimiters removed), empty values ignored.
527
+ * - `ignoreWord` accepts:
528
+ * - a single string,
529
+ * - an array of strings, or
530
+ * - a `Set` of strings.
531
+ * - Multiple delimiters collapse into one; empty segments ignored.
532
+ * - Returns `""` if the input is `null`, `undefined`, or empty.
533
+ * @param {StringLike} input - The string or array to convert. Returns `""` if empty, `null`, or `undefined`.
534
+ * @param {StringCollection} [ignoreWord] - Optional word(s) to leave unchanged in the output.
535
+ * @returns {string} The slugified string.
536
+ * @example
537
+ * // Basic usage
538
+ * slugify("Hello World!");
539
+ * // "hello-world"
540
+ *
541
+ * // Array input is joined before conversion
542
+ * slugify(["Join", "Words", "Here"]);
543
+ * // ➔ "join-words-here"
544
+ *
545
+ * // Trims and cleans input
546
+ * slugify(" --- Convert to Slug? --- ");
547
+ * // ➔ "convert-to-slug"
548
+ *
549
+ * // Ignore single word
550
+ * slugify("This URL path", "URL");
551
+ * // ➔ "this-URL-path"
552
+ *
553
+ * // Ignore multiple words
554
+ * slugify("ignore API and URL", ["API", "URL"]);
555
+ * // "ignore-API-and-URL"
556
+ *
557
+ * // Ignore using Set
558
+ * slugify("ignore API and URL", new Set(["API", "URL"]));
559
+ * // "ignore-API-and-URL"
560
+ *
561
+ * // Supports emojis and symbols
562
+ * slugify("🔥 Fire_and_ice ❄️");
563
+ * // ➔ "fire-and-ice"
564
+ *
565
+ * // Null, Undefined or empty (string or array) input returns empty string
566
+ * slugify(undefined);
567
+ * // ➔ ""
568
+ */
569
+ declare const slugify:(input:StringLike,ignoreWord?:StringCollection)=>string;type NormalizeSpacesOptions={
570
+ /** If `true`, skips normalization and only trims whitespace from start & end, defaultValue: `false`.
571
+ *
572
+ * @default false
573
+ */
652
574
  trimOnly?:boolean;
653
- /**
654
- * If `false`, skips trimming value.
655
- * @default true */
656
- withTrim?:boolean;})=>string;
575
+ /** If `false`, skips trimming value, defaultValue: `true`.
576
+ *
577
+ * @default true
578
+ */
579
+ withTrim?:boolean;};
580
+ /** ----------------------------------------------------------
581
+ * * ***Utility: `normalizeSpaces`.***
582
+ * ----------------------------------------------------------
583
+ * **Normalizes whitespace in a string by reducing multiple spaces
584
+ * to a single space, optionally trims, or only trims based on options.**
585
+ * - **Behavior:**
586
+ * - Collapses all consecutive whitespace (spaces, tabs, newlines) into a single space.
587
+ * - Can trim leading/trailing spaces (default behavior), or preserve them with `withTrim: false`.
588
+ * - Can skip normalization entirely and only trim using `trimOnly: true`.
589
+ * - Returns an empty string if input is `null` or `undefined`.
590
+ * @param {string | null | undefined} value - The input string to be processed. If `null` or `undefined`, returns an empty string.
591
+ * @param {NormalizeSpacesOptions} [options] - Configuration options.
592
+ * @param {NormalizeSpacesOptions["trimOnly"]} [options.trimOnly=false] - If `true`, skips normalization and only trims the string.
593
+ * @param {NormalizeSpacesOptions["withTrim"]} [options.withTrim=true] - If `false`, preserves leading/trailing whitespace.
594
+ * @returns {string} The processed string.
595
+ * @example
596
+ * normalizeSpaces(" Hello World\tthis is\n\nok ");
597
+ * // ➔ "Hello World this is ok"
598
+ * normalizeSpaces(" Hello World\tthis is\n\nok ", { trimOnly: true });
599
+ * // ➔ "Hello World this is\n\nok"
600
+ * normalizeSpaces(" Hello World ", { withTrim: false });
601
+ * // ➔ " Hello World "
602
+ * normalizeSpaces(null);
603
+ * // ➔ ""
604
+ */
605
+ declare const normalizeSpaces:(value:string|null|undefined,options?:NormalizeSpacesOptions)=>string;
657
606
  /** ----------------------------------------------------------
658
- * * ***Normalizes a string by ensuring it is a valid string and trimming whitespace.***
659
- * ----------------------------------------------------------
660
- *
661
- * @description
662
- * If the input is `undefined`, `null`, or an `empty string` after trimming,
663
- * it returns an empty string `("")`.
664
- *
665
- * @param {string | undefined | null} input - The input string to be normalize. If `null` or `undefined`, returns an empty string.
666
- * @returns {string} A trimmed string or an empty string if the input is invalid.
667
- *
668
- * @example
669
- * normalizeString(" Hello World ");
670
- * // ➔ "Hello World"
671
- * normalizeString(" Hello World ");
672
- * // ➔ "Hello World"
673
- * normalizeString("");
674
- * // ➔ ""
675
- * normalizeString(null);
676
- * // ➔ ""
677
- * normalizeString(undefined);
678
- * // ""
679
- */
680
- declare const normalizeString:(input?:string|null)=>string;
607
+ * * ***Utility: `normalizeString`.***
608
+ * ----------------------------------------------------------
609
+ * **Normalizes a string by ensuring it is a valid string and trimming whitespace.**
610
+ * - **Behavior:**
611
+ * - If the input is `undefined`, `null`, or an `empty string` after trimming,
612
+ * it returns an empty string `("")`.
613
+ * @param {string | undefined | null} input - The input string to be normalize. If `null` or `undefined`, returns an empty string.
614
+ * @returns {string} A trimmed string or an empty string if the input is invalid.
615
+ * @example
616
+ * normalizeString(" Hello World ");
617
+ * // ➔ "Hello World"
618
+ * normalizeString(" Hello World ");
619
+ * // ➔ "Hello World"
620
+ * normalizeString("");
621
+ * // ➔ ""
622
+ * normalizeString(null);
623
+ * // ➔ ""
624
+ * normalizeString(undefined);
625
+ * // ➔ ""
626
+ */
627
+ declare const normalizeString:(input:string|null|undefined)=>string;type RemoveSpacesOptions={
628
+ /** If `true`, only trims the string, defaultValue: `false`.
629
+ *
630
+ * @default false */
631
+ trimOnly?:boolean;};
681
632
  /** ----------------------------------------------------------
682
- * * ***Removes all spaces from a string or trims only, based on the options provided.***
683
- * ----------------------------------------------------------
684
- *
685
- * @description
686
- * - If `trimOnly` is `true`, the string is simply trimmed.
687
- * - Otherwise, removes **all spaces**, tabs, newlines, etc.
688
- * - If the input is `null` or `undefined`, returns an empty string `("")`.
689
- *
690
- * @param {string | null | undefined} value - The input string to be processed. If `null` or `undefined`, returns an empty string.
691
- * @param {object} [options] - The options object.
692
- * @param {boolean} [options.trimOnly=false] - If `true`, only trims the string without removing spaces inside.
693
- * @returns {string} The processed string.
694
- *
695
- * @example
696
- * removeSpaces(" Hello World ");
697
- * // ➔ "HelloWorld"
698
- *
699
- * removeSpaces(" Hello World ", { trimOnly: true });
700
- * // ➔ "Hello World"
701
- *
702
- * removeSpaces(null);
703
- * // ➔ ""
704
- */
705
- declare const removeSpaces:(value?:string|null,options?:{
706
- /**
707
- * @description If true, only trims the string.
708
- *
709
- * @default false */
710
- trimOnly?:boolean;})=>string;
633
+ * * ***Utility: `removeSpaces`.***
634
+ * ----------------------------------------------------------
635
+ * **Removes all spaces from a string or trims only, based on the options provided.**
636
+ * - **Behavior:**
637
+ * - If `trimOnly` is `true`, the string is simply trimmed.
638
+ * - Otherwise, removes **all spaces**, tabs, newlines, etc.
639
+ * - If the input is `null` or `undefined`, returns an empty string `("")`.
640
+ * @param {string | null | undefined} value - The input string to be processed. If `null` or `undefined`, returns an empty string.
641
+ * @param {RemoveSpacesOptions} [options] - The options object.
642
+ * @param {RemoveSpacesOptions["trimOnly"]} [options.trimOnly=false] - If `true`, only trims the string without removing spaces inside.
643
+ * @returns {string} The processed string.
644
+ * @example
645
+ * removeSpaces(" Hello World ");
646
+ * // ➔ "HelloWorld"
647
+ * removeSpaces(" Hello World ", { trimOnly: true });
648
+ * // ➔ "Hello World"
649
+ * removeSpaces(null);
650
+ * // ➔ ""
651
+ */
652
+ declare const removeSpaces:(value:string|null|undefined,options?:RemoveSpacesOptions)=>string;
711
653
  /** ----------------------------------------------------------
712
- * * ***Removes all HTML tags from a given string.***
713
- * ----------------------------------------------------------
714
- *
715
- * This function removes valid HTML tags (including nested and self-closing ones)
716
- * by replacing them with spaces, then collapses multiple whitespaces into a single space.
717
- *
718
- * It handles the following cases:
719
- * - If the input is not a string (`null`, `undefined`, or any non-string), it is returned as undefined.
720
- * - If the input is an empty or whitespace-only string, it returns an empty string (`""`).
721
- * - Otherwise, it returns the cleaned string with tags removed and normalized whitespace.
722
- *
723
- * @template T - Input string type (string | null | undefined).
724
- * @param {T} [input] - A string potentially containing HTML tags.
725
- * @returns {T extends string ? string : T} - Cleaned string if input is string, or original input otherwise.
726
- *
727
- * @example
728
- * stripHtmlTags("<p>Hello</p>");
729
- * // ➔ "Hello"
730
- * stripHtmlTags("<div><b>Bold</b> text</div>");
731
- * // ➔ "Bold text"
732
- * stripHtmlTags("Line<br/>Break");
733
- * // ➔ "Line Break"
734
- * stripHtmlTags("2 < 5 and 5 > 2");
735
- * // ➔ "2 < 5 and 5 > 2"
736
- * stripHtmlTags("");
737
- * // ➔ ""
738
- * stripHtmlTags(" ");
739
- * // ➔ ""
740
- * stripHtmlTags(null);
741
- * // undefined
742
- * stripHtmlTags(undefined);
743
- * // ➔ undefined
744
- */
745
- declare const stripHtmlTags:<T extends string|null|undefined=undefined>(input?:T)=>T extends string?string:undefined;
654
+ * * ***Utility: `stripHtmlTags`.***
655
+ * ----------------------------------------------------------
656
+ * **This function removes valid HTML tags (including nested and self-closing ones)
657
+ * by replacing them with spaces, then collapses multiple whitespaces into a single space.**
658
+ * - **It handles the following cases:**
659
+ * - If the input is not a string (`null`, `undefined`, or any non-string), it is returned as undefined.
660
+ * - If the input is an empty or whitespace-only string, it returns an empty string (`""`).
661
+ * - Otherwise, it returns the cleaned string with tags removed and normalized whitespace.
662
+ * @template T - Input string type (string | null | undefined).
663
+ * @param {string | null | undefined} input - A string potentially containing HTML tags.
664
+ * @returns {string | undefined} Cleaned string if input is string, or original input otherwise.
665
+ * @example
666
+ * stripHtmlTags("<p>Hello</p>");
667
+ * // "Hello"
668
+ * stripHtmlTags("<div><b>Bold</b> text</div>");
669
+ * // ➔ "Bold text"
670
+ * stripHtmlTags("Line<br/>Break");
671
+ * // ➔ "Line Break"
672
+ * stripHtmlTags("2 < 5 and 5 > 2");
673
+ * // ➔ "2 < 5 and 5 > 2"
674
+ * stripHtmlTags("");
675
+ * // ➔ ""
676
+ * stripHtmlTags(" ");
677
+ * // ➔ ""
678
+ * stripHtmlTags(null);
679
+ * // ➔ undefined
680
+ * stripHtmlTags(undefined);
681
+ * // ➔ undefined
682
+ */
683
+ declare function stripHtmlTags(input:string):string;declare function stripHtmlTags<T>(input:T):Extends<string,T>extends true?string|undefined:undefined;
746
684
  /** ----------------------------------------------------------
747
- * * ***Replaces a substring at a specified index within a string.***
748
- * ----------------------------------------------------------
749
- *
750
- * @description
751
- * Replaces exactly one character at the specified index in the original string
752
- * with the provided `replaceTo` string. If `replaceTo` has more than one character,
753
- * the result will expand accordingly.
754
- *
755
- * @param {number} index - The starting index where the replacement should occur.
756
- * @param {string} originalString - The original string to modify.
757
- * @param {string} replaceTo - The string to insert at the specified index.
758
- * @returns {string} - The modified string with the replacement applied.
759
- *
760
- * @example
761
- * replaceAt(3, "hello", "X");
762
- * // ➔ "helXo"
763
- *
764
- * replaceAt(1, "world", "AB");
765
- * // "wABrld"
766
- *
767
- * replaceAt(0, "cat", "br");
768
- * // ➔ "brat"
769
- *
770
- * replaceAt(2, "12345", "-");
771
- * // ➔ "12-45"
772
- *
773
- * replaceAt(4, "ABCDE", "Z");
774
- * // "ABCDZ"
775
- *
776
- * // Examples that throw:
777
- * replaceAt(10, "short", "X");
778
- * // ➔ ❌ RangeError: Index parameter is out of range at function `replaceAt`
779
- *
780
- * replaceAt(-1, "test", "X");
781
- * // ➔ ❌ RangeError: Index parameter is out of range at function `replaceAt`
782
- *
783
- * replaceAt("1", "test", "X");
784
- * // ➔ ❌ TypeError: Expected 'index' to be a number, and 'replaceTo' and 'originalString' to be strings
785
- *
786
- * replaceAt(2, null, "X");
787
- * // ➔ ❌ TypeError: Expected 'index' to be a number, and 'replaceTo' and 'originalString' to be strings
788
- */
685
+ * * ***Utility: `replaceAt`.***
686
+ * ----------------------------------------------------------
687
+ * **Replaces exactly one character at the specified index in the original string
688
+ * with the provided `replaceTo` string.**
689
+ * - **Behavior:**
690
+ * - If `replaceTo` has more than one character,
691
+ * the result will expand accordingly.
692
+ * @param {number} index - The starting index where the replacement should occur.
693
+ * @param {string} originalString - The original string to modify.
694
+ * @param {string} replaceTo - The string to insert at the specified index.
695
+ * @returns {string} The modified string with the replacement applied.
696
+ * @example
697
+ * replaceAt(3, "hello", "X");
698
+ * // ➔ "helXo"
699
+ * replaceAt(1, "world", "AB");
700
+ * // ➔ "wABrld"
701
+ * replaceAt(0, "cat", "br");
702
+ * // "brat"
703
+ * replaceAt(2, "12345", "-");
704
+ * // ➔ "12-45"
705
+ * replaceAt(4, "ABCDE", "Z");
706
+ * // ➔ "ABCDZ"
707
+ * // ❌ Examples that throw:
708
+ * replaceAt(10, "short", "X");
709
+ * // ➔ ❌ RangeError: First parameter (`index`) is out of range from second parameter `originalString`.
710
+ * replaceAt(-1, "test", "X");
711
+ * // ➔ ❌ RangeError: First parameter (`index`) is out of range from second parameter `originalString`.
712
+ * replaceAt("1", "test", "X");
713
+ * // ➔ ❌ TypeError: First parameter `index` must be of type `number`, second parameter `originalString` and third parameter `replaceTo` must be of type `string`, but received: "['index': `string`,...]."
714
+ * replaceAt(2, null, "X");
715
+ * // ➔ ❌ TypeError: First parameter `index` must be of type `number`, second parameter `originalString` and third parameter `replaceTo` must be of type `string`, but received: "['index': `string`,...]."
716
+ */
789
717
  declare const replaceAt:(index:number,originalString:string,replaceTo:string)=>string;
790
718
  /** ----------------------------------------------------------
791
- * * ***Extracts initials from a given name.***
792
- * ----------------------------------------------------------
793
- *
794
- * @description
795
- * Extracts initials from the given name string.
796
- * - For names with two or more words, returns the first letter of the first and second words.
797
- * - For a single word with 2+ characters, returns the first two letters.
798
- * - For a single character, returns that character.
799
- * - For empty, null, or whitespace-only input, returns an empty string.
800
- *
801
- * @param {string} [name=""] - The name to extract initials from.
802
- * @returns {string} The extracted initials (e.g., "JD" for "John Doe").
803
- *
804
- * @example
805
- * getInitialsName("Alice"); // ➔ "AL"
806
- * getInitialsName("John Doe"); // ➔ "JD"
807
- * getInitialsName(" Bob Marley "); // ➔ "BM"
808
- * getInitialsName("John Ronald Donal"); // ➔ "JR"
809
- * getInitialsName("Lord John Doe Moe"); // ➔ "LJ"
810
- * getInitialsName("X"); // ➔ "X"
811
- * getInitialsName(" "); // ➔ "" (empty string)
812
- * getInitialsName(""); // ➔ "" (empty string)
813
- * getInitialsName(null); // ➔ "" (null input)
814
- * getInitialsName(undefined); // ➔ "" (undefined input)
815
- */
816
- declare const getInitialsName:(name?:string|null)=>string;export{capitalizeFirst,capitalizeWords,getInitialsName,normalizeSpaces,normalizeString,removeSpaces,replaceAt,slugify,stripHtmlTags,toCamelCase,toDotCase,toKebabCase,toLowerCase,toPascalCase,toPascalCaseSpace,toSnakeCase};
719
+ * * ***Utility: `getInitialsName`.***
720
+ * ----------------------------------------------------------
721
+ * **Extracts initials from the given name string.**
722
+ * - **Behavior:**
723
+ * - For names with two or more words, returns the first letter of the first and second words.
724
+ * - For a single word with 2+ characters, returns the first two letters.
725
+ * - For a single character, returns that character.
726
+ * - For `empty`, `null`, `undefined` or `whitespace-only input`, returns an empty string (`""`).
727
+ * @param {string | null | undefined} name - The name to extract initials from.
728
+ * @returns {string} The extracted initials (e.g., "JD" for "John Doe").
729
+ * @example
730
+ * getInitialsName("Alice"); // "AL"
731
+ * getInitialsName("John Doe"); // ➔ "JD"
732
+ * getInitialsName(" Bob Marley "); // ➔ "BM"
733
+ * getInitialsName("John Ronald Donal"); // ➔ "JR"
734
+ * getInitialsName("Lord John Doe Moe"); // ➔ "LJ"
735
+ * getInitialsName("X"); // ➔ "X"
736
+ * getInitialsName(""); // ➔ "" (empty string)
737
+ * getInitialsName(" "); // ➔ "" (empty string)
738
+ * getInitialsName(null); // ➔ "" (null input)
739
+ * getInitialsName(undefined); // ➔ "" (undefined input)
740
+ */
741
+ declare const getInitialsName:(name:string|null|undefined)=>string;export{capitalizeFirst,capitalizeWords,getInitialsName,normalizeSpaces,normalizeString,removeSpaces,replaceAt,slugify,stripHtmlTags,toCamelCase,toDotCase,toKebabCase,toLowerCase,toPascalCase,toPascalCaseSpace,toSnakeCase};