ts-data-forge 14.10.2 → 14.11.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 (424) hide show
  1. package/README.md +34 -1
  2. package/dist/array/impl/array-utils-reducing-value.d.mts.map +1 -1
  3. package/dist/array/impl/array-utils-reducing-value.mjs +4 -3
  4. package/dist/array/impl/array-utils-reducing-value.mjs.map +1 -1
  5. package/dist/array/impl/array-utils-slice-clamped.mjs +1 -1
  6. package/dist/array/impl/array-utils-slice-clamped.mjs.map +1 -1
  7. package/dist/array/impl/array-utils-slicing.d.mts.map +1 -1
  8. package/dist/array/impl/array-utils-slicing.mjs +10 -3
  9. package/dist/array/impl/array-utils-slicing.mjs.map +1 -1
  10. package/dist/array/impl/array-utils-transformation.d.mts.map +1 -1
  11. package/dist/array/impl/array-utils-transformation.mjs +2 -2
  12. package/dist/array/impl/array-utils-transformation.mjs.map +1 -1
  13. package/dist/array/impl/array-utils-validation.d.mts.map +1 -1
  14. package/dist/array/impl/array-utils-validation.mjs +2 -1
  15. package/dist/array/impl/array-utils-validation.mjs.map +1 -1
  16. package/dist/built-in-tag.d.mts +22 -0
  17. package/dist/built-in-tag.d.mts.map +1 -0
  18. package/dist/built-in-tag.mjs +34 -0
  19. package/dist/built-in-tag.mjs.map +1 -0
  20. package/dist/collections/stack.mjs +3 -3
  21. package/dist/collections/stack.mjs.map +1 -1
  22. package/dist/iterator/range.d.mts +1 -1
  23. package/dist/iterator/range.d.mts.map +1 -1
  24. package/dist/iterator/range.mjs +5 -2
  25. package/dist/iterator/range.mjs.map +1 -1
  26. package/dist/json/json.d.mts +20 -2
  27. package/dist/json/json.d.mts.map +1 -1
  28. package/dist/json/json.mjs +18 -0
  29. package/dist/json/json.mjs.map +1 -1
  30. package/dist/number/branded-types/finite-number.d.mts +4 -9
  31. package/dist/number/branded-types/finite-number.d.mts.map +1 -1
  32. package/dist/number/branded-types/finite-number.mjs +9 -9
  33. package/dist/number/branded-types/finite-number.mjs.map +1 -1
  34. package/dist/number/branded-types/int.d.mts +3 -9
  35. package/dist/number/branded-types/int.d.mts.map +1 -1
  36. package/dist/number/branded-types/int.mjs +9 -10
  37. package/dist/number/branded-types/int.mjs.map +1 -1
  38. package/dist/number/branded-types/int16.d.mts +3 -18
  39. package/dist/number/branded-types/int16.d.mts.map +1 -1
  40. package/dist/number/branded-types/int16.mjs +9 -10
  41. package/dist/number/branded-types/int16.mjs.map +1 -1
  42. package/dist/number/branded-types/int32.d.mts +3 -14
  43. package/dist/number/branded-types/int32.d.mts.map +1 -1
  44. package/dist/number/branded-types/int32.mjs +9 -10
  45. package/dist/number/branded-types/int32.mjs.map +1 -1
  46. package/dist/number/branded-types/negative-finite-number.d.mts +4 -16
  47. package/dist/number/branded-types/negative-finite-number.d.mts.map +1 -1
  48. package/dist/number/branded-types/negative-finite-number.mjs +9 -10
  49. package/dist/number/branded-types/negative-finite-number.mjs.map +1 -1
  50. package/dist/number/branded-types/negative-int.d.mts +3 -16
  51. package/dist/number/branded-types/negative-int.d.mts.map +1 -1
  52. package/dist/number/branded-types/negative-int.mjs +9 -11
  53. package/dist/number/branded-types/negative-int.mjs.map +1 -1
  54. package/dist/number/branded-types/negative-safe-int.d.mts +3 -17
  55. package/dist/number/branded-types/negative-safe-int.d.mts.map +1 -1
  56. package/dist/number/branded-types/negative-safe-int.mjs +9 -11
  57. package/dist/number/branded-types/negative-safe-int.mjs.map +1 -1
  58. package/dist/number/branded-types/non-negative-finite-number.d.mts +4 -14
  59. package/dist/number/branded-types/non-negative-finite-number.d.mts.map +1 -1
  60. package/dist/number/branded-types/non-negative-finite-number.mjs +9 -9
  61. package/dist/number/branded-types/non-negative-finite-number.mjs.map +1 -1
  62. package/dist/number/branded-types/non-negative-int16.d.mts +3 -19
  63. package/dist/number/branded-types/non-negative-int16.d.mts.map +1 -1
  64. package/dist/number/branded-types/non-negative-int16.mjs +9 -10
  65. package/dist/number/branded-types/non-negative-int16.mjs.map +1 -1
  66. package/dist/number/branded-types/non-negative-int32.d.mts +3 -17
  67. package/dist/number/branded-types/non-negative-int32.d.mts.map +1 -1
  68. package/dist/number/branded-types/non-negative-int32.mjs +9 -10
  69. package/dist/number/branded-types/non-negative-int32.mjs.map +1 -1
  70. package/dist/number/branded-types/non-positive-finite-number.d.mts +4 -14
  71. package/dist/number/branded-types/non-positive-finite-number.d.mts.map +1 -1
  72. package/dist/number/branded-types/non-positive-finite-number.mjs +9 -9
  73. package/dist/number/branded-types/non-positive-finite-number.mjs.map +1 -1
  74. package/dist/number/branded-types/non-positive-int.d.mts +3 -14
  75. package/dist/number/branded-types/non-positive-int.d.mts.map +1 -1
  76. package/dist/number/branded-types/non-positive-int.mjs +9 -10
  77. package/dist/number/branded-types/non-positive-int.mjs.map +1 -1
  78. package/dist/number/branded-types/non-positive-safe-int.d.mts +3 -15
  79. package/dist/number/branded-types/non-positive-safe-int.d.mts.map +1 -1
  80. package/dist/number/branded-types/non-positive-safe-int.mjs +9 -10
  81. package/dist/number/branded-types/non-positive-safe-int.mjs.map +1 -1
  82. package/dist/number/branded-types/non-zero-finite-number.d.mts +4 -10
  83. package/dist/number/branded-types/non-zero-finite-number.d.mts.map +1 -1
  84. package/dist/number/branded-types/non-zero-finite-number.mjs +9 -10
  85. package/dist/number/branded-types/non-zero-finite-number.mjs.map +1 -1
  86. package/dist/number/branded-types/non-zero-int.d.mts +3 -10
  87. package/dist/number/branded-types/non-zero-int.d.mts.map +1 -1
  88. package/dist/number/branded-types/non-zero-int.mjs +9 -11
  89. package/dist/number/branded-types/non-zero-int.mjs.map +1 -1
  90. package/dist/number/branded-types/non-zero-int16.d.mts +3 -19
  91. package/dist/number/branded-types/non-zero-int16.d.mts.map +1 -1
  92. package/dist/number/branded-types/non-zero-int16.mjs +12 -11
  93. package/dist/number/branded-types/non-zero-int16.mjs.map +1 -1
  94. package/dist/number/branded-types/non-zero-int32.d.mts +3 -15
  95. package/dist/number/branded-types/non-zero-int32.d.mts.map +1 -1
  96. package/dist/number/branded-types/non-zero-int32.mjs +12 -11
  97. package/dist/number/branded-types/non-zero-int32.mjs.map +1 -1
  98. package/dist/number/branded-types/non-zero-safe-int.d.mts +6 -14
  99. package/dist/number/branded-types/non-zero-safe-int.d.mts.map +1 -1
  100. package/dist/number/branded-types/non-zero-safe-int.mjs +9 -13
  101. package/dist/number/branded-types/non-zero-safe-int.mjs.map +1 -1
  102. package/dist/number/branded-types/non-zero-uint16.d.mts +3 -20
  103. package/dist/number/branded-types/non-zero-uint16.d.mts.map +1 -1
  104. package/dist/number/branded-types/non-zero-uint16.mjs +9 -11
  105. package/dist/number/branded-types/non-zero-uint16.mjs.map +1 -1
  106. package/dist/number/branded-types/non-zero-uint32.d.mts +3 -18
  107. package/dist/number/branded-types/non-zero-uint32.d.mts.map +1 -1
  108. package/dist/number/branded-types/non-zero-uint32.mjs +9 -11
  109. package/dist/number/branded-types/non-zero-uint32.mjs.map +1 -1
  110. package/dist/number/branded-types/positive-finite-number.d.mts +4 -16
  111. package/dist/number/branded-types/positive-finite-number.d.mts.map +1 -1
  112. package/dist/number/branded-types/positive-finite-number.mjs +9 -9
  113. package/dist/number/branded-types/positive-finite-number.mjs.map +1 -1
  114. package/dist/number/branded-types/positive-int.d.mts +3 -16
  115. package/dist/number/branded-types/positive-int.d.mts.map +1 -1
  116. package/dist/number/branded-types/positive-int.mjs +9 -10
  117. package/dist/number/branded-types/positive-int.mjs.map +1 -1
  118. package/dist/number/branded-types/positive-int16.d.mts +3 -21
  119. package/dist/number/branded-types/positive-int16.d.mts.map +1 -1
  120. package/dist/number/branded-types/positive-int16.mjs +9 -10
  121. package/dist/number/branded-types/positive-int16.mjs.map +1 -1
  122. package/dist/number/branded-types/positive-int32.d.mts +3 -19
  123. package/dist/number/branded-types/positive-int32.d.mts.map +1 -1
  124. package/dist/number/branded-types/positive-int32.mjs +9 -10
  125. package/dist/number/branded-types/positive-int32.mjs.map +1 -1
  126. package/dist/number/branded-types/positive-safe-int.d.mts +5 -19
  127. package/dist/number/branded-types/positive-safe-int.d.mts.map +1 -1
  128. package/dist/number/branded-types/positive-safe-int.mjs +9 -11
  129. package/dist/number/branded-types/positive-safe-int.mjs.map +1 -1
  130. package/dist/number/branded-types/positive-uint16.d.mts +3 -20
  131. package/dist/number/branded-types/positive-uint16.d.mts.map +1 -1
  132. package/dist/number/branded-types/positive-uint16.mjs +9 -10
  133. package/dist/number/branded-types/positive-uint16.mjs.map +1 -1
  134. package/dist/number/branded-types/positive-uint32.d.mts +3 -18
  135. package/dist/number/branded-types/positive-uint32.d.mts.map +1 -1
  136. package/dist/number/branded-types/positive-uint32.mjs +9 -10
  137. package/dist/number/branded-types/positive-uint32.mjs.map +1 -1
  138. package/dist/number/branded-types/safe-int.d.mts +5 -12
  139. package/dist/number/branded-types/safe-int.d.mts.map +1 -1
  140. package/dist/number/branded-types/safe-int.mjs +9 -12
  141. package/dist/number/branded-types/safe-int.mjs.map +1 -1
  142. package/dist/number/branded-types/safe-uint.d.mts +3 -15
  143. package/dist/number/branded-types/safe-uint.d.mts.map +1 -1
  144. package/dist/number/branded-types/safe-uint.mjs +9 -11
  145. package/dist/number/branded-types/safe-uint.mjs.map +1 -1
  146. package/dist/number/branded-types/uint.d.mts +3 -14
  147. package/dist/number/branded-types/uint.d.mts.map +1 -1
  148. package/dist/number/branded-types/uint.mjs +9 -10
  149. package/dist/number/branded-types/uint.mjs.map +1 -1
  150. package/dist/number/branded-types/uint16.d.mts +3 -18
  151. package/dist/number/branded-types/uint16.d.mts.map +1 -1
  152. package/dist/number/branded-types/uint16.mjs +9 -10
  153. package/dist/number/branded-types/uint16.mjs.map +1 -1
  154. package/dist/number/branded-types/uint32.d.mts +3 -16
  155. package/dist/number/branded-types/uint32.d.mts.map +1 -1
  156. package/dist/number/branded-types/uint32.mjs +9 -10
  157. package/dist/number/branded-types/uint32.mjs.map +1 -1
  158. package/dist/number/enum/int8.d.mts +13 -15
  159. package/dist/number/enum/int8.d.mts.map +1 -1
  160. package/dist/number/enum/int8.mjs +20 -25
  161. package/dist/number/enum/int8.mjs.map +1 -1
  162. package/dist/number/enum/uint8.d.mts +12 -14
  163. package/dist/number/enum/uint8.d.mts.map +1 -1
  164. package/dist/number/enum/uint8.mjs +18 -23
  165. package/dist/number/enum/uint8.mjs.map +1 -1
  166. package/dist/number/index.d.mts +1 -1
  167. package/dist/number/index.d.mts.map +1 -1
  168. package/dist/number/index.mjs +1 -1
  169. package/dist/number/index.mjs.map +1 -1
  170. package/dist/number/num/impl/index.d.mts +2 -0
  171. package/dist/number/num/impl/index.d.mts.map +1 -0
  172. package/dist/number/num/impl/index.mjs +2 -0
  173. package/dist/number/num/impl/index.mjs.map +1 -0
  174. package/dist/number/num/impl/num.d.mts +531 -0
  175. package/dist/number/num/impl/num.d.mts.map +1 -0
  176. package/dist/number/num/impl/num.mjs +542 -0
  177. package/dist/number/num/impl/num.mjs.map +1 -0
  178. package/dist/number/num/index.d.mts +17 -0
  179. package/dist/number/num/index.d.mts.map +1 -0
  180. package/dist/number/num/index.mjs +17 -0
  181. package/dist/number/num/index.mjs.map +1 -0
  182. package/dist/number/operators/finite-number.d.mts +16 -0
  183. package/dist/number/operators/finite-number.d.mts.map +1 -0
  184. package/dist/number/operators/finite-number.mjs +7 -0
  185. package/dist/number/operators/finite-number.mjs.map +1 -0
  186. package/dist/number/operators/int.d.mts +16 -0
  187. package/dist/number/operators/int.d.mts.map +1 -0
  188. package/dist/number/operators/int.mjs +8 -0
  189. package/dist/number/operators/int.mjs.map +1 -0
  190. package/dist/number/operators/int16.d.mts +25 -0
  191. package/dist/number/operators/int16.d.mts.map +1 -0
  192. package/dist/number/operators/int16.mjs +8 -0
  193. package/dist/number/operators/int16.mjs.map +1 -0
  194. package/dist/number/operators/int32.d.mts +21 -0
  195. package/dist/number/operators/int32.d.mts.map +1 -0
  196. package/dist/number/operators/int32.mjs +8 -0
  197. package/dist/number/operators/int32.mjs.map +1 -0
  198. package/dist/number/operators/int8.d.mts +24 -0
  199. package/dist/number/operators/int8.d.mts.map +1 -0
  200. package/dist/number/operators/int8.mjs +8 -0
  201. package/dist/number/operators/int8.mjs.map +1 -0
  202. package/dist/number/operators/negative-finite-number.d.mts +11 -0
  203. package/dist/number/operators/negative-finite-number.d.mts.map +1 -0
  204. package/dist/number/operators/negative-finite-number.mjs +8 -0
  205. package/dist/number/operators/negative-finite-number.mjs.map +1 -0
  206. package/dist/number/operators/negative-int.d.mts +10 -0
  207. package/dist/number/operators/negative-int.d.mts.map +1 -0
  208. package/dist/number/operators/negative-int.mjs +9 -0
  209. package/dist/number/operators/negative-int.mjs.map +1 -0
  210. package/dist/number/operators/negative-safe-int.d.mts +10 -0
  211. package/dist/number/operators/negative-safe-int.d.mts.map +1 -0
  212. package/dist/number/operators/negative-safe-int.mjs +9 -0
  213. package/dist/number/operators/negative-safe-int.mjs.map +1 -0
  214. package/dist/number/operators/non-negative-finite-number.d.mts +22 -0
  215. package/dist/number/operators/non-negative-finite-number.d.mts.map +1 -0
  216. package/dist/number/operators/non-negative-finite-number.mjs +7 -0
  217. package/dist/number/operators/non-negative-finite-number.mjs.map +1 -0
  218. package/dist/number/operators/non-negative-int16.d.mts +27 -0
  219. package/dist/number/operators/non-negative-int16.d.mts.map +1 -0
  220. package/dist/number/operators/non-negative-int16.mjs +8 -0
  221. package/dist/number/operators/non-negative-int16.mjs.map +1 -0
  222. package/dist/number/operators/non-negative-int32.d.mts +25 -0
  223. package/dist/number/operators/non-negative-int32.d.mts.map +1 -0
  224. package/dist/number/operators/non-negative-int32.mjs +8 -0
  225. package/dist/number/operators/non-negative-int32.mjs.map +1 -0
  226. package/dist/number/operators/non-positive-finite-number.d.mts +11 -0
  227. package/dist/number/operators/non-positive-finite-number.d.mts.map +1 -0
  228. package/dist/number/operators/non-positive-finite-number.mjs +7 -0
  229. package/dist/number/operators/non-positive-finite-number.mjs.map +1 -0
  230. package/dist/number/operators/non-positive-int.d.mts +10 -0
  231. package/dist/number/operators/non-positive-int.d.mts.map +1 -0
  232. package/dist/number/operators/non-positive-int.mjs +8 -0
  233. package/dist/number/operators/non-positive-int.mjs.map +1 -0
  234. package/dist/number/operators/non-positive-safe-int.d.mts +10 -0
  235. package/dist/number/operators/non-positive-safe-int.d.mts.map +1 -0
  236. package/dist/number/operators/non-positive-safe-int.mjs +8 -0
  237. package/dist/number/operators/non-positive-safe-int.mjs.map +1 -0
  238. package/dist/number/operators/non-zero-finite-number.d.mts +16 -0
  239. package/dist/number/operators/non-zero-finite-number.d.mts.map +1 -0
  240. package/dist/number/operators/non-zero-finite-number.mjs +8 -0
  241. package/dist/number/operators/non-zero-finite-number.mjs.map +1 -0
  242. package/dist/number/operators/non-zero-int.d.mts +10 -0
  243. package/dist/number/operators/non-zero-int.d.mts.map +1 -0
  244. package/dist/number/operators/non-zero-int.mjs +9 -0
  245. package/dist/number/operators/non-zero-int.mjs.map +1 -0
  246. package/dist/number/operators/non-zero-int16.d.mts +10 -0
  247. package/dist/number/operators/non-zero-int16.d.mts.map +1 -0
  248. package/dist/number/operators/non-zero-int16.mjs +9 -0
  249. package/dist/number/operators/non-zero-int16.mjs.map +1 -0
  250. package/dist/number/operators/non-zero-int32.d.mts +10 -0
  251. package/dist/number/operators/non-zero-int32.d.mts.map +1 -0
  252. package/dist/number/operators/non-zero-int32.mjs +9 -0
  253. package/dist/number/operators/non-zero-int32.mjs.map +1 -0
  254. package/dist/number/operators/non-zero-safe-int.d.mts +10 -0
  255. package/dist/number/operators/non-zero-safe-int.d.mts.map +1 -0
  256. package/dist/number/operators/non-zero-safe-int.mjs +11 -0
  257. package/dist/number/operators/non-zero-safe-int.mjs.map +1 -0
  258. package/dist/number/operators/non-zero-uint16.d.mts +2 -0
  259. package/dist/number/operators/non-zero-uint16.d.mts.map +1 -0
  260. package/dist/number/operators/non-zero-uint16.mjs +9 -0
  261. package/dist/number/operators/non-zero-uint16.mjs.map +1 -0
  262. package/dist/number/operators/non-zero-uint32.d.mts +2 -0
  263. package/dist/number/operators/non-zero-uint32.d.mts.map +1 -0
  264. package/dist/number/operators/non-zero-uint32.mjs +9 -0
  265. package/dist/number/operators/non-zero-uint32.mjs.map +1 -0
  266. package/dist/number/operators/positive-finite-number.d.mts +23 -0
  267. package/dist/number/operators/positive-finite-number.d.mts.map +1 -0
  268. package/dist/number/operators/positive-finite-number.mjs +7 -0
  269. package/dist/number/operators/positive-finite-number.mjs.map +1 -0
  270. package/dist/number/operators/positive-int.d.mts +23 -0
  271. package/dist/number/operators/positive-int.d.mts.map +1 -0
  272. package/dist/number/operators/positive-int.mjs +8 -0
  273. package/dist/number/operators/positive-int.mjs.map +1 -0
  274. package/dist/number/operators/positive-int16.d.mts +28 -0
  275. package/dist/number/operators/positive-int16.d.mts.map +1 -0
  276. package/dist/number/operators/positive-int16.mjs +8 -0
  277. package/dist/number/operators/positive-int16.mjs.map +1 -0
  278. package/dist/number/operators/positive-int32.d.mts +26 -0
  279. package/dist/number/operators/positive-int32.d.mts.map +1 -0
  280. package/dist/number/operators/positive-int32.mjs +8 -0
  281. package/dist/number/operators/positive-int32.mjs.map +1 -0
  282. package/dist/number/operators/positive-safe-int.d.mts +24 -0
  283. package/dist/number/operators/positive-safe-int.d.mts.map +1 -0
  284. package/dist/number/operators/positive-safe-int.mjs +9 -0
  285. package/dist/number/operators/positive-safe-int.mjs.map +1 -0
  286. package/dist/number/operators/positive-uint16.d.mts +27 -0
  287. package/dist/number/operators/positive-uint16.d.mts.map +1 -0
  288. package/dist/number/operators/positive-uint16.mjs +8 -0
  289. package/dist/number/operators/positive-uint16.mjs.map +1 -0
  290. package/dist/number/operators/positive-uint32.d.mts +25 -0
  291. package/dist/number/operators/positive-uint32.d.mts.map +1 -0
  292. package/dist/number/operators/positive-uint32.mjs +8 -0
  293. package/dist/number/operators/positive-uint32.mjs.map +1 -0
  294. package/dist/number/operators/safe-int.d.mts +17 -0
  295. package/dist/number/operators/safe-int.d.mts.map +1 -0
  296. package/dist/number/operators/safe-int.mjs +10 -0
  297. package/dist/number/operators/safe-int.mjs.map +1 -0
  298. package/dist/number/operators/safe-uint.d.mts +22 -0
  299. package/dist/number/operators/safe-uint.d.mts.map +1 -0
  300. package/dist/number/operators/safe-uint.mjs +9 -0
  301. package/dist/number/operators/safe-uint.mjs.map +1 -0
  302. package/dist/number/operators/uint.d.mts +14 -0
  303. package/dist/number/operators/uint.d.mts.map +1 -0
  304. package/dist/number/operators/uint.mjs +8 -0
  305. package/dist/number/operators/uint.mjs.map +1 -0
  306. package/dist/number/operators/uint16.d.mts +25 -0
  307. package/dist/number/operators/uint16.d.mts.map +1 -0
  308. package/dist/number/operators/uint16.mjs +8 -0
  309. package/dist/number/operators/uint16.mjs.map +1 -0
  310. package/dist/number/operators/uint32.d.mts +23 -0
  311. package/dist/number/operators/uint32.d.mts.map +1 -0
  312. package/dist/number/operators/uint32.mjs +8 -0
  313. package/dist/number/operators/uint32.mjs.map +1 -0
  314. package/dist/number/operators/uint8.d.mts +24 -0
  315. package/dist/number/operators/uint8.d.mts.map +1 -0
  316. package/dist/number/operators/uint8.mjs +8 -0
  317. package/dist/number/operators/uint8.mjs.map +1 -0
  318. package/dist/number/refined-number-utils.d.mts +2 -2
  319. package/dist/number/refined-number-utils.d.mts.map +1 -1
  320. package/dist/number/refined-number-utils.mjs +1 -1
  321. package/dist/number/refined-number-utils.mjs.map +1 -1
  322. package/dist/object/object.mjs +1 -1
  323. package/dist/object/object.mjs.map +1 -1
  324. package/dist/others/fast-deep-equal.mjs +1 -1
  325. package/dist/others/fast-deep-equal.mjs.map +1 -1
  326. package/package.json +23 -10
  327. package/src/array/impl/array-utils-reducing-value.mts +4 -3
  328. package/src/array/impl/array-utils-shape-invariants.test.mts +1 -1
  329. package/src/array/impl/array-utils-slice-clamped.mts +1 -1
  330. package/src/array/impl/array-utils-slicing.mts +12 -3
  331. package/src/array/impl/array-utils-transformation.mts +6 -2
  332. package/src/array/impl/array-utils-transformation.test.mts +44 -1
  333. package/src/array/impl/array-utils-validation.mts +2 -1
  334. package/src/built-in-tag.mts +59 -0
  335. package/src/built-in-tag.test.mts +215 -0
  336. package/src/collections/stack.mts +3 -3
  337. package/src/iterator/range.mts +10 -2
  338. package/src/iterator/range.test.mts +7 -0
  339. package/src/json/json.mts +20 -2
  340. package/src/json/json.test.mts +63 -0
  341. package/src/number/branded-types/finite-number.mts +23 -25
  342. package/src/number/branded-types/int.mts +20 -26
  343. package/src/number/branded-types/int16.mts +21 -26
  344. package/src/number/branded-types/int32.mts +21 -26
  345. package/src/number/branded-types/negative-finite-number.mts +25 -26
  346. package/src/number/branded-types/negative-int.mts +20 -27
  347. package/src/number/branded-types/negative-safe-int.mts +23 -28
  348. package/src/number/branded-types/non-negative-finite-number.mts +24 -25
  349. package/src/number/branded-types/non-negative-int16.mts +23 -26
  350. package/src/number/branded-types/non-negative-int32.mts +23 -26
  351. package/src/number/branded-types/non-positive-finite-number.mts +24 -25
  352. package/src/number/branded-types/non-positive-int.mts +20 -26
  353. package/src/number/branded-types/non-positive-safe-int.mts +21 -26
  354. package/src/number/branded-types/non-zero-finite-number.mts +23 -25
  355. package/src/number/branded-types/non-zero-int.mts +19 -25
  356. package/src/number/branded-types/non-zero-int16.mts +27 -28
  357. package/src/number/branded-types/non-zero-int32.mts +27 -28
  358. package/src/number/branded-types/non-zero-safe-int.mts +25 -35
  359. package/src/number/branded-types/non-zero-uint16.mts +24 -28
  360. package/src/number/branded-types/non-zero-uint32.mts +24 -28
  361. package/src/number/branded-types/positive-finite-number.mts +25 -25
  362. package/src/number/branded-types/positive-int.mts +21 -26
  363. package/src/number/branded-types/positive-int16.mts +23 -26
  364. package/src/number/branded-types/positive-int32.mts +23 -26
  365. package/src/number/branded-types/positive-safe-int.mts +24 -31
  366. package/src/number/branded-types/positive-uint16.mts +23 -26
  367. package/src/number/branded-types/positive-uint32.mts +23 -26
  368. package/src/number/branded-types/safe-int.mts +22 -29
  369. package/src/number/branded-types/safe-uint.mts +21 -27
  370. package/src/number/branded-types/uint.mts +21 -26
  371. package/src/number/branded-types/uint16.mts +21 -26
  372. package/src/number/branded-types/uint32.mts +21 -26
  373. package/src/number/enum/int8.mts +40 -52
  374. package/src/number/enum/uint8.mts +40 -48
  375. package/src/number/index.mts +1 -1
  376. package/src/number/num/impl/index.mts +1 -0
  377. package/src/number/num/impl/num.mts +715 -0
  378. package/src/number/{num.test.mts → num/impl/num.test.mts} +4 -4
  379. package/src/number/num/index.mts +16 -0
  380. package/src/number/num-arithmetic.test.mts +1 -1
  381. package/src/number/operators/finite-number.mts +20 -0
  382. package/src/number/operators/int.mts +20 -0
  383. package/src/number/operators/int16.mts +33 -0
  384. package/src/number/operators/int32.mts +33 -0
  385. package/src/number/operators/int8.mts +18 -0
  386. package/src/number/operators/negative-finite-number.mts +22 -0
  387. package/src/number/operators/negative-int.mts +22 -0
  388. package/src/number/operators/negative-safe-int.mts +32 -0
  389. package/src/number/operators/non-negative-finite-number.mts +32 -0
  390. package/src/number/operators/non-negative-int16.mts +33 -0
  391. package/src/number/operators/non-negative-int32.mts +33 -0
  392. package/src/number/operators/non-positive-finite-number.mts +21 -0
  393. package/src/number/operators/non-positive-int.mts +21 -0
  394. package/src/number/operators/non-positive-safe-int.mts +31 -0
  395. package/src/number/operators/non-zero-finite-number.mts +21 -0
  396. package/src/number/operators/non-zero-int.mts +22 -0
  397. package/src/number/operators/non-zero-int16.mts +32 -0
  398. package/src/number/operators/non-zero-int32.mts +32 -0
  399. package/src/number/operators/non-zero-safe-int.mts +34 -0
  400. package/src/number/operators/non-zero-uint16.mts +32 -0
  401. package/src/number/operators/non-zero-uint32.mts +32 -0
  402. package/src/number/operators/positive-finite-number.mts +32 -0
  403. package/src/number/operators/positive-int.mts +32 -0
  404. package/src/number/operators/positive-int16.mts +33 -0
  405. package/src/number/operators/positive-int32.mts +33 -0
  406. package/src/number/operators/positive-safe-int.mts +34 -0
  407. package/src/number/operators/positive-uint16.mts +33 -0
  408. package/src/number/operators/positive-uint32.mts +33 -0
  409. package/src/number/operators/safe-int.mts +35 -0
  410. package/src/number/operators/safe-uint.mts +33 -0
  411. package/src/number/operators/uint.mts +31 -0
  412. package/src/number/operators/uint16.mts +32 -0
  413. package/src/number/operators/uint32.mts +32 -0
  414. package/src/number/operators/uint8.mts +16 -0
  415. package/src/number/refined-number-utils.mts +4 -4
  416. package/src/object/object.mts +1 -1
  417. package/src/others/fast-deep-equal.mts +1 -1
  418. package/src/others/replace-equal-deep.test.mts +0 -2
  419. package/dist/number/num.d.mts +0 -550
  420. package/dist/number/num.d.mts.map +0 -1
  421. package/dist/number/num.mjs +0 -563
  422. package/dist/number/num.mjs.map +0 -1
  423. package/src/guard/is-error.test.mts +0 -145
  424. package/src/number/num.mts +0 -735
@@ -1,550 +0,0 @@
1
- import type { Decrement, FiniteNumber, Increment, Index, Int, Min, NaNType, NegativeIndex, NonNegativeNumber, NonZeroNumber, PositiveNumber, PositiveSafeIntWithSmallInt, RelaxedExclude, SmallInt, SmallUint } from 'ts-type-forge';
2
- import { Result } from '../functional/index.mjs';
3
- import type { SmallPositiveInt } from '../types.mjs';
4
- import type { AddResult, DivIntResult, DivResult, MulResult, SubResult } from './num-arithmetic-types.mjs';
5
- /**
6
- * Namespace providing utility functions for number manipulation and validation.
7
- *
8
- * This namespace offers a comprehensive set of type-safe number utilities
9
- * including:
10
- *
11
- * - Type conversion and validation
12
- * - Type guards for numeric constraints (non-zero, non-negative, positive)
13
- * - Range checking and clamping operations
14
- * - Mathematical operations with type safety
15
- * - Rounding utilities
16
- *
17
- * Many functions in this namespace leverage TypeScript's type system to provide
18
- * compile-time guarantees about numeric constraints.
19
- */
20
- export declare namespace Num {
21
- /**
22
- * Converts an unknown value to a number. Alias for the `Number` constructor.
23
- *
24
- * @example
25
- *
26
- * ```ts
27
- * const input = '123.45';
28
- *
29
- * const result = Num.from(input);
30
- *
31
- * assert.isTrue(result === 123.45);
32
- * ```
33
- *
34
- * @param n The value to convert.
35
- * @returns The numeric representation of `n`.
36
- */
37
- export const from: (n: unknown) => number;
38
- /**
39
- * Safely parses a base-10 integer from a string, returning a {@link Result}
40
- * that is `Ok<Int>` for valid input and `Err<Error>` otherwise.
41
- *
42
- * This is a stricter alternative to both `parseInt` and `Number`:
43
- *
44
- * - Unlike `parseInt('12abc', 10)` (which returns `12`), trailing
45
- * non-numeric characters make the whole input invalid and yield `Err`.
46
- * - Unlike `Number('')` / `Number(' ')` (which return `0`), empty or
47
- * whitespace-only input yields `Err`.
48
- *
49
- * The empty-string case is rejected by delegating to `parseInt` (which
50
- * returns `NaN` there) rather than hard-coding a check, while the trailing-
51
- * garbage case is rejected via `Number`. Valid input is truncated toward
52
- * zero, so `'12.9'` becomes `12` and `'-3.5'` becomes `-3`.
53
- *
54
- * Only base 10 is supported. Use `Result.unwrapOk` (optionally with a
55
- * `?? Number.NaN` fallback) or `Result.unwrapOkOr` to get a plain number
56
- * back.
57
- *
58
- * @example
59
- *
60
- * ```ts
61
- * assert.strictEqual(
62
- * Result.unwrapOkOr(Num.safeParseInt('123'), Number.NaN),
63
- * 123,
64
- * );
65
- *
66
- * assert.strictEqual(
67
- * Result.unwrapOkOr(Num.safeParseInt('12.9'), Number.NaN),
68
- * 12,
69
- * );
70
- *
71
- * assert.strictEqual(
72
- * Result.unwrapOkOr(Num.safeParseInt('-12.9'), Number.NaN),
73
- * -12,
74
- * );
75
- *
76
- * assert.strictEqual(Number.parseInt('-12.9', 10), -12);
77
- *
78
- * // Native `parseInt` ignores trailing non-numeric characters
79
- *
80
- * assert.strictEqual(Number.parseInt('123abc', 10), 123);
81
- *
82
- * assert.isTrue(Number.isNaN(Number('123abc')));
83
- *
84
- * assert.isTrue(Result.isErr(Num.safeParseInt('123abc')));
85
- *
86
- * // Whitespace is not a valid integer, so we return an error instead of coercing to 0.
87
- *
88
- * assert.isTrue(Number.isNaN(Number.parseInt(' ', 10)));
89
- *
90
- * assert.strictEqual(Number(' '), 0); // Native `Number` coerces whitespace to 0
91
- *
92
- * assert.isTrue(Result.isErr(Num.safeParseInt('')));
93
- *
94
- * assert.strictEqual(Result.unwrapOk(Num.safeParseInt(' ')), undefined);
95
- *
96
- * // A value that overflows to Infinity is not an integer either, even though
97
- * // native `parseInt` reads a 1 out of it.
98
- *
99
- * assert.strictEqual(Number.parseInt('1e400', 10), 1);
100
- *
101
- * assert.isTrue(Result.isErr(Num.safeParseInt('1e400')));
102
- * ```
103
- *
104
- * @param s The string to parse.
105
- * @returns `Result.ok(parsedInt)` for valid input, otherwise `Result.err`
106
- * wrapping an `Error` describing the invalid input. A value that
107
- * overflows to `Infinity` is rejected, so the `Int` brand never lies.
108
- */
109
- export const safeParseInt: (s: string) => Result<Int, Error>;
110
- /**
111
- * Safely parses a finite floating-point number from a string, returning a
112
- * {@link Result} that is `Ok<FiniteNumber>` for valid input and `Err<Error>`
113
- * otherwise.
114
- *
115
- * This is a stricter alternative to both `parseFloat` and `Number`:
116
- *
117
- * - Unlike `parseFloat('12abc')` (which returns `12`), trailing non-numeric
118
- * characters make the whole input invalid and yield `Err`.
119
- * - Unlike `Number('')` / `Number(' ')` (which return `0`), empty or
120
- * whitespace-only input yields `Err`.
121
- * - Unlike `Number('Infinity')` (which returns `Infinity`), non-finite values
122
- * yield `Err`.
123
- *
124
- * The empty-string case is rejected by delegating to `parseFloat` (which
125
- * returns `NaN` there) rather than hard-coding a check, while the trailing-
126
- * garbage case is rejected via `Number`. Decimal values are preserved as-is,
127
- * so `'12.9'` stays `12.9`.
128
- *
129
- * Use `Result.unwrapOk` (optionally with a `?? Number.NaN` fallback) or
130
- * `Result.unwrapOkOr` to get a plain number back.
131
- *
132
- * @example
133
- *
134
- * ```ts
135
- * assert.strictEqual(
136
- * Result.unwrapOkOr(Num.safeParseFloat('12.9'), Number.NaN),
137
- * 12.9,
138
- * );
139
- *
140
- * assert.strictEqual(
141
- * Result.unwrapOkOr(Num.safeParseFloat('-3.5'), Number.NaN),
142
- * -3.5,
143
- * );
144
- *
145
- * assert.strictEqual(
146
- * Result.unwrapOkOr(Num.safeParseFloat('1e3'), Number.NaN),
147
- * 1000,
148
- * );
149
- *
150
- * // Native `parseFloat` ignores trailing non-numeric characters
151
- *
152
- * assert.strictEqual(Number.parseFloat('12px'), 12);
153
- *
154
- * assert.isTrue(Result.isErr(Num.safeParseFloat('12px')));
155
- *
156
- * // Whitespace is not a valid number, so we return an error instead of coercing to 0.
157
- *
158
- * assert.isTrue(Result.isErr(Num.safeParseFloat('')));
159
- *
160
- * assert.isTrue(Result.isErr(Num.safeParseFloat(' ')));
161
- *
162
- * // Infinity and NaN are not finite, so they are rejected.
163
- *
164
- * assert.isTrue(Result.isErr(Num.safeParseFloat('Infinity')));
165
- *
166
- * assert.isTrue(Result.isErr(Num.safeParseFloat('NaN')));
167
- * ```
168
- *
169
- * @param s The string to parse.
170
- * @returns `Result.ok(parsedFloat)` for valid finite input, otherwise
171
- * `Result.err` wrapping an `Error` describing the invalid input.
172
- */
173
- export const safeParseFloat: (s: string) => Result<FiniteNumber, Error>;
174
- /**
175
- * Type guard that checks if a number is non-zero.
176
- *
177
- * When this function returns `true`, TypeScript narrows the type to exclude
178
- * zero, providing compile-time safety for division operations and other
179
- * calculations that require non-zero values.
180
- *
181
- * @example
182
- *
183
- * ```ts
184
- * const value: number = 5;
185
- *
186
- * if (Num.isNonZero(value)) {
187
- * // Safe to divide now that we know value is non-zero
188
- * // eslint-disable-next-line total-functions/no-partial-division
189
- * const inverted = 1 / value;
190
- *
191
- * assert.isTrue(inverted === 0.2);
192
- * }
193
- *
194
- * assert.isFalse(Num.isNonZero(0));
195
- * ```
196
- *
197
- * @template N - The numeric literal type or number type to check
198
- * @param num - The number to check
199
- * @returns `true` if the number is not zero, `false` otherwise
200
- */
201
- export const isNonZero: <N extends number>(num: N) => num is NonZeroNumber & RelaxedExclude<N, 0>;
202
- /**
203
- * Type guard that checks if a number is non-negative (greater than or equal
204
- * to zero).
205
- *
206
- * When this function returns `true`, TypeScript narrows the type to exclude
207
- * negative values, which is useful for operations that require non-negative
208
- * inputs like array indices or measurements.
209
- *
210
- * @example
211
- *
212
- * ```ts
213
- * const candidate = 10;
214
- *
215
- * if (Num.isNonNegative(candidate)) {
216
- * const index: number = candidate;
217
- *
218
- * assert.isTrue(index === 10);
219
- * }
220
- *
221
- * assert.isFalse(Num.isNonNegative(-1));
222
- * ```
223
- *
224
- * @template N - The numeric literal type or number type to check
225
- * @param num - The number to check
226
- * @returns `true` if the number is >= 0, `false` otherwise
227
- */
228
- export const isNonNegative: <N extends number>(num: N) => num is NonNegativeNumber & RelaxedExclude<N, NegativeIndex<1024>>;
229
- /**
230
- * Type guard that checks if a number is positive (greater than zero).
231
- *
232
- * When this function returns `true`, TypeScript narrows the type to exclude
233
- * zero and negative values. This is particularly useful for validating inputs
234
- * that must be strictly positive, such as dimensions, counts, or rates.
235
- *
236
- * @example
237
- *
238
- * ```ts
239
- * const amount = 42;
240
- *
241
- * if (Num.isPositive(amount)) {
242
- * assert.isTrue(amount > 0);
243
- * }
244
- *
245
- * assert.isFalse(Num.isPositive(0));
246
- * ```
247
- *
248
- * @template N - The numeric literal type or number type to check
249
- * @param num - The number to check
250
- * @returns `true` if the number is > 0, `false` otherwise
251
- */
252
- export const isPositive: <N extends number>(num: N) => num is PositiveNumber & RelaxedExclude<N, NegativeIndex<1024> | 0>;
253
- /**
254
- * Creates a function that checks if a number `x` is within the range
255
- * `lowerBound <= x < upperBound`.
256
- *
257
- * @example
258
- *
259
- * ```ts
260
- * const isGrade = Num.isInRange(0, 100);
261
- *
262
- * assert.isTrue(isGrade(50));
263
- *
264
- * assert.isFalse(isGrade(100));
265
- * ```
266
- *
267
- * @param lowerBound The lower bound (inclusive).
268
- * @param upperBound The upper bound (exclusive).
269
- * @returns A function that takes a number `x` and returns `true` if `x` is in
270
- * the range, `false` otherwise.
271
- */
272
- export const isInRange: (lowerBound: number, upperBound: number) => (x: number) => boolean;
273
- /**
274
- * Creates a function that checks if a number `x` is within the range
275
- * `lowerBound <= x <= upperBound`.
276
- *
277
- * @example
278
- *
279
- * ```ts
280
- * const isPercentage = Num.isInRangeInclusive(0, 100);
281
- *
282
- * assert.isTrue(isPercentage(100));
283
- *
284
- * assert.isFalse(isPercentage(-1));
285
- * ```
286
- *
287
- * @param lowerBound The lower bound (inclusive).
288
- * @param upperBound The upper bound (inclusive).
289
- * @returns A function that takes a number `x` and returns `true` if `x` is in
290
- * the range, `false` otherwise.
291
- */
292
- export const isInRangeInclusive: (lowerBound: number, upperBound: number) => (x: number) => boolean;
293
- /**
294
- * @template N - A SmallUint representing the exclusive upper bound
295
- * @internal
296
- * Helper type mapping each SmallUint N to the union of integers from 0 to N-1.
297
- * Used internally for type-safe range operations.
298
- *
299
- * For example:
300
- * - LT[3] = 0 | 1 | 2
301
- * - LT[5] = 0 | 1 | 2 | 3 | 4
302
- */
303
- type LT = Readonly<{
304
- [N in SmallUint]: Index<N>;
305
- }>;
306
- /**
307
- * @template N - A SmallUint representing the inclusive upper bound
308
- * @internal
309
- * Helper type mapping each SmallUint N to the union of integers from 0 to N (inclusive).
310
- * Used internally for type-safe range operations with inclusive upper bounds.
311
- *
312
- * For example:
313
- * - LEQ[3] = 0 | 1 | 2 | 3
314
- * - LEQ[5] = 0 | 1 | 2 | 3 | 4 | 5
315
- */
316
- type LEQ = Readonly<{
317
- [N in SmallUint]: Index<N> | N;
318
- }>;
319
- /**
320
- * Creates a type guard that checks if a number is an unsigned integer within
321
- * a specified range.
322
- *
323
- * This function returns a predicate that validates whether a number is:
324
- *
325
- * - A safe integer (no floating point)
326
- * - Within the range [lowerBound, upperBound)
327
- *
328
- * The returned type guard provides precise type narrowing when the bounds are
329
- * SmallUint literals, making it ideal for array index validation.
330
- *
331
- * @example
332
- *
333
- * ```ts
334
- * const indexGuard = Num.isUintInRange(0, 5);
335
- *
336
- * assert.isTrue(indexGuard(3));
337
- *
338
- * assert.isFalse(indexGuard(5));
339
- *
340
- * assert.isFalse(indexGuard(-1));
341
- * ```
342
- *
343
- * @template L - The lower bound as a SmallUint literal type
344
- * @template U - The upper bound as a SmallUint literal type
345
- * @param lowerBound - The minimum value (inclusive)
346
- * @param upperBound - The maximum value (exclusive)
347
- * @returns A type guard function that validates and narrows number types
348
- */
349
- export const isUintInRange: <L extends SmallUint, U extends SmallUint>(lowerBound: L, upperBound: U) => (x: number) => x is RelaxedExclude<LT[U], LT[Min<L>]>;
350
- /**
351
- * Creates a type guard that checks if a number is an unsigned integer within
352
- * a specified inclusive range.
353
- *
354
- * This function returns a predicate that validates whether a number is:
355
- *
356
- * - A safe integer (no floating point)
357
- * - Within the range [lowerBound, upperBound] (both bounds inclusive)
358
- *
359
- * The returned type guard provides precise type narrowing when the bounds are
360
- * SmallUint literals, useful for validating scores, percentages, or other
361
- * bounded values.
362
- *
363
- * @example
364
- *
365
- * ```ts
366
- * const inclusiveGuard = Num.isUintInRangeInclusive(0, 5);
367
- *
368
- * assert.isTrue(inclusiveGuard(5));
369
- *
370
- * assert.isFalse(inclusiveGuard(6));
371
- * ```
372
- *
373
- * @template L - The lower bound as a SmallUint literal type
374
- * @template U - The upper bound as a SmallUint literal type
375
- * @param lowerBound - The minimum value (inclusive)
376
- * @param upperBound - The maximum value (inclusive)
377
- * @returns A type guard function that validates and narrows number types
378
- */
379
- export const isUintInRangeInclusive: <L extends SmallUint, U extends SmallUint>(lowerBound: L, upperBound: U) => (x: number) => x is RelaxedExclude<LEQ[U], LT[Min<L>]>;
380
- /**
381
- * Clamps a value within the given range. If the target value is invalid (not
382
- * finite), returns the lower bound.
383
- *
384
- * Provides two usage patterns for maximum flexibility:
385
- *
386
- * - **Direct usage**: Pass all three arguments to get the clamped value
387
- * immediately
388
- * - **Curried usage**: Pass bounds to get a reusable clamping function
389
- *
390
- * @example
391
- *
392
- * ```ts
393
- * assert.isTrue(Num.clamp(150, 0, 100) === 100);
394
- *
395
- * assert.isTrue(Num.clamp(-50, 0, 100) === 0);
396
- *
397
- * const clampToPercentage = Num.clamp(0, 100);
398
- *
399
- * assert.isTrue(clampToPercentage(75) === 75);
400
- *
401
- * assert.isTrue(clampToPercentage(150) === 100);
402
- * ```
403
- */
404
- export function clamp(target: number, lowerBound: number, upperBound: number): number;
405
- export function clamp(lowerBound: number, upperBound: number): (target: number) => number;
406
- /**
407
- * Adds two numbers, returning the tightest sound branded result type.
408
- *
409
- * The sign of the result is computed exactly (e.g. a non-negative plus a
410
- * non-negative is non-negative); the integer/finite level is preserved, with
411
- * `SafeInt` operands widening to `Int` because the sum may exceed the safe
412
- * range. No clamping is performed — for a result that stays inside a bounded
413
- * type, use that type's branded `add` instead.
414
- *
415
- * @param a - The first addend.
416
- * @param b - The second addend.
417
- * @returns `a + b`, typed as the tightest branded type guaranteed to contain
418
- * it.
419
- */
420
- export const add: <A extends number, B extends number>(a: A, b: B) => AddResult<A, B>;
421
- /**
422
- * Subtracts `b` from `a`, returning the tightest sound branded result type.
423
- *
424
- * The sign is computed exactly; the level is preserved (with `SafeInt`
425
- * widening to `Int`). No clamping — for saturating subtraction that stays in a
426
- * bounded type (e.g. `Uint.sub` clamping at `0`), use that type's branded
427
- * `sub`.
428
- *
429
- * @param a - The minuend.
430
- * @param b - The subtrahend.
431
- * @returns `a - b`, typed as the tightest branded type guaranteed to contain
432
- * it.
433
- */
434
- export const sub: <A extends number, B extends number>(a: A, b: B) => SubResult<A, B>;
435
- /**
436
- * Multiplies two numbers, returning the tightest sound branded result type.
437
- *
438
- * The sign follows the usual product rule (e.g. negative times negative is
439
- * positive); the level is preserved (with `SafeInt` widening to `Int`). No
440
- * clamping.
441
- *
442
- * @param a - The first factor.
443
- * @param b - The second factor.
444
- * @returns `a * b`, typed as the tightest branded type guaranteed to contain
445
- * it.
446
- */
447
- export const mul: <A extends number, B extends number>(a: A, b: B) => MulResult<A, B>;
448
- /**
449
- * Performs type-safe exact division with a compile-time zero-check.
450
- *
451
- * The divisor must be typed as `NonZeroNumber` or a non-zero numeric literal.
452
- * The result sign follows the quotient rule; because exact division can be
453
- * fractional, the level is `finite` (or `number`).
454
- *
455
- * @param a - The dividend.
456
- * @param b - The divisor (must be non-zero, enforced by types).
457
- * @returns `a / b`, typed as the tightest branded type guaranteed to contain
458
- * it.
459
- */
460
- export const div: <A extends number, B extends NonZeroNumber | SmallInt<'!=0'>>(a: A, b: B) => DivResult<A, B>;
461
- /**
462
- * Performs integer division using floor division.
463
- *
464
- * Computes `⌊⌊a⌋ / b⌋`: the dividend is floored, the divisor is used as is,
465
- * and the quotient is floored. For a positive integer divisor this is
466
- * `⌊a / b⌋`. The divisor is not floored, since a divisor in `(-1, 1)` would
467
- * floor to `0` or `-1`.
468
- *
469
- * Like `div`, the divisor must be typed as `NonZeroNumber` or a non-zero
470
- * numeric literal. A divisor of magnitude below `1` makes the quotient larger
471
- * than the dividend, so it overflows to `±Infinity` once `|a / b|` exceeds
472
- * `Number.MAX_VALUE` (e.g. `1e300 / 1e-10`), as `mul` can.
473
- *
474
- * @param a - The dividend
475
- * @param b - The divisor (must be non-zero, enforced by types)
476
- * @returns The integer quotient `⌊⌊a⌋ / b⌋`
477
- */
478
- export const divInt: <A extends number, B extends NonZeroNumber | SmallInt<'!=0'>>(a: A, b: B) => DivIntResult<A, B>;
479
- /**
480
- * Rounds a number to a specified number of decimal places.
481
- *
482
- * Uses the standard rounding algorithm (round half up) to round the number to
483
- * the given precision. The precision must be a positive safe integer.
484
- *
485
- * @param num - The number to round
486
- * @param precision - The number of decimal places (must be positive)
487
- * @returns The rounded number
488
- */
489
- export const roundAt: (num: number, precision: PositiveSafeIntWithSmallInt) => number;
490
- /**
491
- * Rounds a number to the nearest integer using bitwise operations.
492
- *
493
- * This function uses a bitwise OR trick for potentially faster rounding.
494
- * Note: This implementation rounds half up for positive numbers but may
495
- * behave differently for negative numbers compared to Math.round.
496
- *
497
- * @param num - The number to round
498
- * @returns The rounded integer as an Int branded type
499
- */
500
- export const roundToInt: (num: number) => Int;
501
- /**
502
- * Creates a reusable rounding function with a fixed precision.
503
- *
504
- * This is a curried version of roundAt that returns a function configured to
505
- * always round to the specified number of decimal places. Useful for creating
506
- * consistent rounding behavior across multiple values.
507
- *
508
- * @param digit - The number of decimal places for rounding
509
- * @returns A function that rounds numbers to the specified precision
510
- */
511
- export const round: (digit: PositiveSafeIntWithSmallInt) => ((num: number) => number);
512
- /**
513
- * Converts NaN values to undefined while preserving all other numbers.
514
- *
515
- * This function is useful for handling potentially invalid numeric operations
516
- * in a type-safe way, converting NaN results to undefined for easier handling
517
- * with optional chaining or nullish coalescing.
518
- *
519
- * @template N - The numeric type (literal or number)
520
- * @param num - The number to check
521
- * @returns The original number if not NaN, otherwise undefined
522
- */
523
- export const mapNaN2Undefined: <N extends number>(num: N) => RelaxedExclude<N, NaNType> | undefined;
524
- /**
525
- * Type-safe increment operation for SmallUint values.
526
- *
527
- * Increments a SmallUint (0-40) by 1 with the result type computed at compile
528
- * time. This provides type-level arithmetic for small unsigned integers,
529
- * useful for type-safe counter operations.
530
- *
531
- * @template N - A SmallUint literal type (0-40)
532
- * @param n - The SmallUint value to increment
533
- * @returns The incremented value with type Increment<N>
534
- */
535
- export const increment: <N extends SmallUint>(n: N) => Increment<N>;
536
- /**
537
- * Type-safe decrement operation for positive SmallInt values.
538
- *
539
- * Decrements a positive SmallInt (1-40) by 1 with the result type computed at
540
- * compile time. This provides type-level arithmetic for small positive
541
- * integers, useful for type-safe countdown operations.
542
- *
543
- * @template N - A positive SmallInt literal type (1-40)
544
- * @param n - The positive SmallInt value to decrement
545
- * @returns The decremented value with type Decrement<N>
546
- */
547
- export const decrement: <N extends SmallPositiveInt>(n: N) => Decrement<N>;
548
- export {};
549
- }
550
- //# sourceMappingURL=num.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"num.d.mts","sourceRoot":"","sources":["../../src/number/num.mts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,SAAS,EACT,YAAY,EACZ,SAAS,EACT,KAAK,EACL,GAAG,EACH,GAAG,EACH,OAAO,EACP,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,cAAc,EACd,2BAA2B,EAC3B,cAAc,EACd,QAAQ,EACR,SAAS,EAEV,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,KAAK,EACV,SAAS,EACT,YAAY,EACZ,SAAS,EACT,SAAS,EACT,SAAS,EACV,MAAM,4BAA4B,CAAC;AAEpC;;;;;;;;;;;;;;GAcG;AACH,yBAAiB,GAAG,CAAC;IACnB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,MAAe,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,MAAM,CAAC,MAAM,YAAY,MAAO,MAAM,KAAG,MAAM,CAAC,GAAG,EAAE,KAAK,CAatD,CAAC;IAEL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CAAC,MAAM,cAAc,MAAO,MAAM,KAAG,MAAM,CAAC,YAAY,EAAE,KAAK,CAajE,CAAC;IAEL;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,OACnC,CAAC,KACL,GAAG,IAAI,aAAa,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,CAAc,CAAC;IAI5D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,OACvC,CAAC,KACL,GAAG,IAAI,iBAAiB,GAAG,cAAc,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CACzD,CAAC;IAEX;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,OACpC,CAAC,KACL,GAAG,IAAI,cAAc,GAAG,cAAc,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,CAAC;IAEV;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAAM,SAAS,eACP,MAAM,cAAc,MAAM,SACnC,MAAM,KAAG,OACsB,CAAC;IAEtC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAAM,kBAAkB,eAChB,MAAM,cAAc,MAAM,SACnC,MAAM,KAAG,OACuB,CAAC;IAEvC;;;;;;;;;OASG;IACH,KAAK,EAAE,GAAG,QAAQ,CAAC;SAAG,CAAC,IAAI,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC;KAAE,CAAC,CAAC;IAEnD;;;;;;;;;OASG;IACH,KAAK,GAAG,GAAG,QAAQ,CAAC;SAAG,CAAC,IAAI,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;KAAE,CAAC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,CAAC,MAAM,aAAa,GACvB,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,cAAc,CAAC,cAAc,CAAC,SACnE,MAAM,KAAG,CAAC,IAAI,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CACY,CAAC;IAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,MAAM,sBAAsB,GAChC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,cAAc,CAAC,cAAc,CAAC,SACnE,MAAM,KAAG,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CACY,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,UAAU,KAAK,CACnB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,MAAM,CAAC;IAGV,MAAM,UAAU,KAAK,CACnB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;IAyB9B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,GAAG,GAAI,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,KACjD,CAAC,KACD,CAAC,KACH,SAAS,CAAC,CAAC,EAAE,CAAC,CAEW,CAAC;IAE7B;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,GAAG,GAAI,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,KACjD,CAAC,KACD,CAAC,KACH,SAAS,CAAC,CAAC,EAAE,CAAC,CAEW,CAAC;IAE7B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,GAAG,GAAI,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,KACjD,CAAC,KACD,CAAC,KACH,SAAS,CAAC,CAAC,EAAE,CAAC,CAEW,CAAC;IAE7B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,GAAG,GACd,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,KAEtC,CAAC,KACD,CAAC,KACH,SAAS,CAAC,CAAC,EAAE,CAAC,CAEW,CAAC;IAE7B;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,MAAM,MAAM,GACjB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,KAEtC,CAAC,KACD,CAAC,KACH,YAAY,CAAC,CAAC,EAAE,CAAC,CAMnB,CAAC;IAEF;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,OAAO,QACb,MAAM,aACA,2BAA2B,KACrC,MAKF,CAAC;IAEF;;;;;;;;;OASG;IAEH,MAAM,CAAC,MAAM,UAAU,QAAS,MAAM,KAAG,GAAmC,CAAC;IAE7E;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,KAAK,UACT,2BAA2B,KACjC,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAM1B,CAAC;IAEF;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,gBAAgB,GAAI,CAAC,SAAS,MAAM,OAC1C,CAAC,KACL,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,SAIS,CAAC;IAE1C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,SAAS,GAAI,CAAC,SAAS,SAAS,KAAK,CAAC,KAAG,SAAS,CAAC,CAAC,CAExC,CAAC;IAE1B;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,SAAS,GAAI,CAAC,SAAS,gBAAgB,KAAK,CAAC,KAAG,SAAS,CAAC,CAAC,CAE/C,CAAC;;CAC3B"}