@rzl-zone/utils-js 3.1.0-beta.2 → 3.1.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 (195) hide show
  1. package/README.md +56 -27
  2. package/dist/NumberRangeUnion-DC-C3_Kq.d.ts +23 -23
  3. package/dist/any-BmdI8UbK.d.ts +56 -56
  4. package/dist/arrays-normalize-recursive-CnjYJ9xg.d.ts +66 -66
  5. package/dist/assertions/index.cjs +1 -1
  6. package/dist/assertions/index.d.ts +396 -396
  7. package/dist/assertions/index.js +1 -1
  8. package/dist/chunk-26XIKDJI.cjs +1 -0
  9. package/dist/chunk-2NWHDDM5.js +1 -0
  10. package/dist/chunk-2UIRWYE3.js +1 -0
  11. package/dist/chunk-3KBHD3BS.cjs +1 -0
  12. package/dist/chunk-4HD2O5A4.js +1 -0
  13. package/dist/chunk-5C2SMIGX.cjs +1 -0
  14. package/dist/chunk-5I2B5DOG.js +1 -0
  15. package/dist/chunk-6HQDHIOD.js +1 -0
  16. package/dist/chunk-735HJXBT.cjs +1 -0
  17. package/dist/chunk-7BXIZM57.cjs +1 -0
  18. package/dist/chunk-7KJBDGEP.js +1 -0
  19. package/dist/chunk-7U44T63D.cjs +1 -0
  20. package/dist/chunk-AJ65QFV2.js +1 -0
  21. package/dist/chunk-APHDUCVQ.js +1 -0
  22. package/dist/chunk-BSVZRN7C.js +1 -0
  23. package/dist/chunk-C6JFHUR2.cjs +1 -0
  24. package/dist/chunk-CPLBRGST.js +1 -0
  25. package/dist/chunk-CTBRLEOG.js +1 -0
  26. package/dist/chunk-DUK2K4FB.js +1 -0
  27. package/dist/chunk-DVMHRLKP.cjs +1 -0
  28. package/dist/chunk-E63WVPZE.cjs +1 -0
  29. package/dist/chunk-EBMHQW7X.cjs +1 -0
  30. package/dist/chunk-EGNZCW4K.js +1 -0
  31. package/dist/chunk-FEKDB32T.js +1 -0
  32. package/dist/chunk-FIAAX3UE.js +1 -0
  33. package/dist/chunk-FUS3DVLB.cjs +1 -0
  34. package/dist/chunk-GGRMHIFJ.cjs +1 -0
  35. package/dist/chunk-HQ5GQTEE.js +1 -0
  36. package/dist/chunk-I5X5IN4H.js +1 -0
  37. package/dist/chunk-I7YGXQPI.cjs +1 -0
  38. package/dist/chunk-INUFZJLX.cjs +1 -0
  39. package/dist/chunk-IREHUBF7.js +1 -0
  40. package/dist/chunk-J2RGTPGK.cjs +1 -0
  41. package/dist/chunk-KHO2SBNA.cjs +1 -0
  42. package/dist/chunk-KXIXXSWX.cjs +1 -0
  43. package/dist/chunk-LBMEEJWA.js +1 -0
  44. package/dist/chunk-MC3LXMCQ.js +1 -0
  45. package/dist/chunk-MMSYCIJ2.cjs +1 -1
  46. package/dist/chunk-NU3N4WHD.cjs +1 -0
  47. package/dist/chunk-ODZQXH7E.cjs +1 -0
  48. package/dist/chunk-ONZFBJVW.js +1 -0
  49. package/dist/chunk-PXDRHFIE.js +1 -0
  50. package/dist/chunk-Q6NHYWVX.js +1 -0
  51. package/dist/chunk-QNKGP5DY.js +1 -0
  52. package/dist/chunk-S6Z6I2EG.cjs +1 -0
  53. package/dist/chunk-SMADKXZE.js +1 -0
  54. package/dist/chunk-TSLYDPBJ.js +1 -0
  55. package/dist/chunk-TVXADXCC.cjs +1 -0
  56. package/dist/chunk-UDA26MCU.cjs +1 -0
  57. package/dist/chunk-UET567YM.cjs +1 -0
  58. package/dist/chunk-VEYMQ3UA.js +1 -0
  59. package/dist/chunk-W2W3L2M5.js +1 -0
  60. package/dist/chunk-WBWTXKMC.cjs +1 -0
  61. package/dist/chunk-WVSPXFTY.js +1 -0
  62. package/dist/chunk-XC2PYCT4.cjs +1 -0
  63. package/dist/chunk-XIXA5KDF.cjs +1 -0
  64. package/dist/chunk-Y4O5KZF6.cjs +1 -0
  65. package/dist/chunk-YRM7IJLX.js +1 -0
  66. package/dist/chunk-YT3MSZKK.cjs +1 -0
  67. package/dist/chunk-YXHCULSO.cjs +1 -0
  68. package/dist/chunk-YZR5OGJA.cjs +1 -0
  69. package/dist/chunk-Z4DXK7A6.cjs +1 -0
  70. package/dist/chunk-ZXIWDFEQ.js +1 -0
  71. package/dist/conversions/index.cjs +1 -1
  72. package/dist/conversions/index.d.ts +1347 -1297
  73. package/dist/conversions/index.js +1 -1
  74. package/dist/env/index.cjs +1 -1
  75. package/dist/env/index.d.ts +14 -14
  76. package/dist/env/index.js +1 -1
  77. package/dist/events/index.cjs +1 -1
  78. package/dist/events/index.d.ts +109 -109
  79. package/dist/events/index.js +1 -1
  80. package/dist/extends-Bk_SBGdT.d.ts +330 -330
  81. package/dist/formatting/index.cjs +1 -1
  82. package/dist/formatting/index.d.ts +855 -855
  83. package/dist/formatting/index.js +1 -1
  84. package/dist/generator/index.cjs +1 -1
  85. package/dist/generator/index.d.ts +155 -155
  86. package/dist/generator/index.js +1 -1
  87. package/dist/if-CvT4R7Kh.d.ts +16 -16
  88. package/dist/is-array-Cymwrsmm.d.ts +1119 -0
  89. package/dist/isPlainObject-BVhBAPHX.d.ts +154 -154
  90. package/dist/never-BfayMBF9.d.ts +64 -64
  91. package/dist/next/index.cjs +1 -8
  92. package/dist/next/index.d.ts +183 -183
  93. package/dist/next/index.js +1 -8
  94. package/dist/next/server/index.cjs +1 -2
  95. package/dist/next/server/index.d.ts +25 -25
  96. package/dist/next/server/index.js +1 -2
  97. package/dist/nils-DMz3kU7M.d.ts +155 -155
  98. package/dist/omit-VvmIsZmX.d.ts +25 -25
  99. package/dist/operations/index.cjs +1 -1
  100. package/dist/operations/index.d.ts +120 -120
  101. package/dist/operations/index.js +1 -1
  102. package/dist/or-DyZCRvaU.d.ts +89 -0
  103. package/dist/parsers/index.cjs +1 -1
  104. package/dist/parsers/index.d.ts +34 -34
  105. package/dist/parsers/index.js +1 -1
  106. package/dist/predicates/index.cjs +1 -1
  107. package/dist/predicates/index.d.ts +1774 -1680
  108. package/dist/predicates/index.js +1 -1
  109. package/dist/prettify-C4xLcYOP.d.ts +328 -328
  110. package/dist/promise/index.cjs +1 -1
  111. package/dist/promise/index.d.ts +29 -29
  112. package/dist/promise/index.js +1 -1
  113. package/dist/rzl-utils.global.js +1 -4
  114. package/dist/string-XA-til3C.d.ts +318 -318
  115. package/dist/strings/index.cjs +1 -1
  116. package/dist/strings/index.d.ts +690 -690
  117. package/dist/strings/index.js +1 -1
  118. package/dist/tailwind/index.cjs +1 -0
  119. package/dist/tailwind/index.d.ts +565 -0
  120. package/dist/tailwind/index.js +1 -0
  121. package/dist/type-data-DDs-u2kq.d.ts +241 -241
  122. package/dist/types/index.d.ts +3266 -3266
  123. package/dist/urls/index.cjs +1 -1
  124. package/dist/urls/index.d.ts +373 -373
  125. package/dist/urls/index.js +1 -1
  126. package/package.json +24 -23
  127. package/dist/chunk-25G6B35W.js +0 -1
  128. package/dist/chunk-2AUUPGMN.js +0 -1
  129. package/dist/chunk-2JQQQ625.js +0 -1
  130. package/dist/chunk-445TAVT4.cjs +0 -1
  131. package/dist/chunk-467VEMJH.js +0 -1
  132. package/dist/chunk-56QBKKRE.js +0 -1
  133. package/dist/chunk-5SZUSNGZ.js +0 -1
  134. package/dist/chunk-6Q4I2RPC.cjs +0 -1
  135. package/dist/chunk-6SMJMZ7G.cjs +0 -1
  136. package/dist/chunk-7YWAQOA4.cjs +0 -1
  137. package/dist/chunk-BLCANGFS.js +0 -1
  138. package/dist/chunk-CK3BZGEU.js +0 -1
  139. package/dist/chunk-D43GV6EF.cjs +0 -1
  140. package/dist/chunk-DFSTVQFI.cjs +0 -1
  141. package/dist/chunk-DYRDBYPF.cjs +0 -1
  142. package/dist/chunk-ELDDNERR.js +0 -1
  143. package/dist/chunk-EXXLUO7L.cjs +0 -1
  144. package/dist/chunk-FIEZKTAZ.cjs +0 -1
  145. package/dist/chunk-G72VSVGO.js +0 -1
  146. package/dist/chunk-GAJTFCUA.js +0 -1
  147. package/dist/chunk-GOJNH55O.cjs +0 -1
  148. package/dist/chunk-HXST7RJB.js +0 -1
  149. package/dist/chunk-HXTACM3O.cjs +0 -1
  150. package/dist/chunk-IJTZWWRJ.cjs +0 -1
  151. package/dist/chunk-ISJ33O2J.cjs +0 -1
  152. package/dist/chunk-JISH2VGG.js +0 -1
  153. package/dist/chunk-JQZUWBIX.js +0 -1
  154. package/dist/chunk-K4PLGD7C.js +0 -1
  155. package/dist/chunk-KZQB7H4E.cjs +0 -1
  156. package/dist/chunk-LUVV5KSD.cjs +0 -2
  157. package/dist/chunk-LVUSFXQS.cjs +0 -1
  158. package/dist/chunk-ME5OV5HN.js +0 -1
  159. package/dist/chunk-MF5Y5K4N.cjs +0 -1
  160. package/dist/chunk-MJAW5RAK.js +0 -1
  161. package/dist/chunk-MWLEM7ED.js +0 -1
  162. package/dist/chunk-NNM7QCNB.js +0 -1
  163. package/dist/chunk-NSVLG7NY.js +0 -4
  164. package/dist/chunk-NUHOOAUN.cjs +0 -1
  165. package/dist/chunk-NUVGETPD.js +0 -2
  166. package/dist/chunk-O5VXBNUQ.cjs +0 -4
  167. package/dist/chunk-O7SJR4CY.cjs +0 -1
  168. package/dist/chunk-OX6RLS2F.cjs +0 -1
  169. package/dist/chunk-PFLNHD4B.cjs +0 -1
  170. package/dist/chunk-PSWITZK5.js +0 -1
  171. package/dist/chunk-PUQXRLZH.cjs +0 -1
  172. package/dist/chunk-PYUVKHUF.cjs +0 -1
  173. package/dist/chunk-REFMEB4A.js +0 -1
  174. package/dist/chunk-RHE3M2NJ.cjs +0 -1
  175. package/dist/chunk-RHIBYOFQ.js +0 -1
  176. package/dist/chunk-RV2VULM7.cjs +0 -1
  177. package/dist/chunk-S7GMG4TB.js +0 -1
  178. package/dist/chunk-SW6HYEW7.cjs +0 -1
  179. package/dist/chunk-SYJC7UAW.js +0 -1
  180. package/dist/chunk-TQMZ2LPI.js +0 -1
  181. package/dist/chunk-U4TZO7WV.js +0 -1
  182. package/dist/chunk-UUMKL74S.js +0 -1
  183. package/dist/chunk-VQLAPEL3.js +0 -1
  184. package/dist/chunk-VTR75UID.cjs +0 -1
  185. package/dist/chunk-XFCJDSB2.cjs +0 -1
  186. package/dist/chunk-XOYX4PLZ.cjs +0 -1
  187. package/dist/chunk-Z6FLCEN6.js +0 -1
  188. package/dist/chunk-ZO5364A6.cjs +0 -1
  189. package/dist/index.cjs +0 -1
  190. package/dist/index.d.ts +0 -1
  191. package/dist/index.js +0 -1
  192. package/dist/is-array--YjXV-Wx.d.ts +0 -1207
  193. package/dist/stylings/index.cjs +0 -1
  194. package/dist/stylings/index.d.ts +0 -41
  195. package/dist/stylings/index.js +0 -1
@@ -1,351 +1,351 @@
1
1
  import{I as If}from'./if-CvT4R7Kh.js';import{I as IsNever}from'./never-BfayMBF9.js';
2
2
  /** -------------------------------------------------------
3
- * * ***IfNot.***
4
- * -------------------------------------------------------
5
- *
6
- * Conditional: returns the second argument if the first argument is `false`, otherwise returns the third argument.
7
- * - Defaults: `IfTrue = true`, `IfFalse = false`.
8
- *
9
- * @template Condition - The boolean condition to check.
10
- * @template IfTrue - The branch type if condition is `false`. (default: `true`)
11
- * @template IfFalse - The branch type if condition is `true`. (default: `false`)
12
- *
13
- * ### Examples
14
- * ```ts
15
- * type A = IfNot<false, "valid">;
16
- * // ➔ "valid"
17
- * type B = IfNot<false, "valid", "invalid">;
18
- * // ➔ "invalid"
19
- * ```
20
- */
3
+ * * ***IfNot.***
4
+ * -------------------------------------------------------
5
+ *
6
+ * Conditional: returns the second argument if the first argument is `false`, otherwise returns the third argument.
7
+ * - Defaults: `IfTrue = true`, `IfFalse = false`.
8
+ *
9
+ * @template Condition - The boolean condition to check.
10
+ * @template IfTrue - The branch type if condition is `false`. (default: `true`)
11
+ * @template IfFalse - The branch type if condition is `true`. (default: `false`)
12
+ *
13
+ * ### Examples
14
+ * ```ts
15
+ * type A = IfNot<false, "valid">;
16
+ * // ➔ "valid"
17
+ * type B = IfNot<false, "valid", "invalid">;
18
+ * // ➔ "invalid"
19
+ * ```
20
+ */
21
21
  type IfNot<Condition,IfTrue=true,IfFalse=false>=If<Condition,IfFalse,IfTrue>;
22
22
  /** -------------------------------------------------------
23
- * * ***WordSeparator.***
24
- * -------------------------------------------------------
25
- * A type-level utility that defines all valid ***word separators***.
26
- * - Can be a space `" "`, a dash `"-"`, or an underscore `"_"`.
27
- *
28
- * @example
29
- * ```ts
30
- * type A = WordSeparator; // ➔ " " | "-" | "_"
31
- * ```
32
- */
23
+ * * ***WordSeparator.***
24
+ * -------------------------------------------------------
25
+ * A type-level utility that defines all valid ***word separators***.
26
+ * - Can be a space `" "`, a dash `"-"`, or an underscore `"_"`.
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * type A = WordSeparator; // ➔ " " | "-" | "_"
31
+ * ```
32
+ */
33
33
  type WordSeparator=" "|"-"|"_";
34
34
  /** --------------------------------------------------
35
- * * ***Whitespace.***
36
- * --------------------------------------------------
37
- * Represents common whitespace characters.
38
- *
39
- * ✅ Used as the default trimming characters in string utility types.
40
- *
41
- * @example
42
- * type W = Whitespace;
43
- * // ➔ " " | "\t" | "\r" | "\n"
44
- */
35
+ * * ***Whitespace.***
36
+ * --------------------------------------------------
37
+ * Represents common whitespace characters.
38
+ *
39
+ * ✅ Used as the default trimming characters in string utility types.
40
+ *
41
+ * @example
42
+ * type W = Whitespace;
43
+ * // ➔ " " | "\t" | "\r" | "\n"
44
+ */
45
45
  type Whitespace=" "|"\t"|"\r"|"\n";
46
46
  /** **Helper Internal.** */
47
47
  type SafeKeyTrimming<T>=Exclude<T,symbol>;
48
48
  /** --------------------------------------------------
49
- * * ***TrimLeft.***
50
- * --------------------------------------------------
51
- * Recursively trims specified characters (default: **{@link Whitespace}**)
52
- * from the **start (left)** of a string.
53
- *
54
- * @template Text - The string to trim.
55
- * @template Chars - The characters to remove (default: `Whitespace`).
56
- *
57
- * @example
58
- * type T1 = TrimLeft<"\n hello", " " | "\n">;
59
- * // ➔ "hello"
60
- *
61
- * type T2 = TrimLeft<" world">;
62
- * // ➔ "world"
63
- *
64
- * type T3 = TrimLeft<" world ">;
65
- * // ➔ "world "
66
- */
49
+ * * ***TrimLeft.***
50
+ * --------------------------------------------------
51
+ * Recursively trims specified characters (default: **{@link Whitespace}**)
52
+ * from the **start (left)** of a string.
53
+ *
54
+ * @template Text - The string to trim.
55
+ * @template Chars - The characters to remove (default: `Whitespace`).
56
+ *
57
+ * @example
58
+ * type T1 = TrimLeft<"\n hello", " " | "\n">;
59
+ * // ➔ "hello"
60
+ *
61
+ * type T2 = TrimLeft<" world">;
62
+ * // ➔ "world"
63
+ *
64
+ * type T3 = TrimLeft<" world ">;
65
+ * // ➔ "world "
66
+ */
67
67
  type TrimLeft<Text extends PropertyKey,Chars extends PropertyKey=Whitespace>=Text extends`${SafeKeyTrimming<Chars>}${infer Rest}`?TrimLeft<Rest,Chars>:Text;
68
68
  /** --------------------------------------------------
69
- * * ***TrimRight.***
70
- * --------------------------------------------------
71
- * Recursively trims specified characters (default: **{@link Whitespace}**)
72
- * from the **end (right)** of a string.
73
- *
74
- * @template Text - The string to trim.
75
- * @template Chars - The characters to remove (default: `Whitespace`).
76
- *
77
- * @example
78
- * type T1 = TrimRight<"hello \t", " " | "\t">;
79
- * // ➔ "hello"
80
- *
81
- * type T2 = TrimRight<"world ">;
82
- * // ➔ "world"
83
- *
84
- * type T2 = TrimRight<" world ">;
85
- * // ➔ " world"
86
- */
69
+ * * ***TrimRight.***
70
+ * --------------------------------------------------
71
+ * Recursively trims specified characters (default: **{@link Whitespace}**)
72
+ * from the **end (right)** of a string.
73
+ *
74
+ * @template Text - The string to trim.
75
+ * @template Chars - The characters to remove (default: `Whitespace`).
76
+ *
77
+ * @example
78
+ * type T1 = TrimRight<"hello \t", " " | "\t">;
79
+ * // ➔ "hello"
80
+ *
81
+ * type T2 = TrimRight<"world ">;
82
+ * // ➔ "world"
83
+ *
84
+ * type T2 = TrimRight<" world ">;
85
+ * // ➔ " world"
86
+ */
87
87
  type TrimRight<Text extends PropertyKey,Chars extends PropertyKey=Whitespace>=Text extends`${infer Rest}${SafeKeyTrimming<Chars>}`?TrimRight<Rest,Chars>:Text;
88
88
  /** --------------------------------------------------
89
- * * ***Trim.***
90
- * --------------------------------------------------
91
- * Trims specified characters (default: **{@link Whitespace}**)
92
- * from **both the start and end** of a string.
93
- *
94
- * @template Text - The string to trim.
95
- * @template Chars - The characters to remove (default: `Whitespace`).
96
- *
97
- * @example
98
- * type T1 = Trim<" hello ", " ">;
99
- * // ➔ "hello"
100
- *
101
- * type T2 = Trim<"\n world \t">;
102
- * // ➔ "world"
103
- */
89
+ * * ***Trim.***
90
+ * --------------------------------------------------
91
+ * Trims specified characters (default: **{@link Whitespace}**)
92
+ * from **both the start and end** of a string.
93
+ *
94
+ * @template Text - The string to trim.
95
+ * @template Chars - The characters to remove (default: `Whitespace`).
96
+ *
97
+ * @example
98
+ * type T1 = Trim<" hello ", " ">;
99
+ * // ➔ "hello"
100
+ *
101
+ * type T2 = Trim<"\n world \t">;
102
+ * // ➔ "world"
103
+ */
104
104
  type Trim<Text extends PropertyKey,Chars extends PropertyKey=Whitespace>=TrimRight<TrimLeft<Text,Chars>,Chars>;
105
105
  /** -------------------------------------------------------
106
- * * ***TrimsLower***
107
- * -------------------------------------------------------
108
- * Trims leading & trailing whitespace from a string and
109
- * converts it to **lowercase**.
110
- *
111
- * Utilizes **{@link Trim}** to remove whitespace and **{@link Lowercase}** to convert the string to lowercase.
112
- *
113
- * @template S - The input string to transform.
114
- *
115
- * @example
116
- * ```ts
117
- * type T1 = TrimsLower<" HeLLo \n">;
118
- * // ➔ "hello"
119
- *
120
- * type T2 = TrimsLower<" WoRLD ">;
121
- * // ➔ "world"
122
- * ```
123
- */
106
+ * * ***TrimsLower***
107
+ * -------------------------------------------------------
108
+ * Trims leading & trailing whitespace from a string and
109
+ * converts it to **lowercase**.
110
+ *
111
+ * Utilizes **{@link Trim}** to remove whitespace and **{@link Lowercase}** to convert the string to lowercase.
112
+ *
113
+ * @template S - The input string to transform.
114
+ *
115
+ * @example
116
+ * ```ts
117
+ * type T1 = TrimsLower<" HeLLo \n">;
118
+ * // ➔ "hello"
119
+ *
120
+ * type T2 = TrimsLower<" WoRLD ">;
121
+ * // ➔ "world"
122
+ * ```
123
+ */
124
124
  type TrimsLower<S extends string>=Lowercase<Trim<S>>;
125
125
  /** -------------------------------------------------------
126
- * * ***TrimsUpper***
127
- * -------------------------------------------------------
128
- * Trims leading & trailing whitespace from a string and
129
- * converts it to **uppercase**.
130
- *
131
- * Utilizes **{@link Trim}** to remove whitespace and **{@link Uppercase}** to convert the string to uppercase.
132
- *
133
- * @template S - The input string to transform.
134
- *
135
- * @example
136
- * ```ts
137
- * type T1 = TrimsUpper<" HeLLo \n">;
138
- * // ➔ "HELLO"
139
- *
140
- * type T2 = TrimsUpper<" WoRLD ">;
141
- * // ➔ "WORLD"
142
- * ```
143
- */
126
+ * * ***TrimsUpper***
127
+ * -------------------------------------------------------
128
+ * Trims leading & trailing whitespace from a string and
129
+ * converts it to **uppercase**.
130
+ *
131
+ * Utilizes **{@link Trim}** to remove whitespace and **{@link Uppercase}** to convert the string to uppercase.
132
+ *
133
+ * @template S - The input string to transform.
134
+ *
135
+ * @example
136
+ * ```ts
137
+ * type T1 = TrimsUpper<" HeLLo \n">;
138
+ * // ➔ "HELLO"
139
+ *
140
+ * type T2 = TrimsUpper<" WoRLD ">;
141
+ * // ➔ "WORLD"
142
+ * ```
143
+ */
144
144
  type TrimsUpper<S extends string>=Uppercase<Trim<S>>;
145
145
  /** -------------------------------------------------------
146
- * * ***AnyString.***
147
- * -------------------------------------------------------
148
- *
149
- * A utility type that represents **any string value** while
150
- * preventing unwanted widening of string literals to `string`.
151
- *
152
- * 🔹 This is achieved by intersecting `string` with `{}`,
153
- * ensuring that the type remains assignable to `string`
154
- * but is treated as a unique type in generic constraints.
155
- *
156
- * 📌 Useful in scenarios where:
157
- * - You want to accept **any string**, but still preserve
158
- * literal types in inference.
159
- * - You need stricter typing than just `string`.
160
- *
161
- * @example
162
- * ```ts
163
- * declare function acceptsAnyString<T extends AnyString>(value: T): T;
164
- *
165
- * // Preserves literal
166
- * const a = acceptsAnyString("hello");
167
- * // ➔ "hello"
168
- *
169
- * // Also allows generic string
170
- * const b = acceptsAnyString(String("world"));
171
- * // ➔ string
172
- * ```
173
- */
146
+ * * ***AnyString.***
147
+ * -------------------------------------------------------
148
+ *
149
+ * A utility type that represents **any string value** while
150
+ * preventing unwanted widening of string literals to `string`.
151
+ *
152
+ * 🔹 This is achieved by intersecting `string` with `{}`,
153
+ * ensuring that the type remains assignable to `string`
154
+ * but is treated as a unique type in generic constraints.
155
+ *
156
+ * 📌 Useful in scenarios where:
157
+ * - You want to accept **any string**, but still preserve
158
+ * literal types in inference.
159
+ * - You need stricter typing than just `string`.
160
+ *
161
+ * @example
162
+ * ```ts
163
+ * declare function acceptsAnyString<T extends AnyString>(value: T): T;
164
+ *
165
+ * // Preserves literal
166
+ * const a = acceptsAnyString("hello");
167
+ * // ➔ "hello"
168
+ *
169
+ * // Also allows generic string
170
+ * const b = acceptsAnyString(String("world"));
171
+ * // ➔ string
172
+ * ```
173
+ */
174
174
  type AnyString={}& string;
175
175
  /** -------------------------------------------------------
176
- * * ***EmptyString.***
177
- * -------------------------------------------------------
178
- * Returns the type `T` only if it is the empty string `""`.
179
- * Optionally trims whitespace before checking.
180
- *
181
- * Behavior:
182
- * - If `WithTrim` is `true` (default), trims `T` before checking.
183
- * - If `T` is the general `string` type, returns `never`.
184
- * - If `T` is empty (after optional trimming), returns `T` or `Trim<T>`.
185
- *
186
- * @template T - The string type to check.
187
- * @template WithTrim - Whether to trim whitespace before checking (default `true`).
188
- *
189
- * @example
190
- * ```ts
191
- * // Basic empty string
192
- * type Case1 = EmptyString<"">;
193
- * // ➔ ""
194
- *
195
- * // Non-empty string
196
- * type Case2 = EmptyString<"abc">;
197
- * // ➔ never
198
- *
199
- * // General string type
200
- * type Case3 = EmptyString<string>;
201
- * // ➔ never
202
- *
203
- * // With leading/trailing whitespace
204
- * type Case4 = EmptyString<" ", true>;
205
- * // ➔ "" (trimmed)
206
- * type Case5 = EmptyString<" ", false>;
207
- * // ➔ never (not trimmed)
208
- * ```
209
- */
176
+ * * ***EmptyString.***
177
+ * -------------------------------------------------------
178
+ * Returns the type `T` only if it is the empty string `""`.
179
+ * Optionally trims whitespace before checking.
180
+ *
181
+ * Behavior:
182
+ * - If `WithTrim` is `true` (default), trims `T` before checking.
183
+ * - If `T` is the general `string` type, returns `never`.
184
+ * - If `T` is empty (after optional trimming), returns `T` or `Trim<T>`.
185
+ *
186
+ * @template T - The string type to check.
187
+ * @template WithTrim - Whether to trim whitespace before checking (default `true`).
188
+ *
189
+ * @example
190
+ * ```ts
191
+ * // Basic empty string
192
+ * type Case1 = EmptyString<"">;
193
+ * // ➔ ""
194
+ *
195
+ * // Non-empty string
196
+ * type Case2 = EmptyString<"abc">;
197
+ * // ➔ never
198
+ *
199
+ * // General string type
200
+ * type Case3 = EmptyString<string>;
201
+ * // ➔ never
202
+ *
203
+ * // With leading/trailing whitespace
204
+ * type Case4 = EmptyString<" ", true>;
205
+ * // ➔ "" (trimmed)
206
+ * type Case5 = EmptyString<" ", false>;
207
+ * // ➔ never (not trimmed)
208
+ * ```
209
+ */
210
210
  type EmptyString<T extends string,WithTrim extends boolean=true>=""extends(WithTrim extends true?Trim<T>:T)?string extends(WithTrim extends true?Trim<T>:T)?never:WithTrim extends true?Trim<T>:T:never;
211
211
  /** -------------------------------------------------------
212
- * * ***NonEmptyString.***
213
- * -------------------------------------------------------
214
- * Returns the type `T` only if it is a non-empty string.
215
- * Optionally trims whitespace before checking.
216
- *
217
- * Behavior:
218
- * - If `WithTrim` is `true` (default), trims `T` before checking.
219
- * - If `T` is the general `string` type, returns `string`.
220
- * - If `T` is empty (after optional trimming), returns `never`.
221
- *
222
- * @template T - The string type to check.
223
- * @template WithTrim - Whether to trim whitespace before checking (default `true`).
224
- *
225
- * @example
226
- * ```ts
227
- * // Non-empty string
228
- * type Case1 = NonEmptyString<"abc">; // ➔ "abc"
229
- *
230
- * // Empty string
231
- * type Case2 = NonEmptyString<"">; // ➔ never
232
- *
233
- * // General string type
234
- * type Case3 = NonEmptyString<string>; // ➔ string
235
- *
236
- * // String with whitespace
237
- * type Case4 = NonEmptyString<" ", true>; // ➔ never (trimmed to empty)
238
- * type Case5 = NonEmptyString<" ", false>; // ➔ " " (not trimmed)
239
- * ```
240
- */
212
+ * * ***NonEmptyString.***
213
+ * -------------------------------------------------------
214
+ * Returns the type `T` only if it is a non-empty string.
215
+ * Optionally trims whitespace before checking.
216
+ *
217
+ * Behavior:
218
+ * - If `WithTrim` is `true` (default), trims `T` before checking.
219
+ * - If `T` is the general `string` type, returns `string`.
220
+ * - If `T` is empty (after optional trimming), returns `never`.
221
+ *
222
+ * @template T - The string type to check.
223
+ * @template WithTrim - Whether to trim whitespace before checking (default `true`).
224
+ *
225
+ * @example
226
+ * ```ts
227
+ * // Non-empty string
228
+ * type Case1 = NonEmptyString<"abc">; // ➔ "abc"
229
+ *
230
+ * // Empty string
231
+ * type Case2 = NonEmptyString<"">; // ➔ never
232
+ *
233
+ * // General string type
234
+ * type Case3 = NonEmptyString<string>; // ➔ string
235
+ *
236
+ * // String with whitespace
237
+ * type Case4 = NonEmptyString<" ", true>; // ➔ never (trimmed to empty)
238
+ * type Case5 = NonEmptyString<" ", false>; // ➔ " " (not trimmed)
239
+ * ```
240
+ */
241
241
  type NonEmptyString<T extends string,WithTrim extends boolean=true>=string extends T?string:If<IsNever<EmptyString<T,WithTrim>>,WithTrim extends true?Trim<T>:T,never>;
242
242
  /** -------------------------------------------------------
243
- * * ***IsEmptyString.***
244
- * -------------------------------------------------------
245
- * Returns `true` if `T` is exactly the empty string `""`.
246
- * Optionally trims whitespace before checking.
247
- *
248
- * Behavior:
249
- * - If `WithTrim` is `true` (default), trims `T` before checking.
250
- * - If `T` is empty after optional trimming, returns `true`.
251
- * - Otherwise, returns `false`.
252
- *
253
- * @template T - The string type to check.
254
- * @template WithTrim - Whether to trim whitespace before checking (default `true`).
255
- *
256
- * @example
257
- * ```ts
258
- * type Case1 = IsEmptyString<"">;
259
- * // ➔ true
260
- * type Case2 = IsEmptyString<"abc">;
261
- * // ➔ false
262
- * type Case3 = IsEmptyString<" ", true>;
263
- * // ➔ true (trimmed)
264
- * type Case4 = IsEmptyString<" ", false>;
265
- * // ➔ false (not trimmed)
266
- * ```
267
- */
243
+ * * ***IsEmptyString.***
244
+ * -------------------------------------------------------
245
+ * Returns `true` if `T` is exactly the empty string `""`.
246
+ * Optionally trims whitespace before checking.
247
+ *
248
+ * Behavior:
249
+ * - If `WithTrim` is `true` (default), trims `T` before checking.
250
+ * - If `T` is empty after optional trimming, returns `true`.
251
+ * - Otherwise, returns `false`.
252
+ *
253
+ * @template T - The string type to check.
254
+ * @template WithTrim - Whether to trim whitespace before checking (default `true`).
255
+ *
256
+ * @example
257
+ * ```ts
258
+ * type Case1 = IsEmptyString<"">;
259
+ * // ➔ true
260
+ * type Case2 = IsEmptyString<"abc">;
261
+ * // ➔ false
262
+ * type Case3 = IsEmptyString<" ", true>;
263
+ * // ➔ true (trimmed)
264
+ * type Case4 = IsEmptyString<" ", false>;
265
+ * // ➔ false (not trimmed)
266
+ * ```
267
+ */
268
268
  type IsEmptyString<T extends string,WithTrim extends boolean=true>=IfNot<IsNever<EmptyString<T,WithTrim>>>;
269
269
  /** -------------------------------------------------------
270
- * * ***IsNonEmptyString.***
271
- * -------------------------------------------------------
272
- * Returns `true` if `T` is a non-empty string.
273
- * Optionally trims whitespace before checking.
274
- *
275
- * Behavior:
276
- * - If `WithTrim` is `true` (default), trims `T` before checking.
277
- * - Returns `true` if `T` is non-empty after optional trimming.
278
- * - Returns `false` if `T` is empty (after trimming if `WithTrim=true`).
279
- *
280
- * @template T - The string type to check.
281
- * @template WithTrim - Whether to trim whitespace before checking (default `true`).
282
- *
283
- * @example
284
- * ```ts
285
- * type Case1 = IsNonEmptyString<"abc">;
286
- * // ➔ true
287
- * type Case2 = IsNonEmptyString<"">;
288
- * // ➔ false
289
- * type Case3 = IsNonEmptyString<" ", true>;
290
- * // ➔ false (trimmed)
291
- * type Case4 = IsNonEmptyString<" ", false>;
292
- * // ➔ true (not trimmed)
293
- * ```
294
- */
270
+ * * ***IsNonEmptyString.***
271
+ * -------------------------------------------------------
272
+ * Returns `true` if `T` is a non-empty string.
273
+ * Optionally trims whitespace before checking.
274
+ *
275
+ * Behavior:
276
+ * - If `WithTrim` is `true` (default), trims `T` before checking.
277
+ * - Returns `true` if `T` is non-empty after optional trimming.
278
+ * - Returns `false` if `T` is empty (after trimming if `WithTrim=true`).
279
+ *
280
+ * @template T - The string type to check.
281
+ * @template WithTrim - Whether to trim whitespace before checking (default `true`).
282
+ *
283
+ * @example
284
+ * ```ts
285
+ * type Case1 = IsNonEmptyString<"abc">;
286
+ * // ➔ true
287
+ * type Case2 = IsNonEmptyString<"">;
288
+ * // ➔ false
289
+ * type Case3 = IsNonEmptyString<" ", true>;
290
+ * // ➔ false (trimmed)
291
+ * type Case4 = IsNonEmptyString<" ", false>;
292
+ * // ➔ true (not trimmed)
293
+ * ```
294
+ */
295
295
  type IsNonEmptyString<T extends string,WithTrim extends boolean=true>=IfNot<IsNever<NonEmptyString<T,WithTrim>>>;
296
296
  /** -------------------------------------------------------
297
- * * ***IfEmptyString.***
298
- * -------------------------------------------------------
299
- * Conditional type: returns `IfTrue` if `T` is an empty string `""`,
300
- * otherwise returns `IfFalse`. Optionally trims whitespace before checking.
301
- *
302
- * @template T - The string type to check.
303
- * @template IfTrue - Type returned if `T` is empty (default `true`).
304
- * @template IfFalse - Type returned if `T` is not empty (default `false`).
305
- * @template WithTrim - Whether to trim whitespace before checking (default `true`).
306
- *
307
- * @example
308
- * ```ts
309
- * type Case1 = IfEmptyString<"">;
310
- * // ➔ true
311
- * type Case2 = IfEmptyString<"abc">;
312
- * // ➔ false
313
- * type Case3 = IfEmptyString<"", "yes", "no">;
314
- * // ➔ "yes"
315
- * type Case4 = IfEmptyString<"abc", "yes", "no">;
316
- * // ➔ "no"
317
- * type Case5 = IfEmptyString<" ", "yes", "no", true>;
318
- * // ➔ "yes" (trimmed)
319
- * type Case6 = IfEmptyString<" ", "yes", "no", false>;
320
- * // ➔ "no" (not trimmed)
321
- * ```
322
- */
297
+ * * ***IfEmptyString.***
298
+ * -------------------------------------------------------
299
+ * Conditional type: returns `IfTrue` if `T` is an empty string `""`,
300
+ * otherwise returns `IfFalse`. Optionally trims whitespace before checking.
301
+ *
302
+ * @template T - The string type to check.
303
+ * @template IfTrue - Type returned if `T` is empty (default `true`).
304
+ * @template IfFalse - Type returned if `T` is not empty (default `false`).
305
+ * @template WithTrim - Whether to trim whitespace before checking (default `true`).
306
+ *
307
+ * @example
308
+ * ```ts
309
+ * type Case1 = IfEmptyString<"">;
310
+ * // ➔ true
311
+ * type Case2 = IfEmptyString<"abc">;
312
+ * // ➔ false
313
+ * type Case3 = IfEmptyString<"", "yes", "no">;
314
+ * // ➔ "yes"
315
+ * type Case4 = IfEmptyString<"abc", "yes", "no">;
316
+ * // ➔ "no"
317
+ * type Case5 = IfEmptyString<" ", "yes", "no", true>;
318
+ * // ➔ "yes" (trimmed)
319
+ * type Case6 = IfEmptyString<" ", "yes", "no", false>;
320
+ * // ➔ "no" (not trimmed)
321
+ * ```
322
+ */
323
323
  type IfEmptyString<T extends string,IfTrue=true,IfFalse=false,WithTrim extends boolean=true>=IfNot<IsNever<EmptyString<T,WithTrim>>,IfTrue,IfFalse>;
324
324
  /** -------------------------------------------------------
325
- * * ***IfNonEmptyString.***
326
- * -------------------------------------------------------
327
- * Conditional type: returns `IfTrue` if `T` is a non-empty string,
328
- * otherwise returns `IfFalse`. Optionally trims whitespace before checking.
329
- *
330
- * @template T - The string type to check.
331
- * @template IfTrue - Type returned if `T` is non-empty (default `true`).
332
- * @template IfFalse - Type returned if `T` is empty (default `false`).
333
- * @template WithTrim - Whether to trim whitespace before checking (default `true`).
334
- *
335
- * @example
336
- * ```ts
337
- * type Case1 = IfNonEmptyString<"abc">;
338
- * // ➔ true
339
- * type Case2 = IfNonEmptyString<"">;
340
- * // ➔ false
341
- * type Case3 = IfNonEmptyString<"abc", "yes", "no">;
342
- * // ➔ "yes"
343
- * type Case4 = IfNonEmptyString<"", "yes", "no">;
344
- * // ➔ "no"
345
- * type Case5 = IfNonEmptyString<" ", "yes", "no", true>;
346
- * // ➔ "no" (trimmed)
347
- * type Case6 = IfNonEmptyString<" ", "yes", "no", false>;
348
- * // ➔ "yes" (not trimmed)
349
- * ```
350
- */
325
+ * * ***IfNonEmptyString.***
326
+ * -------------------------------------------------------
327
+ * Conditional type: returns `IfTrue` if `T` is a non-empty string,
328
+ * otherwise returns `IfFalse`. Optionally trims whitespace before checking.
329
+ *
330
+ * @template T - The string type to check.
331
+ * @template IfTrue - Type returned if `T` is non-empty (default `true`).
332
+ * @template IfFalse - Type returned if `T` is empty (default `false`).
333
+ * @template WithTrim - Whether to trim whitespace before checking (default `true`).
334
+ *
335
+ * @example
336
+ * ```ts
337
+ * type Case1 = IfNonEmptyString<"abc">;
338
+ * // ➔ true
339
+ * type Case2 = IfNonEmptyString<"">;
340
+ * // ➔ false
341
+ * type Case3 = IfNonEmptyString<"abc", "yes", "no">;
342
+ * // ➔ "yes"
343
+ * type Case4 = IfNonEmptyString<"", "yes", "no">;
344
+ * // ➔ "no"
345
+ * type Case5 = IfNonEmptyString<" ", "yes", "no", true>;
346
+ * // ➔ "no" (trimmed)
347
+ * type Case6 = IfNonEmptyString<" ", "yes", "no", false>;
348
+ * // ➔ "yes" (not trimmed)
349
+ * ```
350
+ */
351
351
  type IfNonEmptyString<T extends string,IfTrue=true,IfFalse=false,WithTrim extends boolean=true>=IfNot<IsNever<NonEmptyString<T,WithTrim>>,IfTrue,IfFalse>;export type{AnyString as A,EmptyString as E,IfNot as I,NonEmptyString as N,Trim as T,Whitespace as W,IsEmptyString as a,IfEmptyString as b,WordSeparator as c,IfNonEmptyString as d,IsNonEmptyString as e,TrimLeft as f,TrimRight as g,TrimsLower as h,TrimsUpper as i};