ts-data-forge 10.0.0 → 11.0.1

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 (249) hide show
  1. package/dist/array/impl/array-utils-creation.d.mts +3 -3
  2. package/dist/array/impl/array-utils-creation.d.mts.map +1 -1
  3. package/dist/array/impl/array-utils-creation.mjs.map +1 -1
  4. package/dist/array/impl/array-utils-element-access.d.mts +4 -4
  5. package/dist/array/impl/array-utils-element-access.mjs.map +1 -1
  6. package/dist/{guard/as-length-bounded-array.d.mts → array/impl/array-utils-length-bounded-array-cast.d.mts} +9 -9
  7. package/dist/array/impl/array-utils-length-bounded-array-cast.d.mts.map +1 -0
  8. package/dist/{guard/as-length-bounded-array.mjs → array/impl/array-utils-length-bounded-array-cast.mjs} +2 -2
  9. package/dist/array/impl/array-utils-length-bounded-array-cast.mjs.map +1 -0
  10. package/dist/{guard/is-length-bounded-array.d.mts → array/impl/array-utils-length-bounded-array-guard.d.mts} +13 -13
  11. package/dist/array/impl/array-utils-length-bounded-array-guard.d.mts.map +1 -0
  12. package/dist/{guard/is-length-bounded-array.mjs → array/impl/array-utils-length-bounded-array-guard.mjs} +1 -1
  13. package/dist/array/impl/array-utils-length-bounded-array-guard.mjs.map +1 -0
  14. package/dist/array/impl/array-utils-modification.d.mts +9 -9
  15. package/dist/array/impl/array-utils-modification.d.mts.map +1 -1
  16. package/dist/array/impl/array-utils-modification.mjs.map +1 -1
  17. package/dist/array/impl/array-utils-reducing-value.d.mts +9 -9
  18. package/dist/array/impl/array-utils-reducing-value.mjs.map +1 -1
  19. package/dist/array/impl/array-utils-size.d.mts +3 -3
  20. package/dist/array/impl/array-utils-size.mjs.map +1 -1
  21. package/dist/array/impl/array-utils-slicing.d.mts +9 -9
  22. package/dist/array/impl/array-utils-slicing.d.mts.map +1 -1
  23. package/dist/array/impl/array-utils-slicing.mjs.map +1 -1
  24. package/dist/array/impl/array-utils-transformation.d.mts +16 -10
  25. package/dist/array/impl/array-utils-transformation.d.mts.map +1 -1
  26. package/dist/array/impl/array-utils-transformation.mjs.map +1 -1
  27. package/dist/array/impl/index.d.mts +2 -0
  28. package/dist/array/impl/index.d.mts.map +1 -1
  29. package/dist/array/impl/index.mjs +2 -0
  30. package/dist/array/impl/index.mjs.map +1 -1
  31. package/dist/entry-point.mjs +1 -3
  32. package/dist/entry-point.mjs.map +1 -1
  33. package/dist/guard/index.d.mts +0 -3
  34. package/dist/guard/index.d.mts.map +1 -1
  35. package/dist/guard/index.mjs +0 -3
  36. package/dist/guard/index.mjs.map +1 -1
  37. package/dist/index.d.mts +1 -0
  38. package/dist/index.d.mts.map +1 -1
  39. package/dist/index.mjs +1 -3
  40. package/dist/index.mjs.map +1 -1
  41. package/dist/number/branded-types/finite-number.d.mts +47 -61
  42. package/dist/number/branded-types/finite-number.d.mts.map +1 -1
  43. package/dist/number/branded-types/finite-number.mjs +37 -41
  44. package/dist/number/branded-types/finite-number.mjs.map +1 -1
  45. package/dist/number/branded-types/int.d.mts +40 -46
  46. package/dist/number/branded-types/int.d.mts.map +1 -1
  47. package/dist/number/branded-types/int.mjs +29 -31
  48. package/dist/number/branded-types/int.mjs.map +1 -1
  49. package/dist/number/branded-types/int16.d.mts +65 -58
  50. package/dist/number/branded-types/int16.d.mts.map +1 -1
  51. package/dist/number/branded-types/int16.mjs +49 -45
  52. package/dist/number/branded-types/int16.mjs.map +1 -1
  53. package/dist/number/branded-types/int32.d.mts +65 -58
  54. package/dist/number/branded-types/int32.d.mts.map +1 -1
  55. package/dist/number/branded-types/int32.mjs +49 -45
  56. package/dist/number/branded-types/int32.mjs.map +1 -1
  57. package/dist/number/branded-types/negative-finite-number.d.mts +68 -59
  58. package/dist/number/branded-types/negative-finite-number.d.mts.map +1 -1
  59. package/dist/number/branded-types/negative-finite-number.mjs +52 -46
  60. package/dist/number/branded-types/negative-finite-number.mjs.map +1 -1
  61. package/dist/number/branded-types/negative-int.d.mts +60 -48
  62. package/dist/number/branded-types/negative-int.d.mts.map +1 -1
  63. package/dist/number/branded-types/negative-int.mjs +40 -36
  64. package/dist/number/branded-types/negative-int.mjs.map +1 -1
  65. package/dist/number/branded-types/negative-safe-int.d.mts +57 -56
  66. package/dist/number/branded-types/negative-safe-int.d.mts.map +1 -1
  67. package/dist/number/branded-types/negative-safe-int.mjs +40 -41
  68. package/dist/number/branded-types/negative-safe-int.mjs.map +1 -1
  69. package/dist/number/branded-types/non-negative-finite-number.d.mts +74 -64
  70. package/dist/number/branded-types/non-negative-finite-number.d.mts.map +1 -1
  71. package/dist/number/branded-types/non-negative-finite-number.mjs +58 -51
  72. package/dist/number/branded-types/non-negative-finite-number.mjs.map +1 -1
  73. package/dist/number/branded-types/non-negative-int16.d.mts +64 -57
  74. package/dist/number/branded-types/non-negative-int16.d.mts.map +1 -1
  75. package/dist/number/branded-types/non-negative-int16.mjs +47 -43
  76. package/dist/number/branded-types/non-negative-int16.mjs.map +1 -1
  77. package/dist/number/branded-types/non-negative-int32.d.mts +64 -58
  78. package/dist/number/branded-types/non-negative-int32.d.mts.map +1 -1
  79. package/dist/number/branded-types/non-negative-int32.mjs +47 -44
  80. package/dist/number/branded-types/non-negative-int32.mjs.map +1 -1
  81. package/dist/number/branded-types/non-positive-finite-number.d.mts +64 -54
  82. package/dist/number/branded-types/non-positive-finite-number.d.mts.map +1 -1
  83. package/dist/number/branded-types/non-positive-finite-number.mjs +48 -41
  84. package/dist/number/branded-types/non-positive-finite-number.mjs.map +1 -1
  85. package/dist/number/branded-types/non-positive-int.d.mts +41 -146
  86. package/dist/number/branded-types/non-positive-int.d.mts.map +1 -1
  87. package/dist/number/branded-types/non-positive-int.mjs +27 -107
  88. package/dist/number/branded-types/non-positive-int.mjs.map +1 -1
  89. package/dist/number/branded-types/non-positive-safe-int.d.mts +54 -53
  90. package/dist/number/branded-types/non-positive-safe-int.d.mts.map +1 -1
  91. package/dist/number/branded-types/non-positive-safe-int.mjs +37 -39
  92. package/dist/number/branded-types/non-positive-safe-int.mjs.map +1 -1
  93. package/dist/number/branded-types/non-zero-finite-number.d.mts +62 -49
  94. package/dist/number/branded-types/non-zero-finite-number.d.mts.map +1 -1
  95. package/dist/number/branded-types/non-zero-finite-number.mjs +46 -37
  96. package/dist/number/branded-types/non-zero-finite-number.mjs.map +1 -1
  97. package/dist/number/branded-types/non-zero-int.d.mts +51 -38
  98. package/dist/number/branded-types/non-zero-int.d.mts.map +1 -1
  99. package/dist/number/branded-types/non-zero-int.mjs +31 -27
  100. package/dist/number/branded-types/non-zero-int.mjs.map +1 -1
  101. package/dist/number/branded-types/non-zero-int16.d.mts +52 -53
  102. package/dist/number/branded-types/non-zero-int16.d.mts.map +1 -1
  103. package/dist/number/branded-types/non-zero-int16.mjs +36 -39
  104. package/dist/number/branded-types/non-zero-int16.mjs.map +1 -1
  105. package/dist/number/branded-types/non-zero-int32.d.mts +52 -54
  106. package/dist/number/branded-types/non-zero-int32.d.mts.map +1 -1
  107. package/dist/number/branded-types/non-zero-int32.mjs +36 -40
  108. package/dist/number/branded-types/non-zero-int32.mjs.map +1 -1
  109. package/dist/number/branded-types/non-zero-safe-int.d.mts +53 -54
  110. package/dist/number/branded-types/non-zero-safe-int.d.mts.map +1 -1
  111. package/dist/number/branded-types/non-zero-safe-int.mjs +36 -40
  112. package/dist/number/branded-types/non-zero-safe-int.mjs.map +1 -1
  113. package/dist/number/branded-types/non-zero-uint16.d.mts +52 -53
  114. package/dist/number/branded-types/non-zero-uint16.d.mts.map +1 -1
  115. package/dist/number/branded-types/non-zero-uint16.mjs +35 -39
  116. package/dist/number/branded-types/non-zero-uint16.mjs.map +1 -1
  117. package/dist/number/branded-types/non-zero-uint32.d.mts +52 -53
  118. package/dist/number/branded-types/non-zero-uint32.d.mts.map +1 -1
  119. package/dist/number/branded-types/non-zero-uint32.mjs +35 -39
  120. package/dist/number/branded-types/non-zero-uint32.mjs.map +1 -1
  121. package/dist/number/branded-types/positive-finite-number.d.mts +74 -63
  122. package/dist/number/branded-types/positive-finite-number.d.mts.map +1 -1
  123. package/dist/number/branded-types/positive-finite-number.mjs +58 -50
  124. package/dist/number/branded-types/positive-finite-number.mjs.map +1 -1
  125. package/dist/number/branded-types/positive-int.d.mts +46 -68
  126. package/dist/number/branded-types/positive-int.d.mts.map +1 -1
  127. package/dist/number/branded-types/positive-int.mjs +34 -49
  128. package/dist/number/branded-types/positive-int.mjs.map +1 -1
  129. package/dist/number/branded-types/positive-int16.d.mts +61 -57
  130. package/dist/number/branded-types/positive-int16.d.mts.map +1 -1
  131. package/dist/number/branded-types/positive-int16.mjs +44 -43
  132. package/dist/number/branded-types/positive-int16.mjs.map +1 -1
  133. package/dist/number/branded-types/positive-int32.d.mts +61 -57
  134. package/dist/number/branded-types/positive-int32.d.mts.map +1 -1
  135. package/dist/number/branded-types/positive-int32.mjs +44 -43
  136. package/dist/number/branded-types/positive-int32.mjs.map +1 -1
  137. package/dist/number/branded-types/positive-safe-int.d.mts +62 -57
  138. package/dist/number/branded-types/positive-safe-int.d.mts.map +1 -1
  139. package/dist/number/branded-types/positive-safe-int.mjs +45 -43
  140. package/dist/number/branded-types/positive-safe-int.mjs.map +1 -1
  141. package/dist/number/branded-types/positive-uint16.d.mts +61 -57
  142. package/dist/number/branded-types/positive-uint16.d.mts.map +1 -1
  143. package/dist/number/branded-types/positive-uint16.mjs +44 -43
  144. package/dist/number/branded-types/positive-uint16.mjs.map +1 -1
  145. package/dist/number/branded-types/positive-uint32.d.mts +61 -58
  146. package/dist/number/branded-types/positive-uint32.d.mts.map +1 -1
  147. package/dist/number/branded-types/positive-uint32.mjs +44 -44
  148. package/dist/number/branded-types/positive-uint32.mjs.map +1 -1
  149. package/dist/number/branded-types/safe-int.d.mts +43 -62
  150. package/dist/number/branded-types/safe-int.d.mts.map +1 -1
  151. package/dist/number/branded-types/safe-int.mjs +35 -42
  152. package/dist/number/branded-types/safe-int.mjs.map +1 -1
  153. package/dist/number/branded-types/safe-uint.d.mts +62 -57
  154. package/dist/number/branded-types/safe-uint.d.mts.map +1 -1
  155. package/dist/number/branded-types/safe-uint.mjs +46 -44
  156. package/dist/number/branded-types/safe-uint.mjs.map +1 -1
  157. package/dist/number/branded-types/uint.d.mts +63 -50
  158. package/dist/number/branded-types/uint.d.mts.map +1 -1
  159. package/dist/number/branded-types/uint.mjs +42 -39
  160. package/dist/number/branded-types/uint.mjs.map +1 -1
  161. package/dist/number/branded-types/uint16.d.mts +60 -58
  162. package/dist/number/branded-types/uint16.d.mts.map +1 -1
  163. package/dist/number/branded-types/uint16.mjs +44 -43
  164. package/dist/number/branded-types/uint16.mjs.map +1 -1
  165. package/dist/number/branded-types/uint32.d.mts +59 -55
  166. package/dist/number/branded-types/uint32.d.mts.map +1 -1
  167. package/dist/number/branded-types/uint32.mjs +42 -42
  168. package/dist/number/branded-types/uint32.mjs.map +1 -1
  169. package/dist/number/enum/int8.d.mts +56 -65
  170. package/dist/number/enum/int8.d.mts.map +1 -1
  171. package/dist/number/enum/int8.mjs +44 -43
  172. package/dist/number/enum/int8.mjs.map +1 -1
  173. package/dist/number/enum/uint8.d.mts +60 -58
  174. package/dist/number/enum/uint8.d.mts.map +1 -1
  175. package/dist/number/enum/uint8.mjs +44 -43
  176. package/dist/number/enum/uint8.mjs.map +1 -1
  177. package/dist/string/index.d.mts +2 -0
  178. package/dist/string/index.d.mts.map +1 -0
  179. package/dist/string/index.mjs +2 -0
  180. package/dist/string/index.mjs.map +1 -0
  181. package/dist/string/str.d.mts +273 -0
  182. package/dist/string/str.d.mts.map +1 -0
  183. package/dist/string/str.mjs +42 -0
  184. package/dist/string/str.mjs.map +1 -0
  185. package/package.json +31 -92
  186. package/src/array/impl/array-utils-creation.mts +2 -1
  187. package/src/array/impl/array-utils-element-access.mts +3 -3
  188. package/src/array/impl/array-utils-element-access.test.mts +3 -3
  189. package/src/{guard/as-length-bounded-array.mts → array/impl/array-utils-length-bounded-array-cast.mts} +9 -9
  190. package/src/{guard/as-length-bounded-array.test.mts → array/impl/array-utils-length-bounded-array-cast.test.mts} +2 -2
  191. package/src/{guard/is-length-bounded-array.mts → array/impl/array-utils-length-bounded-array-guard.mts} +12 -12
  192. package/src/{guard/is-length-bounded-array.test.mts → array/impl/array-utils-length-bounded-array-guard.test.mts} +2 -2
  193. package/src/array/impl/array-utils-modification.mts +9 -8
  194. package/src/array/impl/array-utils-modification.test.mts +6 -1
  195. package/src/array/impl/array-utils-reducing-value.mts +9 -9
  196. package/src/array/impl/array-utils-size.mts +2 -2
  197. package/src/array/impl/array-utils-slicing.mts +24 -13
  198. package/src/array/impl/array-utils-transformation.mts +18 -12
  199. package/src/array/impl/array-utils-transformation.test.mts +12 -12
  200. package/src/array/impl/index.mts +2 -0
  201. package/src/guard/index.mts +0 -3
  202. package/src/index.mts +1 -0
  203. package/src/number/branded-types/finite-number.mts +47 -61
  204. package/src/number/branded-types/int.mts +40 -46
  205. package/src/number/branded-types/int16.mts +65 -58
  206. package/src/number/branded-types/int32.mts +65 -58
  207. package/src/number/branded-types/negative-finite-number.mts +68 -68
  208. package/src/number/branded-types/negative-int.mts +60 -57
  209. package/src/number/branded-types/negative-safe-int.mts +57 -65
  210. package/src/number/branded-types/non-negative-finite-number.mts +74 -64
  211. package/src/number/branded-types/non-negative-int16.mts +64 -57
  212. package/src/number/branded-types/non-negative-int32.mts +64 -58
  213. package/src/number/branded-types/non-positive-finite-number.mts +64 -54
  214. package/src/number/branded-types/non-positive-int.mts +41 -146
  215. package/src/number/branded-types/non-positive-safe-int.mts +54 -53
  216. package/src/number/branded-types/non-zero-finite-number.mts +62 -51
  217. package/src/number/branded-types/non-zero-int.mts +51 -38
  218. package/src/number/branded-types/non-zero-int16.mts +52 -53
  219. package/src/number/branded-types/non-zero-int32.mts +52 -54
  220. package/src/number/branded-types/non-zero-safe-int.mts +53 -54
  221. package/src/number/branded-types/non-zero-uint16.mts +52 -53
  222. package/src/number/branded-types/non-zero-uint32.mts +52 -53
  223. package/src/number/branded-types/positive-finite-number.mts +74 -63
  224. package/src/number/branded-types/positive-int.mts +46 -68
  225. package/src/number/branded-types/positive-int16.mts +61 -57
  226. package/src/number/branded-types/positive-int32.mts +61 -57
  227. package/src/number/branded-types/positive-safe-int.mts +62 -57
  228. package/src/number/branded-types/positive-uint16.mts +61 -57
  229. package/src/number/branded-types/positive-uint32.mts +61 -58
  230. package/src/number/branded-types/safe-int.mts +43 -62
  231. package/src/number/branded-types/safe-uint.mts +62 -57
  232. package/src/number/branded-types/uint.mts +63 -50
  233. package/src/number/branded-types/uint16.mts +60 -58
  234. package/src/number/branded-types/uint32.mts +59 -55
  235. package/src/number/enum/int8.mts +56 -65
  236. package/src/number/enum/uint8.mts +60 -58
  237. package/src/string/index.mts +1 -0
  238. package/src/string/str.mts +371 -0
  239. package/src/string/str.test.mts +215 -0
  240. package/dist/guard/as-length-bounded-array.d.mts.map +0 -1
  241. package/dist/guard/as-length-bounded-array.mjs.map +0 -1
  242. package/dist/guard/is-length-bounded-array.d.mts.map +0 -1
  243. package/dist/guard/is-length-bounded-array.mjs.map +0 -1
  244. package/dist/guard/is-length-bounded-string.d.mts +0 -163
  245. package/dist/guard/is-length-bounded-string.d.mts.map +0 -1
  246. package/dist/guard/is-length-bounded-string.mjs +0 -7
  247. package/dist/guard/is-length-bounded-string.mjs.map +0 -1
  248. package/src/guard/is-length-bounded-string.mts +0 -199
  249. package/src/guard/is-length-bounded-string.test.mts +0 -170
@@ -3,9 +3,8 @@ export type Int = TtfImported_Int;
3
3
  /**
4
4
  * Type guard that checks if a value is an integer.
5
5
  *
6
- * Returns `true` if the value is any integer (positive, negative, or zero),
7
- * with no fractional component. This includes values outside the safe integer
8
- * range, unlike SafeInt.
6
+ * Returns `true` for an integer — a value with no fractional component,
7
+ * including values outside the safe integer range (unlike `SafeInt`).
9
8
  *
10
9
  * @example
11
10
  *
@@ -22,11 +21,10 @@ export type Int = TtfImported_Int;
22
21
  */
23
22
  export declare const isInt: (a: number) => a is TtfImported_Int;
24
23
  /**
25
- * Casts a number to an Int branded type.
24
+ * Casts a `number` to the `Int` branded type.
26
25
  *
27
- * This function validates that the input is an integer and returns it with the
28
- * Int brand. Throws a TypeError if the value has a fractional component or is
29
- * not a finite number.
26
+ * Validates that the value is an integer and returns it with the `Int` brand.
27
+ * Throws a `TypeError` otherwise.
30
28
  *
31
29
  * @example
32
30
  *
@@ -39,7 +37,7 @@ export declare const isInt: (a: number) => a is TtfImported_Int;
39
37
  * ```
40
38
  *
41
39
  * @param value - The value to cast
42
- * @returns The value as an Int branded type
40
+ * @returns The value as an `Int`
43
41
  * @throws {TypeError} If the value is not an integer
44
42
  */
45
43
  export declare const asInt: <N extends number>(x: N) => number & {
@@ -50,15 +48,13 @@ export declare const asInt: <N extends number>(x: N) => number & {
50
48
  'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
51
49
  }> & N;
52
50
  /**
53
- * Namespace providing type-safe operations for Int branded types.
51
+ * Namespace providing type-safe operations for the `Int` branded type.
54
52
  *
55
- * The Int type represents any integer value (no fractional component) without
56
- * range restrictions. All operations preserve the integer constraint, using
57
- * floor division for division operations.
53
+ * The `Int` type represents an integer. Division (`div`) uses floor division.
58
54
  *
59
- * Unlike SafeInt, Int allows values outside the safe integer range (±2^53 - 1),
60
- * but be aware that very large integers may lose precision in JavaScript's
61
- * number type.
55
+ * Unlike `SafeInt`, `Int` allows values outside the safe integer range (±2^53 −
56
+ * 1), so very large magnitudes may lose precision in JavaScript's `number`
57
+ * type.
62
58
  */
63
59
  export declare const Int: {
64
60
  /**
@@ -82,9 +78,9 @@ export declare const Int: {
82
78
  /**
83
79
  * Returns the absolute value of an integer.
84
80
  *
85
- * The result is always non-negative and maintains the Int brand. Note that
86
- * Math.abs(Number.MIN_SAFE_INTEGER) exceeds Number.MAX_SAFE_INTEGER, so use
87
- * SafeInt for guaranteed precision.
81
+ * The result is non-negative and keeps the `Int` brand. Note that
82
+ * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
83
+ * use `SafeInt` for guaranteed precision.
88
84
  *
89
85
  * @example
90
86
  *
@@ -99,11 +95,11 @@ export declare const Int: {
99
95
  * ```
100
96
  *
101
97
  * @param a - The integer value
102
- * @returns The absolute value as a non-negative Int
98
+ * @returns The absolute value as a non-negative `Int`
103
99
  */
104
100
  readonly abs: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int>) => import("ts-type-forge").IntersectBrand<TtfImported_Int, import("ts-type-forge").NonNegativeNumber>;
105
101
  /**
106
- * Returns the minimum value from a list of integers.
102
+ * Returns the smallest of the given integers.
107
103
  *
108
104
  * @example
109
105
  *
@@ -114,11 +110,11 @@ export declare const Int: {
114
110
  * ```
115
111
  *
116
112
  * @param values - The integers to compare (at least one required)
117
- * @returns The smallest value as an Int
113
+ * @returns The smallest value as an `Int`
118
114
  */
119
115
  readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Int>[]) => TtfImported_Int;
120
116
  /**
121
- * Returns the maximum value from a list of integers.
117
+ * Returns the largest of the given integers.
122
118
  *
123
119
  * @example
124
120
  *
@@ -129,14 +125,13 @@ export declare const Int: {
129
125
  * ```
130
126
  *
131
127
  * @param values - The integers to compare (at least one required)
132
- * @returns The largest value as an Int
128
+ * @returns The largest value as an `Int`
133
129
  */
134
130
  readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Int>[]) => TtfImported_Int;
135
131
  /**
136
- * Generates a random integer within the specified range (inclusive).
132
+ * Generates a random `Int` within the given range.
137
133
  *
138
- * The range is inclusive on both ends, so random(1, 6) can return any of: 1,
139
- * 2, 3, 4, 5, or 6.
134
+ * The range is inclusive on both ends.
140
135
  *
141
136
  * @example
142
137
  *
@@ -154,11 +149,12 @@ export declare const Int: {
154
149
  *
155
150
  * @param min - The minimum value (inclusive)
156
151
  * @param max - The maximum value (inclusive)
157
- * @returns A random Int in the range [min, max]
152
+ * @returns A random `Int` in `[min, max]`
158
153
  */
159
154
  readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_Int> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_Int> | undefined) => TtfImported_Int;
160
155
  /**
161
- * Raises an integer to a power.
156
+ * Raises `a` to the power `b`, returning `a ** b` as an `Int` (floored to an
157
+ * integer).
162
158
  *
163
159
  * @example
164
160
  *
@@ -174,11 +170,11 @@ export declare const Int: {
174
170
  *
175
171
  * @param a - The base integer
176
172
  * @param b - The exponent integer
177
- * @returns `a ** b` as an Int
173
+ * @returns `a ** b` as an `Int`
178
174
  */
179
175
  readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int>) => TtfImported_Int;
180
176
  /**
181
- * Adds two integers.
177
+ * Adds two integers, returning `a + b` as an `Int`.
182
178
  *
183
179
  * @example
184
180
  *
@@ -188,13 +184,13 @@ export declare const Int: {
188
184
  * assert.isTrue(sum === 20);
189
185
  * ```
190
186
  *
191
- * @param a - First integer
192
- * @param b - Second integer
193
- * @returns `a + b` as an Int
187
+ * @param a - The first integer
188
+ * @param b - The second integer
189
+ * @returns The sum of `a` and `b` as an `Int`
194
190
  */
195
191
  readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int>) => TtfImported_Int;
196
192
  /**
197
- * Subtracts two integers.
193
+ * Subtracts two integers, returning `a - b` as an `Int`.
198
194
  *
199
195
  * @example
200
196
  *
@@ -204,13 +200,13 @@ export declare const Int: {
204
200
  * assert.isTrue(difference === 4);
205
201
  * ```
206
202
  *
207
- * @param a - First integer
208
- * @param b - Second integer
209
- * @returns `a - b` as an Int
203
+ * @param a - The first integer
204
+ * @param b - The second integer
205
+ * @returns The difference of `a` and `b` as an `Int`
210
206
  */
211
207
  readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int>) => TtfImported_Int;
212
208
  /**
213
- * Multiplies two integers.
209
+ * Multiplies two integers, returning `a * b` as an `Int`.
214
210
  *
215
211
  * @example
216
212
  *
@@ -220,16 +216,14 @@ export declare const Int: {
220
216
  * assert.isTrue(product === -24);
221
217
  * ```
222
218
  *
223
- * @param a - First integer
224
- * @param b - Second integer
225
- * @returns `a * b` as an Int
219
+ * @param a - The first integer
220
+ * @param b - The second integer
221
+ * @returns The product of `a` and `b` as an `Int`
226
222
  */
227
223
  readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int>) => TtfImported_Int;
228
224
  /**
229
- * Divides two integers using floor division.
230
- *
231
- * Performs mathematical floor division: `⌊a / b⌋`. The result is always an
232
- * integer, rounding toward negative infinity.
225
+ * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
226
+ * b` rounded toward negative infinity, as an `Int`.
233
227
  *
234
228
  * @example
235
229
  *
@@ -245,7 +239,7 @@ export declare const Int: {
245
239
  *
246
240
  * @param a - The dividend
247
241
  * @param b - The divisor (must be non-zero)
248
- * @returns The integer quotient as an Int
242
+ * @returns The floored quotient as an `Int`
249
243
  */
250
244
  readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int>, y: -40 | -39 | -38 | -37 | -36 | -35 | -34 | -33 | -32 | -31 | -30 | -29 | -28 | -27 | -26 | -25 | -24 | -23 | -22 | -21 | -20 | -19 | -18 | -17 | -16 | -15 | -14 | -13 | -12 | -11 | -10 | -9 | -8 | -7 | -6 | -5 | -4 | -3 | -2 | -1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
251
245
  readonly "!=0": true;
@@ -1 +1 @@
1
- {"version":3,"file":"int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,IAAI,eAAe,EAAE,MAAM,eAAe,CAAC;AAI5D,MAAM,MAAM,GAAG,GAAG,eAAe,CAAC;AA6BlC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,qCAAK,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,KAAK;;;;;;MAAW,CAAC;AAE9B;;;;;;;;;;GAUG;AACH,eAAO,MAAM,GAAG;IACd;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;;;;;;OAqBG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;OAuBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;;;;;OAqBG;;;;;;;;;CAEK,CAAC"}
1
+ {"version":3,"file":"int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,IAAI,eAAe,EAAE,MAAM,eAAe,CAAC;AAI5D,MAAM,MAAM,GAAG,GAAG,eAAe,CAAC;AA6BlC;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,KAAK,qCAAK,CAAC;AAExB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK;;;;;;MAAW,CAAC;AAE9B;;;;;;;;GAQG;AACH,eAAO,MAAM,GAAG;IACd;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;;;;;;OAqBG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;;;;;;;;CAEK,CAAC"}
@@ -43,9 +43,9 @@ const Int = {
43
43
  /**
44
44
  * Returns the absolute value of an integer.
45
45
  *
46
- * The result is always non-negative and maintains the Int brand. Note that
47
- * Math.abs(Number.MIN_SAFE_INTEGER) exceeds Number.MAX_SAFE_INTEGER, so use
48
- * SafeInt for guaranteed precision.
46
+ * The result is non-negative and keeps the `Int` brand. Note that
47
+ * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
48
+ * use `SafeInt` for guaranteed precision.
49
49
  *
50
50
  * @example
51
51
  *
@@ -60,11 +60,11 @@ const Int = {
60
60
  * ```
61
61
  *
62
62
  * @param a - The integer value
63
- * @returns The absolute value as a non-negative Int
63
+ * @returns The absolute value as a non-negative `Int`
64
64
  */
65
65
  abs,
66
66
  /**
67
- * Returns the minimum value from a list of integers.
67
+ * Returns the smallest of the given integers.
68
68
  *
69
69
  * @example
70
70
  *
@@ -75,11 +75,11 @@ const Int = {
75
75
  * ```
76
76
  *
77
77
  * @param values - The integers to compare (at least one required)
78
- * @returns The smallest value as an Int
78
+ * @returns The smallest value as an `Int`
79
79
  */
80
80
  min: min_,
81
81
  /**
82
- * Returns the maximum value from a list of integers.
82
+ * Returns the largest of the given integers.
83
83
  *
84
84
  * @example
85
85
  *
@@ -90,14 +90,13 @@ const Int = {
90
90
  * ```
91
91
  *
92
92
  * @param values - The integers to compare (at least one required)
93
- * @returns The largest value as an Int
93
+ * @returns The largest value as an `Int`
94
94
  */
95
95
  max: max_,
96
96
  /**
97
- * Generates a random integer within the specified range (inclusive).
97
+ * Generates a random `Int` within the given range.
98
98
  *
99
- * The range is inclusive on both ends, so random(1, 6) can return any of: 1,
100
- * 2, 3, 4, 5, or 6.
99
+ * The range is inclusive on both ends.
101
100
  *
102
101
  * @example
103
102
  *
@@ -115,11 +114,12 @@ const Int = {
115
114
  *
116
115
  * @param min - The minimum value (inclusive)
117
116
  * @param max - The maximum value (inclusive)
118
- * @returns A random Int in the range [min, max]
117
+ * @returns A random `Int` in `[min, max]`
119
118
  */
120
119
  random,
121
120
  /**
122
- * Raises an integer to a power.
121
+ * Raises `a` to the power `b`, returning `a ** b` as an `Int` (floored to an
122
+ * integer).
123
123
  *
124
124
  * @example
125
125
  *
@@ -135,11 +135,11 @@ const Int = {
135
135
  *
136
136
  * @param a - The base integer
137
137
  * @param b - The exponent integer
138
- * @returns `a ** b` as an Int
138
+ * @returns `a ** b` as an `Int`
139
139
  */
140
140
  pow,
141
141
  /**
142
- * Adds two integers.
142
+ * Adds two integers, returning `a + b` as an `Int`.
143
143
  *
144
144
  * @example
145
145
  *
@@ -149,13 +149,13 @@ const Int = {
149
149
  * assert.isTrue(sum === 20);
150
150
  * ```
151
151
  *
152
- * @param a - First integer
153
- * @param b - Second integer
154
- * @returns `a + b` as an Int
152
+ * @param a - The first integer
153
+ * @param b - The second integer
154
+ * @returns The sum of `a` and `b` as an `Int`
155
155
  */
156
156
  add,
157
157
  /**
158
- * Subtracts two integers.
158
+ * Subtracts two integers, returning `a - b` as an `Int`.
159
159
  *
160
160
  * @example
161
161
  *
@@ -165,13 +165,13 @@ const Int = {
165
165
  * assert.isTrue(difference === 4);
166
166
  * ```
167
167
  *
168
- * @param a - First integer
169
- * @param b - Second integer
170
- * @returns `a - b` as an Int
168
+ * @param a - The first integer
169
+ * @param b - The second integer
170
+ * @returns The difference of `a` and `b` as an `Int`
171
171
  */
172
172
  sub,
173
173
  /**
174
- * Multiplies two integers.
174
+ * Multiplies two integers, returning `a * b` as an `Int`.
175
175
  *
176
176
  * @example
177
177
  *
@@ -181,16 +181,14 @@ const Int = {
181
181
  * assert.isTrue(product === -24);
182
182
  * ```
183
183
  *
184
- * @param a - First integer
185
- * @param b - Second integer
186
- * @returns `a * b` as an Int
184
+ * @param a - The first integer
185
+ * @param b - The second integer
186
+ * @returns The product of `a` and `b` as an `Int`
187
187
  */
188
188
  mul,
189
189
  /**
190
- * Divides two integers using floor division.
191
- *
192
- * Performs mathematical floor division: `⌊a / b⌋`. The result is always an
193
- * integer, rounding toward negative infinity.
190
+ * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
191
+ * b` rounded toward negative infinity, as an `Int`.
194
192
  *
195
193
  * @example
196
194
  *
@@ -206,7 +204,7 @@ const Int = {
206
204
  *
207
205
  * @param a - The dividend
208
206
  * @param b - The divisor (must be non-zero)
209
- * @returns The integer quotient as an Int
207
+ * @returns The floored quotient as an `Int`
210
208
  */
211
209
  div
212
210
  };
@@ -1 +1 @@
1
- {"version":3,"file":"int.mjs","sources":["../../../src/number/branded-types/int.mts"],"sourcesContent":["import { type Int as TtfImported_Int } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Int = TtfImported_Int;\n\ntype ElementType = Int;\n\nconst typeNameInMessage = 'an integer';\n\nconst {\n abs,\n add,\n castType,\n div,\n is,\n max: max_,\n min: min_,\n mul,\n pow,\n random,\n sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n ElementType,\n number,\n number\n>({\n integerOrSafeInteger: 'Integer',\n MIN_VALUE: -Number.MAX_VALUE,\n MAX_VALUE: Number.MAX_VALUE,\n typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is an integer.\n *\n * Returns `true` if the value is any integer (positive, negative, or zero),\n * with no fractional component. This includes values outside the safe integer\n * range, unlike SafeInt.\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isInt(5));\n *\n * assert.isFalse(isInt(5.25));\n *\n * assert.isTrue(Int.is(-10));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is an integer, `false` otherwise\n */\nexport const isInt = is;\n\n/**\n * Casts a number to an Int branded type.\n *\n * This function validates that the input is an integer and returns it with the\n * Int brand. Throws a TypeError if the value has a fractional component or is\n * not a finite number.\n *\n * @example\n *\n * ```ts\n * const branded = asInt(42);\n *\n * assert.isTrue(branded === 42);\n *\n * assert.isTrue(Int.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as an Int branded type\n * @throws {TypeError} If the value is not an integer\n */\nexport const asInt = castType;\n\n/**\n * Namespace providing type-safe operations for Int branded types.\n *\n * The Int type represents any integer value (no fractional component) without\n * range restrictions. All operations preserve the integer constraint, using\n * floor division for division operations.\n *\n * Unlike SafeInt, Int allows values outside the safe integer range (±2^53 - 1),\n * but be aware that very large integers may lose precision in JavaScript's\n * number type.\n */\nexport const Int = {\n /**\n * Type guard that checks if a value is an integer.\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isInt(5));\n *\n * assert.isFalse(isInt(5.25));\n *\n * assert.isTrue(Int.is(-10));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is an integer, `false` otherwise\n * @see {@link isInt} for usage examples\n */\n is,\n\n /**\n * Returns the absolute value of an integer.\n *\n * The result is always non-negative and maintains the Int brand. Note that\n * Math.abs(Number.MIN_SAFE_INTEGER) exceeds Number.MAX_SAFE_INTEGER, so use\n * SafeInt for guaranteed precision.\n *\n * @example\n *\n * ```ts\n * const negative = asInt(-12);\n *\n * const absolute = Int.abs(negative);\n *\n * assert.isTrue(absolute === 12);\n *\n * assert.isTrue(Int.is(absolute));\n * ```\n *\n * @param a - The integer value\n * @returns The absolute value as a non-negative Int\n */\n abs,\n\n /**\n * Returns the minimum value from a list of integers.\n *\n * @example\n *\n * ```ts\n * const smallest = Int.min(asInt(7), asInt(-3), asInt(2));\n *\n * assert.isTrue(smallest === -3);\n * ```\n *\n * @param values - The integers to compare (at least one required)\n * @returns The smallest value as an Int\n */\n min: min_,\n\n /**\n * Returns the maximum value from a list of integers.\n *\n * @example\n *\n * ```ts\n * const largest = Int.max(asInt(7), asInt(-3), asInt(2));\n *\n * assert.isTrue(largest === 7);\n * ```\n *\n * @param values - The integers to compare (at least one required)\n * @returns The largest value as an Int\n */\n max: max_,\n\n /**\n * Generates a random integer within the specified range (inclusive).\n *\n * The range is inclusive on both ends, so random(1, 6) can return any of: 1,\n * 2, 3, 4, 5, or 6.\n *\n * @example\n *\n * ```ts\n * const min = asInt(1);\n *\n * const max = asInt(6);\n *\n * const randomValue = Int.random(min, max);\n *\n * assert.isTrue(Int.is(randomValue));\n *\n * assert.isTrue(randomValue >= 1 && randomValue <= 6);\n * ```\n *\n * @param min - The minimum value (inclusive)\n * @param max - The maximum value (inclusive)\n * @returns A random Int in the range [min, max]\n */\n random,\n\n /**\n * Raises an integer to a power.\n *\n * @example\n *\n * ```ts\n * const base = asInt(2);\n *\n * const exponent = asInt(5);\n *\n * const power = Int.pow(base, exponent);\n *\n * assert.isTrue(power === 32);\n * ```\n *\n * @param a - The base integer\n * @param b - The exponent integer\n * @returns `a ** b` as an Int\n */\n pow,\n\n /**\n * Adds two integers.\n *\n * @example\n *\n * ```ts\n * const sum = Int.add(asInt(12), asInt(8));\n *\n * assert.isTrue(sum === 20);\n * ```\n *\n * @param a - First integer\n * @param b - Second integer\n * @returns `a + b` as an Int\n */\n add,\n\n /**\n * Subtracts two integers.\n *\n * @example\n *\n * ```ts\n * const difference = Int.sub(asInt(12), asInt(8));\n *\n * assert.isTrue(difference === 4);\n * ```\n *\n * @param a - First integer\n * @param b - Second integer\n * @returns `a - b` as an Int\n */\n sub,\n\n /**\n * Multiplies two integers.\n *\n * @example\n *\n * ```ts\n * const product = Int.mul(asInt(-4), asInt(6));\n *\n * assert.isTrue(product === -24);\n * ```\n *\n * @param a - First integer\n * @param b - Second integer\n * @returns `a * b` as an Int\n */\n mul,\n\n /**\n * Divides two integers using floor division.\n *\n * Performs mathematical floor division: `⌊a / b⌋`. The result is always an\n * integer, rounding toward negative infinity.\n *\n * @example\n *\n * ```ts\n * const dividend = asInt(17);\n *\n * const divisor = asInt(5);\n *\n * const quotient = Int.div(dividend, divisor);\n *\n * assert.isTrue(quotient === 3);\n * ```\n *\n * @param a - The dividend\n * @param b - The divisor (must be non-zero)\n * @returns The integer quotient as an Int\n */\n div,\n} as const;\n\nexpectType<\n keyof typeof Int,\n keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int'>\n>('=');\n\nexpectType<\n typeof Int,\n TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int'>\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,YAAA;AAE1B,MAAM;AAAA,EACJ,GAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,SAAA;AAAA,EACtB,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAsBH,MAAM,KAAA,GAAQ;AAuBd,MAAM,KAAA,GAAQ;AAad,MAAM,GAAA,GAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBjB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0BL,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA;AACF;;;;"}
1
+ {"version":3,"file":"int.mjs","sources":["../../../src/number/branded-types/int.mts"],"sourcesContent":["import { type Int as TtfImported_Int } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Int = TtfImported_Int;\n\ntype ElementType = Int;\n\nconst typeNameInMessage = 'an integer';\n\nconst {\n abs,\n add,\n castType,\n div,\n is,\n max: max_,\n min: min_,\n mul,\n pow,\n random,\n sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n ElementType,\n number,\n number\n>({\n integerOrSafeInteger: 'Integer',\n MIN_VALUE: -Number.MAX_VALUE,\n MAX_VALUE: Number.MAX_VALUE,\n typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is an integer.\n *\n * Returns `true` for an integer — a value with no fractional component,\n * including values outside the safe integer range (unlike `SafeInt`).\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isInt(5));\n *\n * assert.isFalse(isInt(5.25));\n *\n * assert.isTrue(Int.is(-10));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is an integer, `false` otherwise\n */\nexport const isInt = is;\n\n/**\n * Casts a `number` to the `Int` branded type.\n *\n * Validates that the value is an integer and returns it with the `Int` brand.\n * Throws a `TypeError` otherwise.\n *\n * @example\n *\n * ```ts\n * const branded = asInt(42);\n *\n * assert.isTrue(branded === 42);\n *\n * assert.isTrue(Int.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as an `Int`\n * @throws {TypeError} If the value is not an integer\n */\nexport const asInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `Int` branded type.\n *\n * The `Int` type represents an integer. Division (`div`) uses floor division.\n *\n * Unlike `SafeInt`, `Int` allows values outside the safe integer range (±2^53 −\n * 1), so very large magnitudes may lose precision in JavaScript's `number`\n * type.\n */\nexport const Int = {\n /**\n * Type guard that checks if a value is an integer.\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isInt(5));\n *\n * assert.isFalse(isInt(5.25));\n *\n * assert.isTrue(Int.is(-10));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is an integer, `false` otherwise\n * @see {@link isInt} for usage examples\n */\n is,\n\n /**\n * Returns the absolute value of an integer.\n *\n * The result is non-negative and keeps the `Int` brand. Note that\n * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so\n * use `SafeInt` for guaranteed precision.\n *\n * @example\n *\n * ```ts\n * const negative = asInt(-12);\n *\n * const absolute = Int.abs(negative);\n *\n * assert.isTrue(absolute === 12);\n *\n * assert.isTrue(Int.is(absolute));\n * ```\n *\n * @param a - The integer value\n * @returns The absolute value as a non-negative `Int`\n */\n abs,\n\n /**\n * Returns the smallest of the given integers.\n *\n * @example\n *\n * ```ts\n * const smallest = Int.min(asInt(7), asInt(-3), asInt(2));\n *\n * assert.isTrue(smallest === -3);\n * ```\n *\n * @param values - The integers to compare (at least one required)\n * @returns The smallest value as an `Int`\n */\n min: min_,\n\n /**\n * Returns the largest of the given integers.\n *\n * @example\n *\n * ```ts\n * const largest = Int.max(asInt(7), asInt(-3), asInt(2));\n *\n * assert.isTrue(largest === 7);\n * ```\n *\n * @param values - The integers to compare (at least one required)\n * @returns The largest value as an `Int`\n */\n max: max_,\n\n /**\n * Generates a random `Int` within the given range.\n *\n * The range is inclusive on both ends.\n *\n * @example\n *\n * ```ts\n * const min = asInt(1);\n *\n * const max = asInt(6);\n *\n * const randomValue = Int.random(min, max);\n *\n * assert.isTrue(Int.is(randomValue));\n *\n * assert.isTrue(randomValue >= 1 && randomValue <= 6);\n * ```\n *\n * @param min - The minimum value (inclusive)\n * @param max - The maximum value (inclusive)\n * @returns A random `Int` in `[min, max]`\n */\n random,\n\n /**\n * Raises `a` to the power `b`, returning `a ** b` as an `Int` (floored to an\n * integer).\n *\n * @example\n *\n * ```ts\n * const base = asInt(2);\n *\n * const exponent = asInt(5);\n *\n * const power = Int.pow(base, exponent);\n *\n * assert.isTrue(power === 32);\n * ```\n *\n * @param a - The base integer\n * @param b - The exponent integer\n * @returns `a ** b` as an `Int`\n */\n pow,\n\n /**\n * Adds two integers, returning `a + b` as an `Int`.\n *\n * @example\n *\n * ```ts\n * const sum = Int.add(asInt(12), asInt(8));\n *\n * assert.isTrue(sum === 20);\n * ```\n *\n * @param a - The first integer\n * @param b - The second integer\n * @returns The sum of `a` and `b` as an `Int`\n */\n add,\n\n /**\n * Subtracts two integers, returning `a - b` as an `Int`.\n *\n * @example\n *\n * ```ts\n * const difference = Int.sub(asInt(12), asInt(8));\n *\n * assert.isTrue(difference === 4);\n * ```\n *\n * @param a - The first integer\n * @param b - The second integer\n * @returns The difference of `a` and `b` as an `Int`\n */\n sub,\n\n /**\n * Multiplies two integers, returning `a * b` as an `Int`.\n *\n * @example\n *\n * ```ts\n * const product = Int.mul(asInt(-4), asInt(6));\n *\n * assert.isTrue(product === -24);\n * ```\n *\n * @param a - The first integer\n * @param b - The second integer\n * @returns The product of `a` and `b` as an `Int`\n */\n mul,\n\n /**\n * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /\n * b` rounded toward negative infinity, as an `Int`.\n *\n * @example\n *\n * ```ts\n * const dividend = asInt(17);\n *\n * const divisor = asInt(5);\n *\n * const quotient = Int.div(dividend, divisor);\n *\n * assert.isTrue(quotient === 3);\n * ```\n *\n * @param a - The dividend\n * @param b - The divisor (must be non-zero)\n * @returns The floored quotient as an `Int`\n */\n div,\n} as const;\n\nexpectType<\n keyof typeof Int,\n keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int'>\n>('=');\n\nexpectType<\n typeof Int,\n TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int'>\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,YAAA;AAE1B,MAAM;AAAA,EACJ,GAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,SAAA;AAAA,EACtB,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAqBH,MAAM,KAAA,GAAQ;AAsBd,MAAM,KAAA,GAAQ;AAWd,MAAM,GAAA,GAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBjB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBL,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA;AACF;;;;"}
@@ -1,19 +1,24 @@
1
1
  import { type Int16 as TtfImported_Int16 } from 'ts-type-forge';
2
2
  export type Int16 = TtfImported_Int16;
3
3
  /**
4
- * Checks if a number is an Int16 (16-bit signed integer in the range [-2^15,
5
- * 2^15)).
4
+ * Type guard that checks if a value is an integer in [-2^15, 2^15).
6
5
  *
7
- * @param value The value to check.
8
- * @returns `true` if the value is an Int16, `false` otherwise.
6
+ * Returns `true` for an integer in [-2^15, 2^15) — a value with no fractional
7
+ * component.
8
+ *
9
+ * @param value - The value to check
10
+ * @returns `true` if the value is an integer in [-2^15, 2^15), `false` otherwise
9
11
  */
10
12
  export declare const isInt16: (a: number) => a is TtfImported_Int16;
11
13
  /**
12
- * Casts a number to an Int16 type.
14
+ * Casts a `number` to the `Int16` branded type.
15
+ *
16
+ * Validates that the value is an integer in [-2^15, 2^15) and returns it with
17
+ * the `Int16` brand. Throws a `TypeError` otherwise.
13
18
  *
14
- * @param value The value to cast.
15
- * @returns The value as an Int16 type.
16
- * @throws {TypeError} If the value is not an integer in [-2^15, 2^15).
19
+ * @param value - The value to cast
20
+ * @returns The value as an `Int16`
21
+ * @throws {TypeError} If the value is not an integer in [-2^15, 2^15)
17
22
  */
18
23
  export declare const asInt16: <N extends number>(x: N) => number & {
19
24
  readonly "< 2^15": true;
@@ -32,107 +37,109 @@ export declare const asInt16: <N extends number>(x: N) => number & {
32
37
  'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
33
38
  }> & N;
34
39
  /**
35
- * Namespace providing type-safe arithmetic operations for 16-bit signed
36
- * integers.
40
+ * Namespace providing type-safe operations for the `Int16` branded type.
37
41
  *
38
- * All operations automatically clamp results to the valid Int16 range [-32768,
39
- * 32767]. This ensures that all arithmetic maintains the 16-bit signed integer
40
- * constraint.
42
+ * The `Int16` type represents an integer in [-2^15, 2^15). Division (`div`)
43
+ * uses floor division.
41
44
  */
42
45
  export declare const Int16: {
43
46
  /**
44
- * Type guard to check if a value is an Int16.
47
+ * Type guard that checks if a value is an integer in [-2^15, 2^15).
45
48
  *
46
- * @param value The value to check.
47
- * @returns `true` if the value is a 16-bit signed integer, `false` otherwise.
49
+ * @param value - The value to check
50
+ * @returns `true` if the value is an integer in [-2^15, 2^15), `false` otherwise
51
+ * @see {@link isInt16} for usage examples
48
52
  */
49
53
  readonly is: (a: number) => a is TtfImported_Int16;
50
54
  /**
51
- * The minimum value for a 16-bit signed integer.
52
- *
53
- * @readonly
55
+ * The smallest value representable as `Int16`.
54
56
  */
55
57
  readonly MIN_VALUE: number;
56
58
  /**
57
- * The maximum value for a 16-bit signed integer.
58
- *
59
- * @readonly
59
+ * The largest value representable as `Int16`.
60
60
  */
61
61
  readonly MAX_VALUE: number;
62
62
  /**
63
- * Returns the absolute value of a 16-bit signed integer.
63
+ * Returns the absolute value of an integer in [-2^15, 2^15).
64
+ *
65
+ * The result is non-negative and keeps the `Int16` brand.
64
66
  *
65
- * @param a The Int16 value.
66
- * @returns The absolute value as an Int16, clamped to valid range.
67
+ * @param a - The integer value
68
+ * @returns The absolute value as a non-negative `Int16`
67
69
  */
68
70
  readonly abs: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int16>) => import("ts-type-forge").IntersectBrand<TtfImported_Int16, import("ts-type-forge").NonNegativeNumber>;
69
71
  /**
70
- * Returns the smaller of two Int16 values.
72
+ * Returns the smallest of the given integers.
71
73
  *
72
- * @param a The first Int16.
73
- * @param b The second Int16.
74
- * @returns The minimum value as an Int16.
74
+ * @param values - The integers to compare (at least one required)
75
+ * @returns The smallest value as an `Int16`
75
76
  */
76
77
  readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Int16>[]) => TtfImported_Int16;
77
78
  /**
78
- * Returns the larger of two Int16 values.
79
+ * Returns the largest of the given integers.
79
80
  *
80
- * @param a The first Int16.
81
- * @param b The second Int16.
82
- * @returns The maximum value as an Int16.
81
+ * @param values - The integers to compare (at least one required)
82
+ * @returns The largest value as an `Int16`
83
83
  */
84
84
  readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Int16>[]) => TtfImported_Int16;
85
85
  /**
86
- * Clamps a number to the Int16 range.
86
+ * Clamps a `number` into the `Int16` range, rounding to the nearest integer
87
+ * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
87
88
  *
88
- * @param value The number to clamp.
89
- * @returns The value clamped to [-32768, 32767] as an Int16.
89
+ * @param value - The value to clamp
90
+ * @returns The clamped value as an `Int16`
90
91
  */
91
92
  readonly clamp: (x: number) => TtfImported_Int16;
92
93
  /**
93
- * Generates a random Int16 value within the valid range.
94
+ * Generates a random `Int16` within the given range.
95
+ *
96
+ * The range is inclusive on both ends.
94
97
  *
95
- * @returns A random Int16 between MIN_VALUE and MAX_VALUE.
98
+ * @param min - The minimum value (inclusive)
99
+ * @param max - The maximum value (inclusive)
100
+ * @returns A random `Int16` in `[min, max]`
96
101
  */
97
102
  readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_Int16> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_Int16> | undefined) => TtfImported_Int16;
98
103
  /**
99
- * Raises an Int16 to the power of another Int16.
104
+ * Raises `a` to the power `b`, returning `a ** b` as an `Int16` (floored to
105
+ * an integer).
100
106
  *
101
- * @param a The base Int16.
102
- * @param b The exponent Int16.
103
- * @returns `a ** b` clamped to [-32768, 32767] as an Int16.
107
+ * @param a - The base integer
108
+ * @param b - The exponent integer
109
+ * @returns `a ** b` as an `Int16`
104
110
  */
105
111
  readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int16>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int16>) => TtfImported_Int16;
106
112
  /**
107
- * Adds two Int16 values.
113
+ * Adds two integers, returning `a + b` as an `Int16`.
108
114
  *
109
- * @param a The first Int16.
110
- * @param b The second Int16.
111
- * @returns `a + b` clamped to [-32768, 32767] as an Int16.
115
+ * @param a - The first integer
116
+ * @param b - The second integer
117
+ * @returns The sum of `a` and `b` as an `Int16`
112
118
  */
113
119
  readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int16>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int16>) => TtfImported_Int16;
114
120
  /**
115
- * Subtracts one Int16 from another.
121
+ * Subtracts two integers, returning `a - b` as an `Int16`.
116
122
  *
117
- * @param a The minuend Int16.
118
- * @param b The subtrahend Int16.
119
- * @returns `a - b` clamped to [-32768, 32767] as an Int16.
123
+ * @param a - The first integer
124
+ * @param b - The second integer
125
+ * @returns The difference of `a` and `b` as an `Int16`
120
126
  */
121
127
  readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int16>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int16>) => TtfImported_Int16;
122
128
  /**
123
- * Multiplies two Int16 values.
129
+ * Multiplies two integers, returning `a * b` as an `Int16`.
124
130
  *
125
- * @param a The first Int16.
126
- * @param b The second Int16.
127
- * @returns `a * b` clamped to [-32768, 32767] as an Int16.
131
+ * @param a - The first integer
132
+ * @param b - The second integer
133
+ * @returns The product of `a` and `b` as an `Int16`
128
134
  */
129
135
  readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int16>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int16>) => TtfImported_Int16;
130
136
  /**
131
- * Divides one Int16 by another using floor division.
137
+ * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
138
+ * b` rounded toward negative infinity, as an `Int16`.
132
139
  *
133
- * @param a The dividend Int16.
134
- * @param b The divisor Int16.
135
- * @returns `⌊a / b⌋` clamped to [-32768, 32767] as an Int16.
140
+ * @param a - The dividend
141
+ * @param b - The divisor (must be non-zero)
142
+ * @returns The floored quotient as an `Int16`
136
143
  */
137
144
  readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int16>, y: -40 | -39 | -38 | -37 | -36 | -35 | -34 | -33 | -32 | -31 | -30 | -29 | -28 | -27 | -26 | -25 | -24 | -23 | -22 | -21 | -20 | -19 | -18 | -17 | -16 | -15 | -14 | -13 | -12 | -11 | -10 | -9 | -8 | -7 | -6 | -5 | -4 | -3 | -2 | -1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
138
145
  readonly "!=0": true;
@@ -1 +1 @@
1
- {"version":3,"file":"int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,IAAI,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAIhE,MAAM,MAAM,KAAK,GAAG,iBAAiB,CAAC;AAgCtC;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,uCAAK,CAAC;AAE1B;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;MAAW,CAAC;AAEhC;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;;;;;CAEK,CAAC"}
1
+ {"version":3,"file":"int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,IAAI,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAIhE,MAAM,MAAM,KAAK,GAAG,iBAAiB,CAAC;AAgCtC;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,uCAAK,CAAC;AAE1B;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;MAAW,CAAC;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;;;OAOG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;;;CAEK,CAAC"}