@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,367 +1,367 @@
1
1
  import{I as If}from'./if-CvT4R7Kh.js';import{I as IsNever}from'./never-BfayMBF9.js';
2
2
  /** -------------------------------------------------------
3
- * * ***Arrayable.***
4
- * -------------------------------------------------------
5
- * Represents a type that can be either:
6
- * - a single value of type `T`, or
7
- * - an array of values of type `T`.
8
- *
9
- * Useful when a function or API accepts **either one item or multiple items**.
10
- *
11
- * @template T - The element type.
12
- *
13
- * @example
14
- * ```ts
15
- * function toArray<T>(input: Arrayable<T>): T[] {
16
- * return Array.isArray(input) ? input : [input];
17
- * }
18
- *
19
- * type A = Arrayable<string>;
20
- * // ➔ string | string[]
21
- *
22
- * const a: A = "foo";
23
- * const b: A = ["foo", "bar"];
24
- * ```
25
- */
3
+ * * ***Arrayable.***
4
+ * -------------------------------------------------------
5
+ * Represents a type that can be either:
6
+ * - a single value of type `T`, or
7
+ * - an array of values of type `T`.
8
+ *
9
+ * Useful when a function or API accepts **either one item or multiple items**.
10
+ *
11
+ * @template T - The element type.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * function toArray<T>(input: Arrayable<T>): T[] {
16
+ * return Array.isArray(input) ? input : [input];
17
+ * }
18
+ *
19
+ * type A = Arrayable<string>;
20
+ * // ➔ string | string[]
21
+ *
22
+ * const a: A = "foo";
23
+ * const b: A = ["foo", "bar"];
24
+ * ```
25
+ */
26
26
  type Arrayable<T>=T|Array<T>;
27
27
  /** -------------------------------------------------------
28
- * * ***MutableArray.***
29
- * -------------------------------------------------------
30
- * Recursively creates a **mutable version** of a readonly array, tuple, or object type.
31
- *
32
- * By default, TypeScript infers tuple/array literals as `readonly` (especially with `as const`).
33
- * This utility removes the `readonly` modifier from all elements recursively,
34
- * turning a readonly tuple, array, or object into a mutable one.
35
- *
36
- * Optionally, if `Widen` is `true`, literal types (`1`, `'foo'`, `true`) are widened to
37
- * their primitive equivalents (`number`, `string`, `boolean`) for easier assignment.
38
- *
39
- * @template T - The readonly array, tuple, or object type to make mutable.
40
- * @template Widen - Whether to widen literal primitive types to their base types (default: `false`).
41
- *
42
- * @example
43
- * ```ts
44
- * type A = readonly [1, 2, 3];
45
- * type B = MutableArray<A>;
46
- * // ➔ [1, 2, 3]
47
- *
48
- * const x: A = [1, 2, 3] as const;
49
- * // x[0] = 9; // ❌ Error: read-only
50
- *
51
- * const y: MutableArray<B,true> = [1, 2, 3];
52
- * y[0] = 9; // ✅ Allowed
53
- *
54
- * // Recursive example with objects
55
- * type Obj = readonly [{ a: 1, b: readonly [2] }];
56
- * type MutableObj = MutableArray<Obj, true>;
57
- * // ➔ [{ a: number; b: [number]; }]
58
- * ```
59
- */
28
+ * * ***MutableArray.***
29
+ * -------------------------------------------------------
30
+ * Recursively creates a **mutable version** of a readonly array, tuple, or object type.
31
+ *
32
+ * By default, TypeScript infers tuple/array literals as `readonly` (especially with `as const`).
33
+ * This utility removes the `readonly` modifier from all elements recursively,
34
+ * turning a readonly tuple, array, or object into a mutable one.
35
+ *
36
+ * Optionally, if `Widen` is `true`, literal types (`1`, `'foo'`, `true`) are widened to
37
+ * their primitive equivalents (`number`, `string`, `boolean`) for easier assignment.
38
+ *
39
+ * @template T - The readonly array, tuple, or object type to make mutable.
40
+ * @template Widen - Whether to widen literal primitive types to their base types (default: `false`).
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * type A = readonly [1, 2, 3];
45
+ * type B = MutableArray<A>;
46
+ * // ➔ [1, 2, 3]
47
+ *
48
+ * const x: A = [1, 2, 3] as const;
49
+ * // x[0] = 9; // ❌ Error: read-only
50
+ *
51
+ * const y: MutableArray<B,true> = [1, 2, 3];
52
+ * y[0] = 9; // ✅ Allowed
53
+ *
54
+ * // Recursive example with objects
55
+ * type Obj = readonly [{ a: 1, b: readonly [2] }];
56
+ * type MutableObj = MutableArray<Obj, true>;
57
+ * // ➔ [{ a: number; b: [number]; }]
58
+ * ```
59
+ */
60
60
  type MutableArray<T,Widen extends boolean=false>=T extends(...args:any)=>any?T:T extends readonly any[]?{-readonly [K in keyof T]:MutableArray<T[K],Widen>;}:T extends object?{-readonly [K in keyof T]:MutableArray<T[K],Widen>;}:Widen extends true?T extends number?number:T extends string?string:T extends boolean?boolean:T extends bigint?bigint:T extends symbol?symbol:T:T;
61
61
  /** --------------------------------------------------
62
- * * ***GetArrayElementType.***
63
- * --------------------------------------------------
64
- * Gets the element type from a readonly array or tuple.
65
- *
66
- * ✅ Useful when working with `as const` arrays to extract the union of literal types.
67
- *
68
- * @template T - A readonly array or tuple type.
69
- *
70
- * @example
71
- * ```ts
72
- * const roles = ['admin', 'user'] as const;
73
- * type Role = GetArrayElementType<typeof roles>;
74
- * // ➔ "admin" | "user"
75
- * ```
76
- */
62
+ * * ***GetArrayElementType.***
63
+ * --------------------------------------------------
64
+ * Gets the element type from a readonly array or tuple.
65
+ *
66
+ * ✅ Useful when working with `as const` arrays to extract the union of literal types.
67
+ *
68
+ * @template T - A readonly array or tuple type.
69
+ *
70
+ * @example
71
+ * ```ts
72
+ * const roles = ['admin', 'user'] as const;
73
+ * type Role = GetArrayElementType<typeof roles>;
74
+ * // ➔ "admin" | "user"
75
+ * ```
76
+ */
77
77
  type GetArrayElementType<T extends readonly any[]>=T extends readonly(infer U)[]?U:never;
78
78
  /** -------------------------------------------------------
79
- * * ***EmptyArray.***
80
- * -------------------------------------------------------
81
- * A type-level utility that returns `T` if it is an ***empty array***,
82
- * otherwise returns `never`.
83
- *
84
- * @template T - The array type to check.
85
- * @example
86
- * ```ts
87
- * type A = EmptyArray<[]>;
88
- * // ➔ []
89
- * type B = EmptyArray<[1]>;
90
- * // ➔ never
91
- * type C = EmptyArray<string[]>;
92
- * // ➔ string[]
93
- * type D = EmptyArray<number[]>;
94
- * // ➔ number[]
95
- * type E = EmptyArray<readonly []>;
96
- * // ➔ readonly []
97
- * ```
98
- */
79
+ * * ***EmptyArray.***
80
+ * -------------------------------------------------------
81
+ * A type-level utility that returns `T` if it is an ***empty array***,
82
+ * otherwise returns `never`.
83
+ *
84
+ * @template T - The array type to check.
85
+ * @example
86
+ * ```ts
87
+ * type A = EmptyArray<[]>;
88
+ * // ➔ []
89
+ * type B = EmptyArray<[1]>;
90
+ * // ➔ never
91
+ * type C = EmptyArray<string[]>;
92
+ * // ➔ string[]
93
+ * type D = EmptyArray<number[]>;
94
+ * // ➔ number[]
95
+ * type E = EmptyArray<readonly []>;
96
+ * // ➔ readonly []
97
+ * ```
98
+ */
99
99
  type EmptyArray<T extends readonly unknown[]>=T extends readonly [ unknown,...unknown[]]?never:T;
100
100
  /** -------------------------------------------------------
101
- * * ***NonEmptyArray.***
102
- * -------------------------------------------------------
103
- * A type-level utility that returns `T` if it is a ***non-empty array***,
104
- * otherwise returns `never`.
105
- *
106
- * @template T - The array type to check.
107
- * @example
108
- * ```ts
109
- * type A = NonEmptyArray<[]>;
110
- * // ➔ never
111
- * type B = NonEmptyArray<[1]>;
112
- * // ➔ [1]
113
- * type C = NonEmptyArray<string[]>;
114
- * // ➔ never
115
- * type D = NonEmptyArray<number[]>;
116
- * // ➔ never
117
- * type E = NonEmptyArray<readonly []>;
118
- * // ➔ never
119
- * ```
120
- */
101
+ * * ***NonEmptyArray.***
102
+ * -------------------------------------------------------
103
+ * A type-level utility that returns `T` if it is a ***non-empty array***,
104
+ * otherwise returns `never`.
105
+ *
106
+ * @template T - The array type to check.
107
+ * @example
108
+ * ```ts
109
+ * type A = NonEmptyArray<[]>;
110
+ * // ➔ never
111
+ * type B = NonEmptyArray<[1]>;
112
+ * // ➔ [1]
113
+ * type C = NonEmptyArray<string[]>;
114
+ * // ➔ never
115
+ * type D = NonEmptyArray<number[]>;
116
+ * // ➔ never
117
+ * type E = NonEmptyArray<readonly []>;
118
+ * // ➔ never
119
+ * ```
120
+ */
121
121
  type NonEmptyArray<T extends readonly unknown[]>=If<IsNever<EmptyArray<T>>,T,never>;
122
122
  /** -------------------------------------------------------
123
- * * ***IsEmptyArray.***
124
- * -------------------------------------------------------
125
- * A type-level utility that evaluates to `true` if `T` is an ***empty array.***
126
- * (or can be empty per this definition), otherwise `false`.
127
- *
128
- * @template T - The array type to check.
129
- * @example
130
- * ```ts
131
- * type A = IsEmptyArray<[]>;
132
- * // ➔ true
133
- * type B = IsEmptyArray<[1]>;
134
- * // ➔ false
135
- * type C = IsEmptyArray<string[]>;
136
- * // ➔ true
137
- * type D = IsEmptyArray<number[]>;
138
- * // ➔ true
139
- * type E = IsEmptyArray<readonly []>;
140
- * // ➔ true
141
- * ```
142
- */
123
+ * * ***IsEmptyArray.***
124
+ * -------------------------------------------------------
125
+ * A type-level utility that evaluates to `true` if `T` is an ***empty array.***
126
+ * (or can be empty per this definition), otherwise `false`.
127
+ *
128
+ * @template T - The array type to check.
129
+ * @example
130
+ * ```ts
131
+ * type A = IsEmptyArray<[]>;
132
+ * // ➔ true
133
+ * type B = IsEmptyArray<[1]>;
134
+ * // ➔ false
135
+ * type C = IsEmptyArray<string[]>;
136
+ * // ➔ true
137
+ * type D = IsEmptyArray<number[]>;
138
+ * // ➔ true
139
+ * type E = IsEmptyArray<readonly []>;
140
+ * // ➔ true
141
+ * ```
142
+ */
143
143
  type IsEmptyArray<T extends readonly unknown[]>=If<IsNever<EmptyArray<T>>,false,true>;
144
144
  /** -------------------------------------------------------
145
- * * ***IsNonEmptyArray.***
146
- * -------------------------------------------------------
147
- * A type-level utility that evaluates to `true` if `T` is a ***non-empty array.***
148
- * (strictly a non-empty tuple), otherwise `false`.
149
- *
150
- * @template T - The array type to check.
151
- * @example
152
- * ```ts
153
- * type A = IsNonEmptyArray<[]>;
154
- * // ➔ false
155
- * type B = IsNonEmptyArray<[1]>;
156
- * // ➔ true
157
- * type C = IsNonEmptyArray<string[]>;
158
- * // ➔ false
159
- * type D = IsNonEmptyArray<number[]>;
160
- * // ➔ false
161
- * type E = IsNonEmptyArray<readonly []>;
162
- * // ➔ false
163
- * ```
164
- */
145
+ * * ***IsNonEmptyArray.***
146
+ * -------------------------------------------------------
147
+ * A type-level utility that evaluates to `true` if `T` is a ***non-empty array.***
148
+ * (strictly a non-empty tuple), otherwise `false`.
149
+ *
150
+ * @template T - The array type to check.
151
+ * @example
152
+ * ```ts
153
+ * type A = IsNonEmptyArray<[]>;
154
+ * // ➔ false
155
+ * type B = IsNonEmptyArray<[1]>;
156
+ * // ➔ true
157
+ * type C = IsNonEmptyArray<string[]>;
158
+ * // ➔ false
159
+ * type D = IsNonEmptyArray<number[]>;
160
+ * // ➔ false
161
+ * type E = IsNonEmptyArray<readonly []>;
162
+ * // ➔ false
163
+ * ```
164
+ */
165
165
  type IsNonEmptyArray<T extends readonly unknown[]>=If<IsNever<EmptyArray<T>>,true,false>;
166
166
  /** -------------------------------------------------------
167
- * * ***IfEmptyArray.***
168
- * -------------------------------------------------------
169
- * Returns the second argument if `T` is an ***empty array*** (per this utility),
170
- * otherwise returns the third argument.
171
- * - Defaults: `IfTrue = true`, `IfFalse = false`.
172
- *
173
- * @template T - The array type to check.
174
- * @template IfTrue - Returned type if `T` is empty by this definition.
175
- * @template IfFalse - Returned type if `T` is not empty by this definition.
176
- * @example
177
- * ```ts
178
- * type A = IfEmptyArray<[]>;
179
- * // ➔ true
180
- * type B = IfEmptyArray<[1]>;
181
- * // ➔ false
182
- * type C = IfEmptyArray<string[]>;
183
- * // ➔ true
184
- * type D = IfEmptyArray<readonly []>;
185
- * // ➔ true
186
- * type E = IfEmptyArray<[], "yes", "no">;
187
- * // ➔ "yes"
188
- * type F = IfEmptyArray<[1], "yes", "no">;
189
- * // ➔ "no"
190
- * type G = IfEmptyArray<string[], "yes", "no">;
191
- * // ➔ "yes"
192
- * ```
193
- */
167
+ * * ***IfEmptyArray.***
168
+ * -------------------------------------------------------
169
+ * Returns the second argument if `T` is an ***empty array*** (per this utility),
170
+ * otherwise returns the third argument.
171
+ * - Defaults: `IfTrue = true`, `IfFalse = false`.
172
+ *
173
+ * @template T - The array type to check.
174
+ * @template IfTrue - Returned type if `T` is empty by this definition.
175
+ * @template IfFalse - Returned type if `T` is not empty by this definition.
176
+ * @example
177
+ * ```ts
178
+ * type A = IfEmptyArray<[]>;
179
+ * // ➔ true
180
+ * type B = IfEmptyArray<[1]>;
181
+ * // ➔ false
182
+ * type C = IfEmptyArray<string[]>;
183
+ * // ➔ true
184
+ * type D = IfEmptyArray<readonly []>;
185
+ * // ➔ true
186
+ * type E = IfEmptyArray<[], "yes", "no">;
187
+ * // ➔ "yes"
188
+ * type F = IfEmptyArray<[1], "yes", "no">;
189
+ * // ➔ "no"
190
+ * type G = IfEmptyArray<string[], "yes", "no">;
191
+ * // ➔ "yes"
192
+ * ```
193
+ */
194
194
  type IfEmptyArray<T extends readonly unknown[],IfTrue=true,IfFalse=false>=If<IsEmptyArray<T>,IfTrue,IfFalse>;
195
195
  /** -------------------------------------------------------
196
- * * ***IfNonEmptyArray.***
197
- * -------------------------------------------------------
198
- * Returns the second argument if `T` is a ***non-empty array*** (strict tuple),
199
- * otherwise returns the third argument.
200
- * - Defaults: `IfTrue = true`, `IfFalse = false`.
201
- *
202
- * @template T - The array type to check.
203
- * @template IfTrue - Returned type if `T` is non-empty by this definition.
204
- * @template IfFalse - Returned type if `T` is not non-empty by this definition.
205
- * @example
206
- * ```ts
207
- * type A = IfNonEmptyArray<[]>;
208
- * // ➔ false
209
- * type B = IfNonEmptyArray<[1]>;
210
- * // ➔ true
211
- * type C = IfNonEmptyArray<string[]>;
212
- * // ➔ false
213
- * type D = IfNonEmptyArray<readonly []>;
214
- * // ➔ false
215
- * type E = IfNonEmptyArray<[1], "yes", "no">;
216
- * // ➔ "yes"
217
- * type F = IfNonEmptyArray<[], "yes", "no">;
218
- * // ➔ "no"
219
- * type G = IfNonEmptyArray<string[], "yes", "no">;
220
- * // ➔ "no"
221
- * ```
222
- */
196
+ * * ***IfNonEmptyArray.***
197
+ * -------------------------------------------------------
198
+ * Returns the second argument if `T` is a ***non-empty array*** (strict tuple),
199
+ * otherwise returns the third argument.
200
+ * - Defaults: `IfTrue = true`, `IfFalse = false`.
201
+ *
202
+ * @template T - The array type to check.
203
+ * @template IfTrue - Returned type if `T` is non-empty by this definition.
204
+ * @template IfFalse - Returned type if `T` is not non-empty by this definition.
205
+ * @example
206
+ * ```ts
207
+ * type A = IfNonEmptyArray<[]>;
208
+ * // ➔ false
209
+ * type B = IfNonEmptyArray<[1]>;
210
+ * // ➔ true
211
+ * type C = IfNonEmptyArray<string[]>;
212
+ * // ➔ false
213
+ * type D = IfNonEmptyArray<readonly []>;
214
+ * // ➔ false
215
+ * type E = IfNonEmptyArray<[1], "yes", "no">;
216
+ * // ➔ "yes"
217
+ * type F = IfNonEmptyArray<[], "yes", "no">;
218
+ * // ➔ "no"
219
+ * type G = IfNonEmptyArray<string[], "yes", "no">;
220
+ * // ➔ "no"
221
+ * ```
222
+ */
223
223
  type IfNonEmptyArray<T extends readonly unknown[],IfTrue=true,IfFalse=false>=If<IsNonEmptyArray<T>,IfTrue,IfFalse>;
224
224
  /** -------------------------------------------------------
225
- * * ***Not.***
226
- * -------------------------------------------------------
227
- * Accepts a boolean type `T` and returns its negation.
228
- *
229
- * @template T - Boolean type to negate.
230
- *
231
- * @example
232
- * ```ts
233
- * type A = Not<true>; // ➔ false
234
- * type B = Not<false>; // ➔ true
235
- * ```
236
- */
225
+ * * ***Not.***
226
+ * -------------------------------------------------------
227
+ * Accepts a boolean type `T` and returns its negation.
228
+ *
229
+ * @template T - Boolean type to negate.
230
+ *
231
+ * @example
232
+ * ```ts
233
+ * type A = Not<true>; // ➔ false
234
+ * type B = Not<false>; // ➔ true
235
+ * ```
236
+ */
237
237
  type Not<T extends boolean>=T extends true?false:true;
238
238
  /** -------------------------------------------------------
239
- * * ***PopOptions.***
240
- * -------------------------------------------------------
241
- *
242
- * Configuration options for the {@link Pop} type utility.
243
- */
239
+ * * ***PopOptions.***
240
+ * -------------------------------------------------------
241
+ *
242
+ * Configuration options for the {@link Pop} type utility.
243
+ */
244
244
  type PopOptions={
245
245
  /**
246
- * If `true`, {@link Pop} will return a tuple `[Rest, Removed]`
247
- * instead of just the remaining array.
248
- *
249
- * Default: `false`.
250
- *
251
- * @example
252
- * ```ts
253
- * type Options = { includeRemoved: true };
254
- * type Result = Pop<[1, 2, 3], Options>; // ➔ [[1, 2], 3]
255
- * ```
256
- */
246
+ * If `true`, {@link Pop} will return a tuple `[Rest, Removed]`
247
+ * instead of just the remaining array.
248
+ *
249
+ * Default: `false`.
250
+ *
251
+ * @example
252
+ * ```ts
253
+ * type Options = { includeRemoved: true };
254
+ * type Result = Pop<[1, 2, 3], Options>; // ➔ [[1, 2], 3]
255
+ * ```
256
+ */
257
257
  includeRemoved:boolean;};
258
258
  /** -------------------------------------------------------
259
- * * ***Pop.***
260
- * -------------------------------------------------------
261
- *
262
- * Removes the last element from a tuple/array type.
263
- *
264
- * If the `includeRemoved` option is `true`, it returns a tuple `[Rest, Removed]`
265
- * where `Rest` is the array without the last element, and `Removed` is the last element.
266
- *
267
- * @template T - The tuple or array to pop from.
268
- * @template Options - Configuration object. Default `{ includeRemoved: false }`.
269
- *
270
- * @example
271
- * ```ts
272
- * // Removes last element
273
- * type Case1 = Pop<[1, 2, 3]>
274
- * // ➔ [1, 2]
275
- *
276
- * // Removes last element and includes the removed value
277
- * type Case2 = Pop<[1, 2, 3], { includeRemoved: true }>
278
- * // ➔ [[1, 2], 3]
279
- *
280
- * // Edge case: empty array
281
- * type Case3 = Pop<[]>
282
- * // ➔ never
283
- * ```
284
- */
259
+ * * ***Pop.***
260
+ * -------------------------------------------------------
261
+ *
262
+ * Removes the last element from a tuple/array type.
263
+ *
264
+ * If the `includeRemoved` option is `true`, it returns a tuple `[Rest, Removed]`
265
+ * where `Rest` is the array without the last element, and `Removed` is the last element.
266
+ *
267
+ * @template T - The tuple or array to pop from.
268
+ * @template Options - Configuration object. Default `{ includeRemoved: false }`.
269
+ *
270
+ * @example
271
+ * ```ts
272
+ * // Removes last element
273
+ * type Case1 = Pop<[1, 2, 3]>
274
+ * // ➔ [1, 2]
275
+ *
276
+ * // Removes last element and includes the removed value
277
+ * type Case2 = Pop<[1, 2, 3], { includeRemoved: true }>
278
+ * // ➔ [[1, 2], 3]
279
+ *
280
+ * // Edge case: empty array
281
+ * type Case3 = Pop<[]>
282
+ * // ➔ never
283
+ * ```
284
+ */
285
285
  type Pop<T extends readonly unknown[],Options extends PopOptions={includeRemoved:false;}>=IsEmptyArray<T>extends true?never:T extends readonly [...infer Rest extends readonly unknown[],infer Removed]?If<Options["includeRemoved"],[Rest,Removed],Rest>:never;
286
286
  /** -------------------------------------------------------
287
- * * ***Extends.***
288
- * -------------------------------------------------------
289
- * Returns a boolean indicating whether the first argument ***extends*** the second argument.
290
- *
291
- * @template T - The type to check.
292
- * @template Base - The type to compare against.
293
- * @example
294
- * ```ts
295
- * type A = Extends<1, number>; // ➔ true
296
- * type B = Extends<number, 1>; // ➔ false
297
- * ```
298
- */
287
+ * * ***Extends.***
288
+ * -------------------------------------------------------
289
+ * Returns a boolean indicating whether the first argument ***extends*** the second argument.
290
+ *
291
+ * @template T - The type to check.
292
+ * @template Base - The type to compare against.
293
+ * @example
294
+ * ```ts
295
+ * type A = Extends<1, number>; // ➔ true
296
+ * type B = Extends<number, 1>; // ➔ false
297
+ * ```
298
+ */
299
299
  type Extends<T,Base>=[T] extends [Base]?true:false;
300
300
  /** -------------------------------------------------------
301
- * * ***NotExtends.***
302
- * -------------------------------------------------------
303
- * Returns a boolean indicating whether the first argument does ***not extend*** the second argument.
304
- *
305
- * @template T - The type to check.
306
- * @template Base - The type to compare against.
307
- * @example
308
- * ```ts
309
- * type A = NotExtends<1, number>; // ➔ false
310
- * type B = NotExtends<number, 1>; // ➔ true
311
- * ```
312
- */
301
+ * * ***NotExtends.***
302
+ * -------------------------------------------------------
303
+ * Returns a boolean indicating whether the first argument does ***not extend*** the second argument.
304
+ *
305
+ * @template T - The type to check.
306
+ * @template Base - The type to compare against.
307
+ * @example
308
+ * ```ts
309
+ * type A = NotExtends<1, number>; // ➔ false
310
+ * type B = NotExtends<number, 1>; // ➔ true
311
+ * ```
312
+ */
313
313
  type NotExtends<T,Base>=Not<Extends<T,Base>>;
314
314
  /** -------------------------------------------------------
315
- * * ***IfExtends.***
316
- * -------------------------------------------------------
317
- * Conditional: returns the third argument if the first argument ***extends*** the second argument, otherwise returns the fourth argument.
318
- * - Defaults: `IfTrue = true`, `IfFalse = false`.
319
- *
320
- * @template T - The type to check.
321
- * @template Base - The type to compare against.
322
- * @template IfTrue - The branch type if condition is met. (default: `true`)
323
- * @template IfFalse - The branch type if condition is not met. (default: `false`)
324
- * @example
325
- * ```ts
326
- * type A = IfExtends<1, number, "valid">;
327
- * // ➔ "valid"
328
- * type B = IfExtends<1, string, "valid", "invalid">;
329
- * // ➔ "invalid"
330
- * ```
331
- */
315
+ * * ***IfExtends.***
316
+ * -------------------------------------------------------
317
+ * Conditional: returns the third argument if the first argument ***extends*** the second argument, otherwise returns the fourth argument.
318
+ * - Defaults: `IfTrue = true`, `IfFalse = false`.
319
+ *
320
+ * @template T - The type to check.
321
+ * @template Base - The type to compare against.
322
+ * @template IfTrue - The branch type if condition is met. (default: `true`)
323
+ * @template IfFalse - The branch type if condition is not met. (default: `false`)
324
+ * @example
325
+ * ```ts
326
+ * type A = IfExtends<1, number, "valid">;
327
+ * // ➔ "valid"
328
+ * type B = IfExtends<1, string, "valid", "invalid">;
329
+ * // ➔ "invalid"
330
+ * ```
331
+ */
332
332
  type IfExtends<T,Base,IfTrue=true,IfFalse=false>=If<Extends<T,Base>,IfTrue,IfFalse>;
333
333
  /** -------------------------------------------------------
334
- * * ***IfNotExtends.***
335
- * -------------------------------------------------------
336
- * Conditional: returns the third argument if the first argument does ***not extend*** the second argument, otherwise returns the fourth argument.
337
- * - Defaults: `IfTrue = true`, `IfFalse = false`.
338
- *
339
- * @template T - The type to check.
340
- * @template Base - The type to compare against.
341
- * @template IfTrue - The branch type if condition is met. (default: `true`)
342
- * @template IfFalse - The branch type if condition is not met. (default: `false`)
343
- * @example
344
- * ```ts
345
- * type A = IfNotExtends<1, string, "valid">;
346
- * // ➔ "valid"
347
- * type B = IfNotExtends<1, number, "valid", "invalid">;
348
- * // ➔ "invalid"
349
- * ```
350
- */
334
+ * * ***IfNotExtends.***
335
+ * -------------------------------------------------------
336
+ * Conditional: returns the third argument if the first argument does ***not extend*** the second argument, otherwise returns the fourth argument.
337
+ * - Defaults: `IfTrue = true`, `IfFalse = false`.
338
+ *
339
+ * @template T - The type to check.
340
+ * @template Base - The type to compare against.
341
+ * @template IfTrue - The branch type if condition is met. (default: `true`)
342
+ * @template IfFalse - The branch type if condition is not met. (default: `false`)
343
+ * @example
344
+ * ```ts
345
+ * type A = IfNotExtends<1, string, "valid">;
346
+ * // ➔ "valid"
347
+ * type B = IfNotExtends<1, number, "valid", "invalid">;
348
+ * // ➔ "invalid"
349
+ * ```
350
+ */
351
351
  type IfNotExtends<T,Base,IfTrue=true,IfFalse=false>=If<NotExtends<T,Base>,IfTrue,IfFalse>;
352
352
  /** -------------------------------------------------------
353
- * * ***ExtendsArr.***
354
- * -------------------------------------------------------
355
- * Returns a boolean indicating whether every element of the first array argument ***extends*** the second argument.
356
- *
357
- * @template T - The array to check.
358
- * @template Base - The type to compare each element against.
359
- * @example
360
- * ```ts
361
- * type A = ExtendsArr<[1, 2, 3], number>;
362
- * // ➔ true
363
- * type B = ExtendsArr<[1, "2", 3], number>;
364
- * // ➔ false
365
- * ```
366
- */
353
+ * * ***ExtendsArr.***
354
+ * -------------------------------------------------------
355
+ * Returns a boolean indicating whether every element of the first array argument ***extends*** the second argument.
356
+ *
357
+ * @template T - The array to check.
358
+ * @template Base - The type to compare each element against.
359
+ * @example
360
+ * ```ts
361
+ * type A = ExtendsArr<[1, 2, 3], number>;
362
+ * // ➔ true
363
+ * type B = ExtendsArr<[1, "2", 3], number>;
364
+ * // ➔ false
365
+ * ```
366
+ */
367
367
  type ExtendsArr<T extends readonly unknown[],Base>=IsEmptyArray<T>extends true?true:Pop<T,{includeRemoved:true;}>extends readonly [infer Rest extends readonly unknown[],infer Removed]?Extends<Removed,Base>extends true?ExtendsArr<Rest,Base>:false:false;export type{Arrayable as A,Extends as E,GetArrayElementType as G,IfExtends as I,MutableArray as M,Not as N,Pop as P,NotExtends as a,IsEmptyArray as b,ExtendsArr as c,IfEmptyArray as d,EmptyArray as e,IfNonEmptyArray as f,IsNonEmptyArray as g,NonEmptyArray as h,IfNotExtends as i,PopOptions as j};