effect 4.0.0-beta.66 → 4.0.0-beta.68

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 (1767) hide show
  1. package/dist/Array.d.ts +151 -106
  2. package/dist/Array.d.ts.map +1 -1
  3. package/dist/Array.js +50 -40
  4. package/dist/Array.js.map +1 -1
  5. package/dist/BigDecimal.d.ts +620 -553
  6. package/dist/BigDecimal.d.ts.map +1 -1
  7. package/dist/BigDecimal.js +298 -254
  8. package/dist/BigDecimal.js.map +1 -1
  9. package/dist/BigInt.d.ts +342 -274
  10. package/dist/BigInt.d.ts.map +1 -1
  11. package/dist/BigInt.js +168 -126
  12. package/dist/BigInt.js.map +1 -1
  13. package/dist/Boolean.d.ts +189 -156
  14. package/dist/Boolean.d.ts.map +1 -1
  15. package/dist/Boolean.js +85 -68
  16. package/dist/Boolean.js.map +1 -1
  17. package/dist/Brand.d.ts +30 -5
  18. package/dist/Brand.d.ts.map +1 -1
  19. package/dist/Brand.js +19 -2
  20. package/dist/Brand.js.map +1 -1
  21. package/dist/Cache.d.ts +239 -135
  22. package/dist/Cache.d.ts.map +1 -1
  23. package/dist/Cache.js +135 -59
  24. package/dist/Cache.js.map +1 -1
  25. package/dist/Cause.d.ts +84 -73
  26. package/dist/Cause.d.ts.map +1 -1
  27. package/dist/Cause.js +51 -44
  28. package/dist/Cause.js.map +1 -1
  29. package/dist/Channel.d.ts +1568 -632
  30. package/dist/Channel.d.ts.map +1 -1
  31. package/dist/Channel.js +685 -315
  32. package/dist/Channel.js.map +1 -1
  33. package/dist/ChannelSchema.d.ts +119 -10
  34. package/dist/ChannelSchema.d.ts.map +1 -1
  35. package/dist/ChannelSchema.js +45 -6
  36. package/dist/ChannelSchema.js.map +1 -1
  37. package/dist/Chunk.d.ts +574 -428
  38. package/dist/Chunk.d.ts.map +1 -1
  39. package/dist/Chunk.js +250 -191
  40. package/dist/Chunk.js.map +1 -1
  41. package/dist/Clock.d.ts +16 -9
  42. package/dist/Clock.d.ts.map +1 -1
  43. package/dist/Clock.js +9 -5
  44. package/dist/Clock.js.map +1 -1
  45. package/dist/Combiner.d.ts +11 -5
  46. package/dist/Combiner.d.ts.map +1 -1
  47. package/dist/Combiner.js +10 -4
  48. package/dist/Combiner.js.map +1 -1
  49. package/dist/Config.d.ts +80 -68
  50. package/dist/Config.d.ts.map +1 -1
  51. package/dist/Config.js +53 -49
  52. package/dist/Config.js.map +1 -1
  53. package/dist/ConfigProvider.d.ts +33 -32
  54. package/dist/ConfigProvider.d.ts.map +1 -1
  55. package/dist/ConfigProvider.js +19 -18
  56. package/dist/ConfigProvider.js.map +1 -1
  57. package/dist/Console.d.ts +76 -50
  58. package/dist/Console.d.ts.map +1 -1
  59. package/dist/Console.js +69 -46
  60. package/dist/Console.js.map +1 -1
  61. package/dist/Context.d.ts +400 -189
  62. package/dist/Context.d.ts.map +1 -1
  63. package/dist/Context.js +143 -77
  64. package/dist/Context.js.map +1 -1
  65. package/dist/Cron.d.ts +67 -48
  66. package/dist/Cron.d.ts.map +1 -1
  67. package/dist/Cron.js +94 -36
  68. package/dist/Cron.js.map +1 -1
  69. package/dist/Crypto.d.ts +208 -0
  70. package/dist/Crypto.d.ts.map +1 -0
  71. package/dist/Crypto.js +157 -0
  72. package/dist/Crypto.js.map +1 -0
  73. package/dist/Data.d.ts +9 -3
  74. package/dist/Data.d.ts.map +1 -1
  75. package/dist/Data.js.map +1 -1
  76. package/dist/DateTime.d.ts +893 -464
  77. package/dist/DateTime.d.ts.map +1 -1
  78. package/dist/DateTime.js +387 -228
  79. package/dist/DateTime.js.map +1 -1
  80. package/dist/Deferred.d.ts +367 -175
  81. package/dist/Deferred.d.ts.map +1 -1
  82. package/dist/Deferred.js +146 -72
  83. package/dist/Deferred.js.map +1 -1
  84. package/dist/Differ.d.ts +44 -2
  85. package/dist/Differ.d.ts.map +1 -1
  86. package/dist/Differ.js +36 -0
  87. package/dist/Duration.d.ts +333 -186
  88. package/dist/Duration.d.ts.map +1 -1
  89. package/dist/Duration.js +178 -107
  90. package/dist/Duration.js.map +1 -1
  91. package/dist/Effect.d.ts +2181 -2275
  92. package/dist/Effect.d.ts.map +1 -1
  93. package/dist/Effect.js +935 -850
  94. package/dist/Effect.js.map +1 -1
  95. package/dist/Effectable.d.ts +38 -3
  96. package/dist/Effectable.d.ts.map +1 -1
  97. package/dist/Effectable.js +3 -3
  98. package/dist/Effectable.js.map +1 -1
  99. package/dist/Encoding.d.ts +78 -28
  100. package/dist/Encoding.d.ts.map +1 -1
  101. package/dist/Encoding.js +75 -27
  102. package/dist/Encoding.js.map +1 -1
  103. package/dist/Equal.d.ts +4 -3
  104. package/dist/Equal.d.ts.map +1 -1
  105. package/dist/Equal.js +4 -3
  106. package/dist/Equal.js.map +1 -1
  107. package/dist/Equivalence.d.ts +18 -24
  108. package/dist/Equivalence.d.ts.map +1 -1
  109. package/dist/Equivalence.js +16 -21
  110. package/dist/Equivalence.js.map +1 -1
  111. package/dist/ErrorReporter.d.ts +66 -82
  112. package/dist/ErrorReporter.d.ts.map +1 -1
  113. package/dist/ErrorReporter.js +38 -29
  114. package/dist/ErrorReporter.js.map +1 -1
  115. package/dist/ExecutionPlan.d.ts +106 -12
  116. package/dist/ExecutionPlan.d.ts.map +1 -1
  117. package/dist/ExecutionPlan.js +23 -6
  118. package/dist/ExecutionPlan.js.map +1 -1
  119. package/dist/Exit.d.ts +6 -5
  120. package/dist/Exit.d.ts.map +1 -1
  121. package/dist/Exit.js.map +1 -1
  122. package/dist/Fiber.d.ts +71 -40
  123. package/dist/Fiber.d.ts.map +1 -1
  124. package/dist/Fiber.js +39 -21
  125. package/dist/Fiber.js.map +1 -1
  126. package/dist/FiberHandle.d.ts +118 -57
  127. package/dist/FiberHandle.d.ts.map +1 -1
  128. package/dist/FiberHandle.js +121 -39
  129. package/dist/FiberHandle.js.map +1 -1
  130. package/dist/FiberMap.d.ts +287 -159
  131. package/dist/FiberMap.d.ts.map +1 -1
  132. package/dist/FiberMap.js +175 -73
  133. package/dist/FiberMap.js.map +1 -1
  134. package/dist/FiberSet.d.ts +93 -52
  135. package/dist/FiberSet.d.ts.map +1 -1
  136. package/dist/FiberSet.js +97 -34
  137. package/dist/FiberSet.js.map +1 -1
  138. package/dist/FileSystem.d.ts +102 -73
  139. package/dist/FileSystem.d.ts.map +1 -1
  140. package/dist/FileSystem.js +53 -39
  141. package/dist/FileSystem.js.map +1 -1
  142. package/dist/Filter.d.ts +166 -88
  143. package/dist/Filter.d.ts.map +1 -1
  144. package/dist/Filter.js +68 -42
  145. package/dist/Filter.js.map +1 -1
  146. package/dist/Formatter.d.ts +4 -2
  147. package/dist/Formatter.d.ts.map +1 -1
  148. package/dist/Formatter.js +3 -69
  149. package/dist/Formatter.js.map +1 -1
  150. package/dist/Function.d.ts +218 -151
  151. package/dist/Function.d.ts.map +1 -1
  152. package/dist/Function.js +94 -78
  153. package/dist/Function.js.map +1 -1
  154. package/dist/Graph.d.ts +714 -415
  155. package/dist/Graph.d.ts.map +1 -1
  156. package/dist/Graph.js +325 -182
  157. package/dist/Graph.js.map +1 -1
  158. package/dist/HKT.d.ts +29 -13
  159. package/dist/HKT.d.ts.map +1 -1
  160. package/dist/Hash.d.ts +35 -24
  161. package/dist/Hash.d.ts.map +1 -1
  162. package/dist/Hash.js +27 -17
  163. package/dist/Hash.js.map +1 -1
  164. package/dist/HashMap.d.ts +540 -388
  165. package/dist/HashMap.d.ts.map +1 -1
  166. package/dist/HashMap.js +262 -156
  167. package/dist/HashMap.js.map +1 -1
  168. package/dist/HashRing.d.ts +53 -34
  169. package/dist/HashRing.d.ts.map +1 -1
  170. package/dist/HashRing.js +83 -16
  171. package/dist/HashRing.js.map +1 -1
  172. package/dist/HashSet.d.ts +239 -153
  173. package/dist/HashSet.d.ts.map +1 -1
  174. package/dist/HashSet.js +110 -56
  175. package/dist/HashSet.js.map +1 -1
  176. package/dist/Inspectable.d.ts +26 -13
  177. package/dist/Inspectable.d.ts.map +1 -1
  178. package/dist/Inspectable.js +22 -10
  179. package/dist/Inspectable.js.map +1 -1
  180. package/dist/Iterable.d.ts +336 -222
  181. package/dist/Iterable.d.ts.map +1 -1
  182. package/dist/Iterable.js +146 -100
  183. package/dist/Iterable.js.map +1 -1
  184. package/dist/JsonPatch.d.ts +12 -9
  185. package/dist/JsonPatch.d.ts.map +1 -1
  186. package/dist/JsonPatch.js +9 -6
  187. package/dist/JsonPatch.js.map +1 -1
  188. package/dist/JsonPointer.d.ts +13 -11
  189. package/dist/JsonPointer.d.ts.map +1 -1
  190. package/dist/JsonPointer.js +13 -11
  191. package/dist/JsonPointer.js.map +1 -1
  192. package/dist/JsonSchema.d.ts +16 -0
  193. package/dist/JsonSchema.d.ts.map +1 -1
  194. package/dist/JsonSchema.js +10 -0
  195. package/dist/JsonSchema.js.map +1 -1
  196. package/dist/Latch.d.ts +97 -26
  197. package/dist/Latch.d.ts.map +1 -1
  198. package/dist/Latch.js +39 -20
  199. package/dist/Latch.js.map +1 -1
  200. package/dist/Layer.d.ts +472 -410
  201. package/dist/Layer.d.ts.map +1 -1
  202. package/dist/Layer.js +290 -226
  203. package/dist/Layer.js.map +1 -1
  204. package/dist/LayerMap.d.ts +99 -26
  205. package/dist/LayerMap.d.ts.map +1 -1
  206. package/dist/LayerMap.js +58 -14
  207. package/dist/LayerMap.js.map +1 -1
  208. package/dist/LogLevel.d.ts +92 -131
  209. package/dist/LogLevel.d.ts.map +1 -1
  210. package/dist/LogLevel.js +25 -15
  211. package/dist/LogLevel.js.map +1 -1
  212. package/dist/Logger.d.ts +159 -104
  213. package/dist/Logger.d.ts.map +1 -1
  214. package/dist/Logger.js +215 -189
  215. package/dist/Logger.js.map +1 -1
  216. package/dist/ManagedRuntime.d.ts +78 -19
  217. package/dist/ManagedRuntime.d.ts.map +1 -1
  218. package/dist/ManagedRuntime.js +24 -17
  219. package/dist/ManagedRuntime.js.map +1 -1
  220. package/dist/Match.d.ts +135 -161
  221. package/dist/Match.d.ts.map +1 -1
  222. package/dist/Match.js +86 -78
  223. package/dist/Match.js.map +1 -1
  224. package/dist/Metric.d.ts +330 -291
  225. package/dist/Metric.d.ts.map +1 -1
  226. package/dist/Metric.js +219 -214
  227. package/dist/Metric.js.map +1 -1
  228. package/dist/MutableHashMap.d.ts +146 -87
  229. package/dist/MutableHashMap.d.ts.map +1 -1
  230. package/dist/MutableHashMap.js +67 -43
  231. package/dist/MutableHashMap.js.map +1 -1
  232. package/dist/MutableHashSet.d.ts +52 -30
  233. package/dist/MutableHashSet.d.ts.map +1 -1
  234. package/dist/MutableHashSet.js +92 -38
  235. package/dist/MutableHashSet.js.map +1 -1
  236. package/dist/MutableList.d.ts +110 -68
  237. package/dist/MutableList.d.ts.map +1 -1
  238. package/dist/MutableList.js +135 -85
  239. package/dist/MutableList.js.map +1 -1
  240. package/dist/MutableRef.d.ts +99 -62
  241. package/dist/MutableRef.d.ts.map +1 -1
  242. package/dist/MutableRef.js +78 -60
  243. package/dist/MutableRef.js.map +1 -1
  244. package/dist/Newtype.d.ts +15 -2
  245. package/dist/Newtype.d.ts.map +1 -1
  246. package/dist/Newtype.js +8 -2
  247. package/dist/Newtype.js.map +1 -1
  248. package/dist/NonEmptyIterable.d.ts +38 -48
  249. package/dist/NonEmptyIterable.d.ts.map +1 -1
  250. package/dist/NonEmptyIterable.js +34 -25
  251. package/dist/NonEmptyIterable.js.map +1 -1
  252. package/dist/Number.d.ts +261 -205
  253. package/dist/Number.d.ts.map +1 -1
  254. package/dist/Number.js +119 -91
  255. package/dist/Number.js.map +1 -1
  256. package/dist/Optic.d.ts +6 -7
  257. package/dist/Optic.d.ts.map +1 -1
  258. package/dist/Optic.js +5 -6
  259. package/dist/Optic.js.map +1 -1
  260. package/dist/Option.d.ts +133 -156
  261. package/dist/Option.d.ts.map +1 -1
  262. package/dist/Option.js +64 -64
  263. package/dist/Option.js.map +1 -1
  264. package/dist/Order.d.ts +6 -6
  265. package/dist/Order.js +6 -6
  266. package/dist/Ordering.d.ts +56 -45
  267. package/dist/Ordering.d.ts.map +1 -1
  268. package/dist/Ordering.js +10 -8
  269. package/dist/Ordering.js.map +1 -1
  270. package/dist/PartitionedSemaphore.d.ts +225 -40
  271. package/dist/PartitionedSemaphore.d.ts.map +1 -1
  272. package/dist/PartitionedSemaphore.js +113 -17
  273. package/dist/PartitionedSemaphore.js.map +1 -1
  274. package/dist/Path.d.ts +77 -13
  275. package/dist/Path.d.ts.map +1 -1
  276. package/dist/Path.js +49 -4
  277. package/dist/Path.js.map +1 -1
  278. package/dist/Pipeable.d.ts +77 -18
  279. package/dist/Pipeable.d.ts.map +1 -1
  280. package/dist/Pipeable.js +63 -14
  281. package/dist/Pipeable.js.map +1 -1
  282. package/dist/PlatformError.d.ts +74 -6
  283. package/dist/PlatformError.d.ts.map +1 -1
  284. package/dist/PlatformError.js +68 -5
  285. package/dist/PlatformError.js.map +1 -1
  286. package/dist/Pool.d.ts +66 -31
  287. package/dist/Pool.d.ts.map +1 -1
  288. package/dist/Pool.js +26 -24
  289. package/dist/Pool.js.map +1 -1
  290. package/dist/Predicate.d.ts +16 -23
  291. package/dist/Predicate.d.ts.map +1 -1
  292. package/dist/Predicate.js +12 -17
  293. package/dist/Predicate.js.map +1 -1
  294. package/dist/PrimaryKey.d.ts +11 -3
  295. package/dist/PrimaryKey.d.ts.map +1 -1
  296. package/dist/PrimaryKey.js +9 -2
  297. package/dist/PrimaryKey.js.map +1 -1
  298. package/dist/PubSub.d.ts +385 -309
  299. package/dist/PubSub.d.ts.map +1 -1
  300. package/dist/PubSub.js +260 -207
  301. package/dist/PubSub.js.map +1 -1
  302. package/dist/Pull.d.ts +94 -25
  303. package/dist/Pull.d.ts.map +1 -1
  304. package/dist/Pull.js +61 -13
  305. package/dist/Pull.js.map +1 -1
  306. package/dist/Queue.d.ts +303 -184
  307. package/dist/Queue.d.ts.map +1 -1
  308. package/dist/Queue.js +231 -134
  309. package/dist/Queue.js.map +1 -1
  310. package/dist/Random.d.ts +65 -57
  311. package/dist/Random.d.ts.map +1 -1
  312. package/dist/Random.js +41 -66
  313. package/dist/Random.js.map +1 -1
  314. package/dist/RcMap.d.ts +151 -141
  315. package/dist/RcMap.d.ts.map +1 -1
  316. package/dist/RcMap.js +66 -20
  317. package/dist/RcMap.js.map +1 -1
  318. package/dist/RcRef.d.ts +68 -32
  319. package/dist/RcRef.d.ts.map +1 -1
  320. package/dist/RcRef.js +33 -16
  321. package/dist/RcRef.js.map +1 -1
  322. package/dist/Record.d.ts +282 -137
  323. package/dist/Record.d.ts.map +1 -1
  324. package/dist/Record.js +124 -62
  325. package/dist/Record.js.map +1 -1
  326. package/dist/Redactable.d.ts +7 -5
  327. package/dist/Redactable.d.ts.map +1 -1
  328. package/dist/Redactable.js +5 -3
  329. package/dist/Redactable.js.map +1 -1
  330. package/dist/Redacted.d.ts +63 -34
  331. package/dist/Redacted.d.ts.map +1 -1
  332. package/dist/Redacted.js +31 -15
  333. package/dist/Redacted.js.map +1 -1
  334. package/dist/Reducer.d.ts +3 -1
  335. package/dist/Reducer.d.ts.map +1 -1
  336. package/dist/Reducer.js +2 -0
  337. package/dist/Reducer.js.map +1 -1
  338. package/dist/Ref.d.ts +85 -66
  339. package/dist/Ref.d.ts.map +1 -1
  340. package/dist/Ref.js +57 -45
  341. package/dist/Ref.js.map +1 -1
  342. package/dist/References.d.ts +73 -31
  343. package/dist/References.d.ts.map +1 -1
  344. package/dist/References.js +66 -30
  345. package/dist/References.js.map +1 -1
  346. package/dist/RegExp.d.ts +12 -6
  347. package/dist/RegExp.d.ts.map +1 -1
  348. package/dist/RegExp.js +12 -6
  349. package/dist/RegExp.js.map +1 -1
  350. package/dist/Request.d.ts +159 -34
  351. package/dist/Request.d.ts.map +1 -1
  352. package/dist/Request.js +68 -12
  353. package/dist/Request.js.map +1 -1
  354. package/dist/RequestResolver.d.ts +262 -118
  355. package/dist/RequestResolver.d.ts.map +1 -1
  356. package/dist/RequestResolver.js +78 -42
  357. package/dist/RequestResolver.js.map +1 -1
  358. package/dist/Resource.d.ts +13 -7
  359. package/dist/Resource.d.ts.map +1 -1
  360. package/dist/Resource.js +44 -6
  361. package/dist/Resource.js.map +1 -1
  362. package/dist/Result.d.ts +135 -151
  363. package/dist/Result.d.ts.map +1 -1
  364. package/dist/Result.js +56 -68
  365. package/dist/Result.js.map +1 -1
  366. package/dist/Runtime.d.ts +40 -20
  367. package/dist/Runtime.d.ts.map +1 -1
  368. package/dist/Runtime.js +34 -17
  369. package/dist/Runtime.js.map +1 -1
  370. package/dist/Schedule.d.ts +556 -590
  371. package/dist/Schedule.d.ts.map +1 -1
  372. package/dist/Schedule.js +265 -253
  373. package/dist/Schedule.js.map +1 -1
  374. package/dist/Scheduler.d.ts +44 -7
  375. package/dist/Scheduler.d.ts.map +1 -1
  376. package/dist/Scheduler.js +34 -5
  377. package/dist/Scheduler.js.map +1 -1
  378. package/dist/Schema.d.ts +1293 -602
  379. package/dist/Schema.d.ts.map +1 -1
  380. package/dist/Schema.js +501 -361
  381. package/dist/Schema.js.map +1 -1
  382. package/dist/SchemaAST.d.ts +122 -92
  383. package/dist/SchemaAST.d.ts.map +1 -1
  384. package/dist/SchemaAST.js +102 -77
  385. package/dist/SchemaAST.js.map +1 -1
  386. package/dist/SchemaGetter.d.ts +49 -36
  387. package/dist/SchemaGetter.d.ts.map +1 -1
  388. package/dist/SchemaGetter.js +42 -29
  389. package/dist/SchemaGetter.js.map +1 -1
  390. package/dist/SchemaIssue.d.ts +19 -24
  391. package/dist/SchemaIssue.d.ts.map +1 -1
  392. package/dist/SchemaIssue.js +16 -14
  393. package/dist/SchemaIssue.js.map +1 -1
  394. package/dist/SchemaParser.d.ts +231 -63
  395. package/dist/SchemaParser.d.ts.map +1 -1
  396. package/dist/SchemaParser.js +266 -75
  397. package/dist/SchemaParser.js.map +1 -1
  398. package/dist/SchemaRepresentation.d.ts +89 -77
  399. package/dist/SchemaRepresentation.d.ts.map +1 -1
  400. package/dist/SchemaRepresentation.js +47 -37
  401. package/dist/SchemaRepresentation.js.map +1 -1
  402. package/dist/SchemaTransformation.d.ts +97 -46
  403. package/dist/SchemaTransformation.d.ts.map +1 -1
  404. package/dist/SchemaTransformation.js +89 -38
  405. package/dist/SchemaTransformation.js.map +1 -1
  406. package/dist/SchemaUtils.d.ts +8 -1
  407. package/dist/SchemaUtils.d.ts.map +1 -1
  408. package/dist/SchemaUtils.js +24 -1
  409. package/dist/SchemaUtils.js.map +1 -1
  410. package/dist/Scope.d.ts +107 -65
  411. package/dist/Scope.d.ts.map +1 -1
  412. package/dist/Scope.js +61 -32
  413. package/dist/Scope.js.map +1 -1
  414. package/dist/ScopedCache.d.ts +141 -49
  415. package/dist/ScopedCache.d.ts.map +1 -1
  416. package/dist/ScopedCache.js +82 -21
  417. package/dist/ScopedCache.js.map +1 -1
  418. package/dist/ScopedRef.d.ts +28 -8
  419. package/dist/ScopedRef.d.ts.map +1 -1
  420. package/dist/ScopedRef.js +25 -5
  421. package/dist/ScopedRef.js.map +1 -1
  422. package/dist/Semaphore.d.ts +61 -37
  423. package/dist/Semaphore.d.ts.map +1 -1
  424. package/dist/Semaphore.js +18 -21
  425. package/dist/Semaphore.js.map +1 -1
  426. package/dist/Sink.d.ts +461 -206
  427. package/dist/Sink.d.ts.map +1 -1
  428. package/dist/Sink.js +241 -90
  429. package/dist/Sink.js.map +1 -1
  430. package/dist/Stdio.d.ts +43 -6
  431. package/dist/Stdio.d.ts.map +1 -1
  432. package/dist/Stdio.js +33 -4
  433. package/dist/Stdio.js.map +1 -1
  434. package/dist/Stream.d.ts +2117 -1541
  435. package/dist/Stream.d.ts.map +1 -1
  436. package/dist/Stream.js +951 -682
  437. package/dist/Stream.js.map +1 -1
  438. package/dist/String.d.ts +174 -97
  439. package/dist/String.d.ts.map +1 -1
  440. package/dist/String.js +128 -69
  441. package/dist/String.js.map +1 -1
  442. package/dist/Struct.d.ts +20 -18
  443. package/dist/Struct.d.ts.map +1 -1
  444. package/dist/Struct.js +10 -8
  445. package/dist/Struct.js.map +1 -1
  446. package/dist/SubscriptionRef.d.ts +309 -204
  447. package/dist/SubscriptionRef.d.ts.map +1 -1
  448. package/dist/SubscriptionRef.js +126 -77
  449. package/dist/SubscriptionRef.js.map +1 -1
  450. package/dist/Symbol.d.ts +13 -5
  451. package/dist/Symbol.d.ts.map +1 -1
  452. package/dist/Symbol.js +13 -5
  453. package/dist/Symbol.js.map +1 -1
  454. package/dist/SynchronizedRef.d.ts +278 -62
  455. package/dist/SynchronizedRef.d.ts.map +1 -1
  456. package/dist/SynchronizedRef.js +116 -23
  457. package/dist/SynchronizedRef.js.map +1 -1
  458. package/dist/Take.d.ts +26 -2
  459. package/dist/Take.d.ts.map +1 -1
  460. package/dist/Take.js +4 -1
  461. package/dist/Take.js.map +1 -1
  462. package/dist/Terminal.d.ts +39 -7
  463. package/dist/Terminal.d.ts.map +1 -1
  464. package/dist/Terminal.js +10 -4
  465. package/dist/Terminal.js.map +1 -1
  466. package/dist/Tracer.d.ts +233 -59
  467. package/dist/Tracer.d.ts.map +1 -1
  468. package/dist/Tracer.js +94 -18
  469. package/dist/Tracer.js.map +1 -1
  470. package/dist/Trie.d.ts +280 -245
  471. package/dist/Trie.d.ts.map +1 -1
  472. package/dist/Trie.js +116 -102
  473. package/dist/Trie.js.map +1 -1
  474. package/dist/Tuple.d.ts +34 -32
  475. package/dist/Tuple.d.ts.map +1 -1
  476. package/dist/Tuple.js +16 -14
  477. package/dist/Tuple.js.map +1 -1
  478. package/dist/TxChunk.d.ts +200 -155
  479. package/dist/TxChunk.d.ts.map +1 -1
  480. package/dist/TxChunk.js +83 -61
  481. package/dist/TxChunk.js.map +1 -1
  482. package/dist/TxDeferred.d.ts +43 -29
  483. package/dist/TxDeferred.d.ts.map +1 -1
  484. package/dist/TxDeferred.js +22 -15
  485. package/dist/TxDeferred.js.map +1 -1
  486. package/dist/TxHashMap.d.ts +362 -223
  487. package/dist/TxHashMap.d.ts.map +1 -1
  488. package/dist/TxHashMap.js +171 -98
  489. package/dist/TxHashMap.js.map +1 -1
  490. package/dist/TxHashSet.d.ts +181 -111
  491. package/dist/TxHashSet.d.ts.map +1 -1
  492. package/dist/TxHashSet.js +87 -49
  493. package/dist/TxHashSet.js.map +1 -1
  494. package/dist/TxPriorityQueue.d.ts +94 -63
  495. package/dist/TxPriorityQueue.d.ts.map +1 -1
  496. package/dist/TxPriorityQueue.js +55 -37
  497. package/dist/TxPriorityQueue.js.map +1 -1
  498. package/dist/TxPubSub.d.ts +77 -49
  499. package/dist/TxPubSub.d.ts.map +1 -1
  500. package/dist/TxPubSub.js +60 -37
  501. package/dist/TxPubSub.js.map +1 -1
  502. package/dist/TxQueue.d.ts +277 -242
  503. package/dist/TxQueue.d.ts.map +1 -1
  504. package/dist/TxQueue.js +147 -101
  505. package/dist/TxQueue.js.map +1 -1
  506. package/dist/TxReentrantLock.d.ts +69 -46
  507. package/dist/TxReentrantLock.d.ts.map +1 -1
  508. package/dist/TxReentrantLock.js +48 -32
  509. package/dist/TxReentrantLock.js.map +1 -1
  510. package/dist/TxRef.d.ts +69 -40
  511. package/dist/TxRef.d.ts.map +1 -1
  512. package/dist/TxRef.js +34 -19
  513. package/dist/TxRef.js.map +1 -1
  514. package/dist/TxSemaphore.d.ts +101 -115
  515. package/dist/TxSemaphore.d.ts.map +1 -1
  516. package/dist/TxSemaphore.js +76 -77
  517. package/dist/TxSemaphore.js.map +1 -1
  518. package/dist/TxSubscriptionRef.d.ts +74 -50
  519. package/dist/TxSubscriptionRef.d.ts.map +1 -1
  520. package/dist/TxSubscriptionRef.js +34 -23
  521. package/dist/TxSubscriptionRef.js.map +1 -1
  522. package/dist/Types.d.ts +31 -34
  523. package/dist/Types.d.ts.map +1 -1
  524. package/dist/UndefinedOr.d.ts +62 -25
  525. package/dist/UndefinedOr.d.ts.map +1 -1
  526. package/dist/UndefinedOr.js +36 -25
  527. package/dist/UndefinedOr.js.map +1 -1
  528. package/dist/Unify.d.ts +72 -117
  529. package/dist/Unify.d.ts.map +1 -1
  530. package/dist/Unify.js +20 -6
  531. package/dist/Unify.js.map +1 -1
  532. package/dist/Utils.d.ts +5 -2
  533. package/dist/Utils.d.ts.map +1 -1
  534. package/dist/Utils.js +4 -0
  535. package/dist/Utils.js.map +1 -1
  536. package/dist/index.d.ts +1973 -418
  537. package/dist/index.d.ts.map +1 -1
  538. package/dist/index.js +1973 -418
  539. package/dist/index.js.map +1 -1
  540. package/dist/internal/schema/schema.js +1 -1
  541. package/dist/internal/schema/schema.js.map +1 -1
  542. package/dist/testing/FastCheck.d.ts +9 -6
  543. package/dist/testing/FastCheck.d.ts.map +1 -1
  544. package/dist/testing/FastCheck.js +9 -6
  545. package/dist/testing/FastCheck.js.map +1 -1
  546. package/dist/testing/TestClock.d.ts +39 -35
  547. package/dist/testing/TestClock.d.ts.map +1 -1
  548. package/dist/testing/TestClock.js +42 -12
  549. package/dist/testing/TestClock.js.map +1 -1
  550. package/dist/testing/TestConsole.d.ts +44 -36
  551. package/dist/testing/TestConsole.d.ts.map +1 -1
  552. package/dist/testing/TestConsole.js +30 -15
  553. package/dist/testing/TestConsole.js.map +1 -1
  554. package/dist/testing/TestSchema.d.ts +2 -0
  555. package/dist/testing/TestSchema.d.ts.map +1 -1
  556. package/dist/testing/TestSchema.js +9 -7
  557. package/dist/testing/TestSchema.js.map +1 -1
  558. package/dist/testing/index.d.ts +34 -0
  559. package/dist/testing/index.d.ts.map +1 -1
  560. package/dist/testing/index.js +34 -0
  561. package/dist/testing/index.js.map +1 -1
  562. package/dist/unstable/ai/AiError.d.ts +205 -147
  563. package/dist/unstable/ai/AiError.d.ts.map +1 -1
  564. package/dist/unstable/ai/AiError.js +164 -109
  565. package/dist/unstable/ai/AiError.js.map +1 -1
  566. package/dist/unstable/ai/AnthropicStructuredOutput.d.ts +1 -1
  567. package/dist/unstable/ai/AnthropicStructuredOutput.js +2 -2
  568. package/dist/unstable/ai/Chat.d.ts +64 -41
  569. package/dist/unstable/ai/Chat.d.ts.map +1 -1
  570. package/dist/unstable/ai/Chat.js +51 -33
  571. package/dist/unstable/ai/Chat.js.map +1 -1
  572. package/dist/unstable/ai/EmbeddingModel.d.ts +12 -11
  573. package/dist/unstable/ai/EmbeddingModel.d.ts.map +1 -1
  574. package/dist/unstable/ai/EmbeddingModel.js +9 -8
  575. package/dist/unstable/ai/EmbeddingModel.js.map +1 -1
  576. package/dist/unstable/ai/IdGenerator.d.ts +28 -18
  577. package/dist/unstable/ai/IdGenerator.d.ts.map +1 -1
  578. package/dist/unstable/ai/IdGenerator.js +18 -11
  579. package/dist/unstable/ai/IdGenerator.js.map +1 -1
  580. package/dist/unstable/ai/LanguageModel.d.ts +31 -25
  581. package/dist/unstable/ai/LanguageModel.d.ts.map +1 -1
  582. package/dist/unstable/ai/LanguageModel.js +20 -14
  583. package/dist/unstable/ai/LanguageModel.js.map +1 -1
  584. package/dist/unstable/ai/McpSchema.d.ts +342 -119
  585. package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
  586. package/dist/unstable/ai/McpSchema.js +266 -98
  587. package/dist/unstable/ai/McpSchema.js.map +1 -1
  588. package/dist/unstable/ai/McpServer.d.ts +56 -20
  589. package/dist/unstable/ai/McpServer.d.ts.map +1 -1
  590. package/dist/unstable/ai/McpServer.js +64 -16
  591. package/dist/unstable/ai/McpServer.js.map +1 -1
  592. package/dist/unstable/ai/Model.d.ts +10 -12
  593. package/dist/unstable/ai/Model.d.ts.map +1 -1
  594. package/dist/unstable/ai/Model.js +9 -7
  595. package/dist/unstable/ai/Model.js.map +1 -1
  596. package/dist/unstable/ai/OpenAiStructuredOutput.d.ts +1 -1
  597. package/dist/unstable/ai/OpenAiStructuredOutput.js +2 -2
  598. package/dist/unstable/ai/Prompt.d.ts +200 -176
  599. package/dist/unstable/ai/Prompt.d.ts.map +1 -1
  600. package/dist/unstable/ai/Prompt.js +77 -68
  601. package/dist/unstable/ai/Prompt.js.map +1 -1
  602. package/dist/unstable/ai/Response.d.ts +173 -160
  603. package/dist/unstable/ai/Response.d.ts.map +1 -1
  604. package/dist/unstable/ai/Response.js +43 -48
  605. package/dist/unstable/ai/Response.js.map +1 -1
  606. package/dist/unstable/ai/ResponseIdTracker.d.ts +43 -4
  607. package/dist/unstable/ai/ResponseIdTracker.d.ts.map +1 -1
  608. package/dist/unstable/ai/ResponseIdTracker.js +27 -2
  609. package/dist/unstable/ai/ResponseIdTracker.js.map +1 -1
  610. package/dist/unstable/ai/Telemetry.d.ts +43 -33
  611. package/dist/unstable/ai/Telemetry.d.ts.map +1 -1
  612. package/dist/unstable/ai/Telemetry.js +15 -11
  613. package/dist/unstable/ai/Telemetry.js.map +1 -1
  614. package/dist/unstable/ai/Tokenizer.d.ts +14 -9
  615. package/dist/unstable/ai/Tokenizer.d.ts.map +1 -1
  616. package/dist/unstable/ai/Tokenizer.js +10 -6
  617. package/dist/unstable/ai/Tokenizer.js.map +1 -1
  618. package/dist/unstable/ai/Tool.d.ts +167 -96
  619. package/dist/unstable/ai/Tool.d.ts.map +1 -1
  620. package/dist/unstable/ai/Tool.js +107 -53
  621. package/dist/unstable/ai/Tool.js.map +1 -1
  622. package/dist/unstable/ai/Toolkit.d.ts +32 -39
  623. package/dist/unstable/ai/Toolkit.d.ts.map +1 -1
  624. package/dist/unstable/ai/Toolkit.js +7 -5
  625. package/dist/unstable/ai/Toolkit.js.map +1 -1
  626. package/dist/unstable/ai/index.d.ts +121 -29
  627. package/dist/unstable/ai/index.d.ts.map +1 -1
  628. package/dist/unstable/ai/index.js +121 -29
  629. package/dist/unstable/ai/index.js.map +1 -1
  630. package/dist/unstable/cli/Argument.d.ts +226 -134
  631. package/dist/unstable/cli/Argument.d.ts.map +1 -1
  632. package/dist/unstable/cli/Argument.js +101 -65
  633. package/dist/unstable/cli/Argument.js.map +1 -1
  634. package/dist/unstable/cli/CliError.d.ts +72 -26
  635. package/dist/unstable/cli/CliError.d.ts.map +1 -1
  636. package/dist/unstable/cli/CliError.js +86 -23
  637. package/dist/unstable/cli/CliError.js.map +1 -1
  638. package/dist/unstable/cli/CliOutput.d.ts +48 -19
  639. package/dist/unstable/cli/CliOutput.d.ts.map +1 -1
  640. package/dist/unstable/cli/CliOutput.js +32 -9
  641. package/dist/unstable/cli/CliOutput.js.map +1 -1
  642. package/dist/unstable/cli/Command.d.ts +196 -115
  643. package/dist/unstable/cli/Command.d.ts.map +1 -1
  644. package/dist/unstable/cli/Command.js +45 -31
  645. package/dist/unstable/cli/Command.js.map +1 -1
  646. package/dist/unstable/cli/Completions.d.ts +7 -7
  647. package/dist/unstable/cli/Completions.js +1 -1
  648. package/dist/unstable/cli/Flag.d.ts +235 -142
  649. package/dist/unstable/cli/Flag.d.ts.map +1 -1
  650. package/dist/unstable/cli/Flag.js +111 -71
  651. package/dist/unstable/cli/Flag.js.map +1 -1
  652. package/dist/unstable/cli/GlobalFlag.d.ts +41 -13
  653. package/dist/unstable/cli/GlobalFlag.d.ts.map +1 -1
  654. package/dist/unstable/cli/GlobalFlag.js +30 -7
  655. package/dist/unstable/cli/GlobalFlag.js.map +1 -1
  656. package/dist/unstable/cli/HelpDoc.d.ts +39 -14
  657. package/dist/unstable/cli/HelpDoc.d.ts.map +1 -1
  658. package/dist/unstable/cli/HelpDoc.js +21 -0
  659. package/dist/unstable/cli/Param.d.ts +110 -32
  660. package/dist/unstable/cli/Param.d.ts.map +1 -1
  661. package/dist/unstable/cli/Param.js +196 -135
  662. package/dist/unstable/cli/Param.js.map +1 -1
  663. package/dist/unstable/cli/Primitive.d.ts +79 -42
  664. package/dist/unstable/cli/Primitive.d.ts.map +1 -1
  665. package/dist/unstable/cli/Primitive.js +66 -35
  666. package/dist/unstable/cli/Primitive.js.map +1 -1
  667. package/dist/unstable/cli/Prompt.d.ts +183 -59
  668. package/dist/unstable/cli/Prompt.d.ts.map +1 -1
  669. package/dist/unstable/cli/Prompt.js +105 -23
  670. package/dist/unstable/cli/Prompt.js.map +1 -1
  671. package/dist/unstable/cli/index.d.ts +182 -0
  672. package/dist/unstable/cli/index.d.ts.map +1 -1
  673. package/dist/unstable/cli/index.js +205 -6
  674. package/dist/unstable/cli/index.js.map +1 -1
  675. package/dist/unstable/cli/internal/ansi.d.ts.map +1 -1
  676. package/dist/unstable/cli/internal/ansi.js +13 -0
  677. package/dist/unstable/cli/internal/ansi.js.map +1 -1
  678. package/dist/unstable/cli/internal/command.d.ts +5 -1
  679. package/dist/unstable/cli/internal/command.d.ts.map +1 -1
  680. package/dist/unstable/cli/internal/command.js +5 -1
  681. package/dist/unstable/cli/internal/command.js.map +1 -1
  682. package/dist/unstable/cli/internal/config.d.ts +3 -0
  683. package/dist/unstable/cli/internal/config.d.ts.map +1 -1
  684. package/dist/unstable/cli/internal/config.js.map +1 -1
  685. package/dist/unstable/cli/internal/lexer.js.map +1 -1
  686. package/dist/unstable/cli/internal/parser.js +0 -1
  687. package/dist/unstable/cli/internal/parser.js.map +1 -1
  688. package/dist/unstable/cluster/ClusterCron.d.ts +35 -1
  689. package/dist/unstable/cluster/ClusterCron.d.ts.map +1 -1
  690. package/dist/unstable/cluster/ClusterCron.js +35 -1
  691. package/dist/unstable/cluster/ClusterCron.js.map +1 -1
  692. package/dist/unstable/cluster/ClusterError.d.ts +56 -7
  693. package/dist/unstable/cluster/ClusterError.d.ts.map +1 -1
  694. package/dist/unstable/cluster/ClusterError.js +56 -7
  695. package/dist/unstable/cluster/ClusterError.js.map +1 -1
  696. package/dist/unstable/cluster/ClusterMetrics.d.ts +39 -5
  697. package/dist/unstable/cluster/ClusterMetrics.d.ts.map +1 -1
  698. package/dist/unstable/cluster/ClusterMetrics.js +39 -5
  699. package/dist/unstable/cluster/ClusterMetrics.js.map +1 -1
  700. package/dist/unstable/cluster/ClusterSchema.d.ts +61 -8
  701. package/dist/unstable/cluster/ClusterSchema.d.ts.map +1 -1
  702. package/dist/unstable/cluster/ClusterSchema.js +61 -8
  703. package/dist/unstable/cluster/ClusterSchema.js.map +1 -1
  704. package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts +14 -2
  705. package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts.map +1 -1
  706. package/dist/unstable/cluster/ClusterWorkflowEngine.js +35 -2
  707. package/dist/unstable/cluster/ClusterWorkflowEngine.js.map +1 -1
  708. package/dist/unstable/cluster/DeliverAt.d.ts +39 -4
  709. package/dist/unstable/cluster/DeliverAt.d.ts.map +1 -1
  710. package/dist/unstable/cluster/DeliverAt.js +11 -3
  711. package/dist/unstable/cluster/DeliverAt.js.map +1 -1
  712. package/dist/unstable/cluster/Entity.d.ts +74 -16
  713. package/dist/unstable/cluster/Entity.d.ts.map +1 -1
  714. package/dist/unstable/cluster/Entity.js +75 -10
  715. package/dist/unstable/cluster/Entity.js.map +1 -1
  716. package/dist/unstable/cluster/EntityAddress.d.ts +30 -2
  717. package/dist/unstable/cluster/EntityAddress.d.ts.map +1 -1
  718. package/dist/unstable/cluster/EntityAddress.js +30 -2
  719. package/dist/unstable/cluster/EntityAddress.js.map +1 -1
  720. package/dist/unstable/cluster/EntityId.d.ts +18 -3
  721. package/dist/unstable/cluster/EntityId.d.ts.map +1 -1
  722. package/dist/unstable/cluster/EntityId.js +15 -2
  723. package/dist/unstable/cluster/EntityId.js.map +1 -1
  724. package/dist/unstable/cluster/EntityProxy.d.ts +42 -14
  725. package/dist/unstable/cluster/EntityProxy.d.ts.map +1 -1
  726. package/dist/unstable/cluster/EntityProxy.js +30 -14
  727. package/dist/unstable/cluster/EntityProxy.js.map +1 -1
  728. package/dist/unstable/cluster/EntityProxyServer.d.ts +18 -2
  729. package/dist/unstable/cluster/EntityProxyServer.d.ts.map +1 -1
  730. package/dist/unstable/cluster/EntityProxyServer.js +40 -8
  731. package/dist/unstable/cluster/EntityProxyServer.js.map +1 -1
  732. package/dist/unstable/cluster/EntityResource.d.ts +43 -6
  733. package/dist/unstable/cluster/EntityResource.d.ts.map +1 -1
  734. package/dist/unstable/cluster/EntityResource.js +11 -4
  735. package/dist/unstable/cluster/EntityResource.js.map +1 -1
  736. package/dist/unstable/cluster/EntityType.d.ts +27 -3
  737. package/dist/unstable/cluster/EntityType.d.ts.map +1 -1
  738. package/dist/unstable/cluster/EntityType.js +24 -2
  739. package/dist/unstable/cluster/EntityType.js.map +1 -1
  740. package/dist/unstable/cluster/Envelope.d.ts +105 -23
  741. package/dist/unstable/cluster/Envelope.d.ts.map +1 -1
  742. package/dist/unstable/cluster/Envelope.js +88 -14
  743. package/dist/unstable/cluster/Envelope.js.map +1 -1
  744. package/dist/unstable/cluster/HttpRunner.d.ts +88 -13
  745. package/dist/unstable/cluster/HttpRunner.d.ts.map +1 -1
  746. package/dist/unstable/cluster/HttpRunner.js +88 -13
  747. package/dist/unstable/cluster/HttpRunner.js.map +1 -1
  748. package/dist/unstable/cluster/K8sHttpClient.d.ts +49 -6
  749. package/dist/unstable/cluster/K8sHttpClient.d.ts.map +1 -1
  750. package/dist/unstable/cluster/K8sHttpClient.js +31 -6
  751. package/dist/unstable/cluster/K8sHttpClient.js.map +1 -1
  752. package/dist/unstable/cluster/MachineId.d.ts +24 -3
  753. package/dist/unstable/cluster/MachineId.d.ts.map +1 -1
  754. package/dist/unstable/cluster/MachineId.js +21 -2
  755. package/dist/unstable/cluster/MachineId.js.map +1 -1
  756. package/dist/unstable/cluster/Message.d.ts +102 -13
  757. package/dist/unstable/cluster/Message.d.ts.map +1 -1
  758. package/dist/unstable/cluster/Message.js +86 -10
  759. package/dist/unstable/cluster/Message.js.map +1 -1
  760. package/dist/unstable/cluster/MessageStorage.d.ts +126 -21
  761. package/dist/unstable/cluster/MessageStorage.d.ts.map +1 -1
  762. package/dist/unstable/cluster/MessageStorage.js +70 -10
  763. package/dist/unstable/cluster/MessageStorage.js.map +1 -1
  764. package/dist/unstable/cluster/Reply.d.ts +101 -12
  765. package/dist/unstable/cluster/Reply.d.ts.map +1 -1
  766. package/dist/unstable/cluster/Reply.js +64 -8
  767. package/dist/unstable/cluster/Reply.js.map +1 -1
  768. package/dist/unstable/cluster/Runner.d.ts +47 -17
  769. package/dist/unstable/cluster/Runner.d.ts.map +1 -1
  770. package/dist/unstable/cluster/Runner.js +47 -17
  771. package/dist/unstable/cluster/Runner.js.map +1 -1
  772. package/dist/unstable/cluster/RunnerAddress.d.ts +34 -2
  773. package/dist/unstable/cluster/RunnerAddress.d.ts.map +1 -1
  774. package/dist/unstable/cluster/RunnerAddress.js +34 -2
  775. package/dist/unstable/cluster/RunnerAddress.js.map +1 -1
  776. package/dist/unstable/cluster/RunnerHealth.d.ts +40 -12
  777. package/dist/unstable/cluster/RunnerHealth.d.ts.map +1 -1
  778. package/dist/unstable/cluster/RunnerHealth.js +40 -12
  779. package/dist/unstable/cluster/RunnerHealth.js.map +1 -1
  780. package/dist/unstable/cluster/RunnerServer.d.ts +7 -4
  781. package/dist/unstable/cluster/RunnerServer.d.ts.map +1 -1
  782. package/dist/unstable/cluster/RunnerServer.js +31 -4
  783. package/dist/unstable/cluster/RunnerServer.js.map +1 -1
  784. package/dist/unstable/cluster/RunnerStorage.d.ts +42 -5
  785. package/dist/unstable/cluster/RunnerStorage.d.ts.map +1 -1
  786. package/dist/unstable/cluster/RunnerStorage.js +38 -4
  787. package/dist/unstable/cluster/RunnerStorage.js.map +1 -1
  788. package/dist/unstable/cluster/Runners.d.ts +76 -13
  789. package/dist/unstable/cluster/Runners.d.ts.map +1 -1
  790. package/dist/unstable/cluster/Runners.js +73 -12
  791. package/dist/unstable/cluster/Runners.js.map +1 -1
  792. package/dist/unstable/cluster/ShardId.d.ts +53 -5
  793. package/dist/unstable/cluster/ShardId.d.ts.map +1 -1
  794. package/dist/unstable/cluster/ShardId.js +49 -4
  795. package/dist/unstable/cluster/ShardId.js.map +1 -1
  796. package/dist/unstable/cluster/Sharding.d.ts +10 -2
  797. package/dist/unstable/cluster/Sharding.d.ts.map +1 -1
  798. package/dist/unstable/cluster/Sharding.js +35 -4
  799. package/dist/unstable/cluster/Sharding.js.map +1 -1
  800. package/dist/unstable/cluster/ShardingConfig.d.ts +65 -9
  801. package/dist/unstable/cluster/ShardingConfig.d.ts.map +1 -1
  802. package/dist/unstable/cluster/ShardingConfig.js +66 -9
  803. package/dist/unstable/cluster/ShardingConfig.js.map +1 -1
  804. package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts +27 -6
  805. package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts.map +1 -1
  806. package/dist/unstable/cluster/ShardingRegistrationEvent.js +28 -4
  807. package/dist/unstable/cluster/ShardingRegistrationEvent.js.map +1 -1
  808. package/dist/unstable/cluster/SingleRunner.d.ts +23 -1
  809. package/dist/unstable/cluster/SingleRunner.d.ts.map +1 -1
  810. package/dist/unstable/cluster/SingleRunner.js +23 -1
  811. package/dist/unstable/cluster/SingleRunner.js.map +1 -1
  812. package/dist/unstable/cluster/Singleton.d.ts +15 -1
  813. package/dist/unstable/cluster/Singleton.d.ts.map +1 -1
  814. package/dist/unstable/cluster/Singleton.js +15 -1
  815. package/dist/unstable/cluster/Singleton.js.map +1 -1
  816. package/dist/unstable/cluster/SingletonAddress.d.ts +21 -1
  817. package/dist/unstable/cluster/SingletonAddress.d.ts.map +1 -1
  818. package/dist/unstable/cluster/SingletonAddress.js +21 -1
  819. package/dist/unstable/cluster/SingletonAddress.js.map +1 -1
  820. package/dist/unstable/cluster/Snowflake.d.ts +90 -19
  821. package/dist/unstable/cluster/Snowflake.d.ts.map +1 -1
  822. package/dist/unstable/cluster/Snowflake.js +49 -13
  823. package/dist/unstable/cluster/Snowflake.js.map +1 -1
  824. package/dist/unstable/cluster/SocketRunner.d.ts +8 -2
  825. package/dist/unstable/cluster/SocketRunner.d.ts.map +1 -1
  826. package/dist/unstable/cluster/SocketRunner.js +29 -2
  827. package/dist/unstable/cluster/SocketRunner.js.map +1 -1
  828. package/dist/unstable/cluster/SqlMessageStorage.d.ts +11 -3
  829. package/dist/unstable/cluster/SqlMessageStorage.d.ts.map +1 -1
  830. package/dist/unstable/cluster/SqlMessageStorage.js +27 -3
  831. package/dist/unstable/cluster/SqlMessageStorage.js.map +1 -1
  832. package/dist/unstable/cluster/SqlRunnerStorage.d.ts +11 -3
  833. package/dist/unstable/cluster/SqlRunnerStorage.d.ts.map +1 -1
  834. package/dist/unstable/cluster/SqlRunnerStorage.js +46 -7
  835. package/dist/unstable/cluster/SqlRunnerStorage.js.map +1 -1
  836. package/dist/unstable/cluster/TestRunner.d.ts +18 -1
  837. package/dist/unstable/cluster/TestRunner.d.ts.map +1 -1
  838. package/dist/unstable/cluster/TestRunner.js +18 -1
  839. package/dist/unstable/cluster/TestRunner.js.map +1 -1
  840. package/dist/unstable/cluster/index.d.ts +790 -0
  841. package/dist/unstable/cluster/index.d.ts.map +1 -1
  842. package/dist/unstable/cluster/index.js +790 -0
  843. package/dist/unstable/cluster/index.js.map +1 -1
  844. package/dist/unstable/cluster/internal/hash.js +12 -0
  845. package/dist/unstable/cluster/internal/hash.js.map +1 -1
  846. package/dist/unstable/devtools/DevTools.d.ts +26 -3
  847. package/dist/unstable/devtools/DevTools.d.ts.map +1 -1
  848. package/dist/unstable/devtools/DevTools.js +26 -3
  849. package/dist/unstable/devtools/DevTools.js.map +1 -1
  850. package/dist/unstable/devtools/DevToolsClient.d.ts +20 -5
  851. package/dist/unstable/devtools/DevToolsClient.d.ts.map +1 -1
  852. package/dist/unstable/devtools/DevToolsClient.js +32 -5
  853. package/dist/unstable/devtools/DevToolsClient.js.map +1 -1
  854. package/dist/unstable/devtools/DevToolsSchema.d.ts +184 -44
  855. package/dist/unstable/devtools/DevToolsSchema.d.ts.map +1 -1
  856. package/dist/unstable/devtools/DevToolsSchema.js +102 -20
  857. package/dist/unstable/devtools/DevToolsSchema.js.map +1 -1
  858. package/dist/unstable/devtools/DevToolsServer.d.ts +27 -2
  859. package/dist/unstable/devtools/DevToolsServer.d.ts.map +1 -1
  860. package/dist/unstable/devtools/DevToolsServer.js +21 -1
  861. package/dist/unstable/devtools/DevToolsServer.js.map +1 -1
  862. package/dist/unstable/devtools/index.d.ts +58 -0
  863. package/dist/unstable/devtools/index.d.ts.map +1 -1
  864. package/dist/unstable/devtools/index.js +58 -0
  865. package/dist/unstable/devtools/index.js.map +1 -1
  866. package/dist/unstable/encoding/Msgpack.d.ts +81 -12
  867. package/dist/unstable/encoding/Msgpack.d.ts.map +1 -1
  868. package/dist/unstable/encoding/Msgpack.js +75 -9
  869. package/dist/unstable/encoding/Msgpack.js.map +1 -1
  870. package/dist/unstable/encoding/Ndjson.d.ts +149 -21
  871. package/dist/unstable/encoding/Ndjson.d.ts.map +1 -1
  872. package/dist/unstable/encoding/Ndjson.js +97 -13
  873. package/dist/unstable/encoding/Ndjson.js.map +1 -1
  874. package/dist/unstable/encoding/Sse.d.ts +109 -18
  875. package/dist/unstable/encoding/Sse.d.ts.map +1 -1
  876. package/dist/unstable/encoding/Sse.js +69 -13
  877. package/dist/unstable/encoding/Sse.js.map +1 -1
  878. package/dist/unstable/encoding/index.d.ts +49 -0
  879. package/dist/unstable/encoding/index.d.ts.map +1 -1
  880. package/dist/unstable/encoding/index.js +49 -0
  881. package/dist/unstable/encoding/index.js.map +1 -1
  882. package/dist/unstable/eventlog/Event.d.ts +115 -30
  883. package/dist/unstable/eventlog/Event.d.ts.map +1 -1
  884. package/dist/unstable/eventlog/Event.js +22 -2
  885. package/dist/unstable/eventlog/Event.js.map +1 -1
  886. package/dist/unstable/eventlog/EventGroup.d.ts +50 -17
  887. package/dist/unstable/eventlog/EventGroup.d.ts.map +1 -1
  888. package/dist/unstable/eventlog/EventGroup.js +24 -6
  889. package/dist/unstable/eventlog/EventGroup.js.map +1 -1
  890. package/dist/unstable/eventlog/EventJournal.d.ts +104 -20
  891. package/dist/unstable/eventlog/EventJournal.d.ts.map +1 -1
  892. package/dist/unstable/eventlog/EventJournal.js +108 -16
  893. package/dist/unstable/eventlog/EventJournal.js.map +1 -1
  894. package/dist/unstable/eventlog/EventLog.d.ts +150 -31
  895. package/dist/unstable/eventlog/EventLog.d.ts.map +1 -1
  896. package/dist/unstable/eventlog/EventLog.js +111 -20
  897. package/dist/unstable/eventlog/EventLog.js.map +1 -1
  898. package/dist/unstable/eventlog/EventLogEncryption.d.ts +42 -6
  899. package/dist/unstable/eventlog/EventLogEncryption.d.ts.map +1 -1
  900. package/dist/unstable/eventlog/EventLogEncryption.js +38 -5
  901. package/dist/unstable/eventlog/EventLogEncryption.js.map +1 -1
  902. package/dist/unstable/eventlog/EventLogMessage.d.ts +92 -18
  903. package/dist/unstable/eventlog/EventLogMessage.d.ts.map +1 -1
  904. package/dist/unstable/eventlog/EventLogMessage.js +72 -16
  905. package/dist/unstable/eventlog/EventLogMessage.js.map +1 -1
  906. package/dist/unstable/eventlog/EventLogRemote.d.ts +35 -8
  907. package/dist/unstable/eventlog/EventLogRemote.d.ts.map +1 -1
  908. package/dist/unstable/eventlog/EventLogRemote.js +54 -8
  909. package/dist/unstable/eventlog/EventLogRemote.js.map +1 -1
  910. package/dist/unstable/eventlog/EventLogServer.d.ts +17 -3
  911. package/dist/unstable/eventlog/EventLogServer.d.ts.map +1 -1
  912. package/dist/unstable/eventlog/EventLogServer.js +17 -3
  913. package/dist/unstable/eventlog/EventLogServer.js.map +1 -1
  914. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts +32 -6
  915. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts.map +1 -1
  916. package/dist/unstable/eventlog/EventLogServerEncrypted.js +52 -6
  917. package/dist/unstable/eventlog/EventLogServerEncrypted.js.map +1 -1
  918. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +74 -16
  919. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts.map +1 -1
  920. package/dist/unstable/eventlog/EventLogServerUnencrypted.js +90 -16
  921. package/dist/unstable/eventlog/EventLogServerUnencrypted.js.map +1 -1
  922. package/dist/unstable/eventlog/EventLogSessionAuth.d.ts +59 -15
  923. package/dist/unstable/eventlog/EventLogSessionAuth.d.ts.map +1 -1
  924. package/dist/unstable/eventlog/EventLogSessionAuth.js +73 -14
  925. package/dist/unstable/eventlog/EventLogSessionAuth.js.map +1 -1
  926. package/dist/unstable/eventlog/SqlEventJournal.d.ts +10 -2
  927. package/dist/unstable/eventlog/SqlEventJournal.d.ts.map +1 -1
  928. package/dist/unstable/eventlog/SqlEventJournal.js +28 -2
  929. package/dist/unstable/eventlog/SqlEventJournal.js.map +1 -1
  930. package/dist/unstable/eventlog/SqlEventLogServerEncrypted.d.ts +32 -3
  931. package/dist/unstable/eventlog/SqlEventLogServerEncrypted.d.ts.map +1 -1
  932. package/dist/unstable/eventlog/SqlEventLogServerEncrypted.js +32 -3
  933. package/dist/unstable/eventlog/SqlEventLogServerEncrypted.js.map +1 -1
  934. package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.d.ts +10 -2
  935. package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.d.ts.map +1 -1
  936. package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.js +28 -2
  937. package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.js.map +1 -1
  938. package/dist/unstable/eventlog/index.d.ts +240 -0
  939. package/dist/unstable/eventlog/index.d.ts.map +1 -1
  940. package/dist/unstable/eventlog/index.js +240 -0
  941. package/dist/unstable/eventlog/index.js.map +1 -1
  942. package/dist/unstable/http/Cookies.d.ts +156 -77
  943. package/dist/unstable/http/Cookies.d.ts.map +1 -1
  944. package/dist/unstable/http/Cookies.js +93 -39
  945. package/dist/unstable/http/Cookies.js.map +1 -1
  946. package/dist/unstable/http/Etag.d.ts +40 -7
  947. package/dist/unstable/http/Etag.d.ts.map +1 -1
  948. package/dist/unstable/http/Etag.js +27 -4
  949. package/dist/unstable/http/Etag.js.map +1 -1
  950. package/dist/unstable/http/FetchHttpClient.d.ts +29 -3
  951. package/dist/unstable/http/FetchHttpClient.d.ts.map +1 -1
  952. package/dist/unstable/http/FetchHttpClient.js +33 -4
  953. package/dist/unstable/http/FetchHttpClient.js.map +1 -1
  954. package/dist/unstable/http/FindMyWay.d.ts +1 -1
  955. package/dist/unstable/http/FindMyWay.js +1 -1
  956. package/dist/unstable/http/Headers.d.ts +182 -36
  957. package/dist/unstable/http/Headers.d.ts.map +1 -1
  958. package/dist/unstable/http/Headers.js +86 -16
  959. package/dist/unstable/http/Headers.js.map +1 -1
  960. package/dist/unstable/http/HttpBody.d.ts +114 -26
  961. package/dist/unstable/http/HttpBody.d.ts.map +1 -1
  962. package/dist/unstable/http/HttpBody.js +98 -20
  963. package/dist/unstable/http/HttpBody.js.map +1 -1
  964. package/dist/unstable/http/HttpClient.d.ts +204 -96
  965. package/dist/unstable/http/HttpClient.d.ts.map +1 -1
  966. package/dist/unstable/http/HttpClient.js +85 -38
  967. package/dist/unstable/http/HttpClient.js.map +1 -1
  968. package/dist/unstable/http/HttpClientError.d.ts +68 -12
  969. package/dist/unstable/http/HttpClientError.d.ts.map +1 -1
  970. package/dist/unstable/http/HttpClientError.js +71 -9
  971. package/dist/unstable/http/HttpClientError.js.map +1 -1
  972. package/dist/unstable/http/HttpClientRequest.d.ts +318 -100
  973. package/dist/unstable/http/HttpClientRequest.d.ts.map +1 -1
  974. package/dist/unstable/http/HttpClientRequest.js +151 -45
  975. package/dist/unstable/http/HttpClientRequest.js.map +1 -1
  976. package/dist/unstable/http/HttpClientResponse.d.ts +59 -16
  977. package/dist/unstable/http/HttpClientResponse.d.ts.map +1 -1
  978. package/dist/unstable/http/HttpClientResponse.js +44 -11
  979. package/dist/unstable/http/HttpClientResponse.js.map +1 -1
  980. package/dist/unstable/http/HttpEffect.d.ts +42 -16
  981. package/dist/unstable/http/HttpEffect.d.ts.map +1 -1
  982. package/dist/unstable/http/HttpEffect.js +33 -13
  983. package/dist/unstable/http/HttpEffect.js.map +1 -1
  984. package/dist/unstable/http/HttpIncomingMessage.d.ts +48 -7
  985. package/dist/unstable/http/HttpIncomingMessage.d.ts.map +1 -1
  986. package/dist/unstable/http/HttpIncomingMessage.js +45 -6
  987. package/dist/unstable/http/HttpIncomingMessage.js.map +1 -1
  988. package/dist/unstable/http/HttpMethod.d.ts +38 -6
  989. package/dist/unstable/http/HttpMethod.d.ts.map +1 -1
  990. package/dist/unstable/http/HttpMethod.js +27 -2
  991. package/dist/unstable/http/HttpMethod.js.map +1 -1
  992. package/dist/unstable/http/HttpMiddleware.d.ts +38 -11
  993. package/dist/unstable/http/HttpMiddleware.d.ts.map +1 -1
  994. package/dist/unstable/http/HttpMiddleware.js +52 -10
  995. package/dist/unstable/http/HttpMiddleware.js.map +1 -1
  996. package/dist/unstable/http/HttpPlatform.d.ts +34 -3
  997. package/dist/unstable/http/HttpPlatform.d.ts.map +1 -1
  998. package/dist/unstable/http/HttpPlatform.js +34 -3
  999. package/dist/unstable/http/HttpPlatform.js.map +1 -1
  1000. package/dist/unstable/http/HttpRouter.d.ts +209 -62
  1001. package/dist/unstable/http/HttpRouter.d.ts.map +1 -1
  1002. package/dist/unstable/http/HttpRouter.js +136 -41
  1003. package/dist/unstable/http/HttpRouter.js.map +1 -1
  1004. package/dist/unstable/http/HttpServer.d.ts +151 -22
  1005. package/dist/unstable/http/HttpServer.d.ts.map +1 -1
  1006. package/dist/unstable/http/HttpServer.js +76 -11
  1007. package/dist/unstable/http/HttpServer.js.map +1 -1
  1008. package/dist/unstable/http/HttpServerError.d.ts +93 -10
  1009. package/dist/unstable/http/HttpServerError.d.ts.map +1 -1
  1010. package/dist/unstable/http/HttpServerError.js +85 -8
  1011. package/dist/unstable/http/HttpServerError.js.map +1 -1
  1012. package/dist/unstable/http/HttpServerRequest.d.ts +125 -21
  1013. package/dist/unstable/http/HttpServerRequest.d.ts.map +1 -1
  1014. package/dist/unstable/http/HttpServerRequest.js +101 -20
  1015. package/dist/unstable/http/HttpServerRequest.js.map +1 -1
  1016. package/dist/unstable/http/HttpServerRespondable.d.ts +32 -6
  1017. package/dist/unstable/http/HttpServerRespondable.d.ts.map +1 -1
  1018. package/dist/unstable/http/HttpServerRespondable.js +43 -5
  1019. package/dist/unstable/http/HttpServerRespondable.js.map +1 -1
  1020. package/dist/unstable/http/HttpServerResponse.d.ts +391 -67
  1021. package/dist/unstable/http/HttpServerResponse.d.ts.map +1 -1
  1022. package/dist/unstable/http/HttpServerResponse.js +205 -33
  1023. package/dist/unstable/http/HttpServerResponse.js.map +1 -1
  1024. package/dist/unstable/http/HttpStaticServer.d.ts +24 -8
  1025. package/dist/unstable/http/HttpStaticServer.d.ts.map +1 -1
  1026. package/dist/unstable/http/HttpStaticServer.js +24 -8
  1027. package/dist/unstable/http/HttpStaticServer.js.map +1 -1
  1028. package/dist/unstable/http/HttpTraceContext.d.ts +53 -6
  1029. package/dist/unstable/http/HttpTraceContext.d.ts.map +1 -1
  1030. package/dist/unstable/http/HttpTraceContext.js +47 -5
  1031. package/dist/unstable/http/HttpTraceContext.js.map +1 -1
  1032. package/dist/unstable/http/Multipart.d.ts +179 -28
  1033. package/dist/unstable/http/Multipart.d.ts.map +1 -1
  1034. package/dist/unstable/http/Multipart.js +131 -19
  1035. package/dist/unstable/http/Multipart.js.map +1 -1
  1036. package/dist/unstable/http/Multipasta/HeadersParser.d.ts +1 -1
  1037. package/dist/unstable/http/Multipasta/HeadersParser.js +1 -1
  1038. package/dist/unstable/http/Multipasta/Node.d.ts +1 -1
  1039. package/dist/unstable/http/Multipasta/Node.js +1 -1
  1040. package/dist/unstable/http/Multipasta/Search.d.ts +1 -1
  1041. package/dist/unstable/http/Multipasta/Search.js +1 -1
  1042. package/dist/unstable/http/Multipasta/Web.d.ts +1 -1
  1043. package/dist/unstable/http/Multipasta/Web.js +1 -1
  1044. package/dist/unstable/http/Multipasta.d.ts +1 -1
  1045. package/dist/unstable/http/Multipasta.js +1 -1
  1046. package/dist/unstable/http/Template.d.ts +53 -1
  1047. package/dist/unstable/http/Template.d.ts.map +1 -1
  1048. package/dist/unstable/http/Template.js +26 -0
  1049. package/dist/unstable/http/Template.js.map +1 -1
  1050. package/dist/unstable/http/Url.d.ts +70 -56
  1051. package/dist/unstable/http/Url.d.ts.map +1 -1
  1052. package/dist/unstable/http/Url.js +35 -21
  1053. package/dist/unstable/http/Url.js.map +1 -1
  1054. package/dist/unstable/http/UrlParams.d.ts +237 -51
  1055. package/dist/unstable/http/UrlParams.d.ts.map +1 -1
  1056. package/dist/unstable/http/UrlParams.js +120 -25
  1057. package/dist/unstable/http/UrlParams.js.map +1 -1
  1058. package/dist/unstable/http/index.d.ts +452 -0
  1059. package/dist/unstable/http/index.d.ts.map +1 -1
  1060. package/dist/unstable/http/index.js +452 -0
  1061. package/dist/unstable/http/index.js.map +1 -1
  1062. package/dist/unstable/httpapi/HttpApi.d.ts +49 -14
  1063. package/dist/unstable/httpapi/HttpApi.d.ts.map +1 -1
  1064. package/dist/unstable/httpapi/HttpApi.js +14 -8
  1065. package/dist/unstable/httpapi/HttpApi.js.map +1 -1
  1066. package/dist/unstable/httpapi/HttpApiBuilder.d.ts +54 -16
  1067. package/dist/unstable/httpapi/HttpApiBuilder.d.ts.map +1 -1
  1068. package/dist/unstable/httpapi/HttpApiBuilder.js +44 -6
  1069. package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
  1070. package/dist/unstable/httpapi/HttpApiClient.d.ts +57 -15
  1071. package/dist/unstable/httpapi/HttpApiClient.d.ts.map +1 -1
  1072. package/dist/unstable/httpapi/HttpApiClient.js +42 -6
  1073. package/dist/unstable/httpapi/HttpApiClient.js.map +1 -1
  1074. package/dist/unstable/httpapi/HttpApiEndpoint.d.ts +214 -59
  1075. package/dist/unstable/httpapi/HttpApiEndpoint.d.ts.map +1 -1
  1076. package/dist/unstable/httpapi/HttpApiEndpoint.js +53 -9
  1077. package/dist/unstable/httpapi/HttpApiEndpoint.js.map +1 -1
  1078. package/dist/unstable/httpapi/HttpApiError.d.ts +81 -1
  1079. package/dist/unstable/httpapi/HttpApiError.d.ts.map +1 -1
  1080. package/dist/unstable/httpapi/HttpApiError.js +98 -1
  1081. package/dist/unstable/httpapi/HttpApiError.js.map +1 -1
  1082. package/dist/unstable/httpapi/HttpApiGroup.d.ts +87 -20
  1083. package/dist/unstable/httpapi/HttpApiGroup.d.ts.map +1 -1
  1084. package/dist/unstable/httpapi/HttpApiGroup.js +5 -2
  1085. package/dist/unstable/httpapi/HttpApiGroup.js.map +1 -1
  1086. package/dist/unstable/httpapi/HttpApiMiddleware.d.ts +113 -22
  1087. package/dist/unstable/httpapi/HttpApiMiddleware.d.ts.map +1 -1
  1088. package/dist/unstable/httpapi/HttpApiMiddleware.js +49 -5
  1089. package/dist/unstable/httpapi/HttpApiMiddleware.js.map +1 -1
  1090. package/dist/unstable/httpapi/HttpApiScalar.d.ts +19 -4
  1091. package/dist/unstable/httpapi/HttpApiScalar.d.ts.map +1 -1
  1092. package/dist/unstable/httpapi/HttpApiScalar.js +32 -2
  1093. package/dist/unstable/httpapi/HttpApiScalar.js.map +1 -1
  1094. package/dist/unstable/httpapi/HttpApiSchema.d.ts +86 -38
  1095. package/dist/unstable/httpapi/HttpApiSchema.d.ts.map +1 -1
  1096. package/dist/unstable/httpapi/HttpApiSchema.js +59 -35
  1097. package/dist/unstable/httpapi/HttpApiSchema.js.map +1 -1
  1098. package/dist/unstable/httpapi/HttpApiSecurity.d.ts +73 -17
  1099. package/dist/unstable/httpapi/HttpApiSecurity.d.ts.map +1 -1
  1100. package/dist/unstable/httpapi/HttpApiSecurity.js +38 -5
  1101. package/dist/unstable/httpapi/HttpApiSecurity.js.map +1 -1
  1102. package/dist/unstable/httpapi/HttpApiSwagger.d.ts +4 -3
  1103. package/dist/unstable/httpapi/HttpApiSwagger.d.ts.map +1 -1
  1104. package/dist/unstable/httpapi/HttpApiSwagger.js +23 -3
  1105. package/dist/unstable/httpapi/HttpApiSwagger.js.map +1 -1
  1106. package/dist/unstable/httpapi/HttpApiTest.d.ts +6 -1
  1107. package/dist/unstable/httpapi/HttpApiTest.d.ts.map +1 -1
  1108. package/dist/unstable/httpapi/HttpApiTest.js +26 -1
  1109. package/dist/unstable/httpapi/HttpApiTest.js.map +1 -1
  1110. package/dist/unstable/httpapi/OpenApi.d.ts +86 -15
  1111. package/dist/unstable/httpapi/OpenApi.d.ts.map +1 -1
  1112. package/dist/unstable/httpapi/OpenApi.js +73 -15
  1113. package/dist/unstable/httpapi/OpenApi.js.map +1 -1
  1114. package/dist/unstable/httpapi/index.d.ts +310 -25
  1115. package/dist/unstable/httpapi/index.d.ts.map +1 -1
  1116. package/dist/unstable/httpapi/index.js +310 -25
  1117. package/dist/unstable/httpapi/index.js.map +1 -1
  1118. package/dist/unstable/observability/Otlp.d.ts +33 -3
  1119. package/dist/unstable/observability/Otlp.d.ts.map +1 -1
  1120. package/dist/unstable/observability/Otlp.js +14 -3
  1121. package/dist/unstable/observability/Otlp.js.map +1 -1
  1122. package/dist/unstable/observability/OtlpExporter.d.ts +8 -1
  1123. package/dist/unstable/observability/OtlpExporter.d.ts.map +1 -1
  1124. package/dist/unstable/observability/OtlpExporter.js +32 -1
  1125. package/dist/unstable/observability/OtlpExporter.js.map +1 -1
  1126. package/dist/unstable/observability/OtlpLogger.d.ts +15 -2
  1127. package/dist/unstable/observability/OtlpLogger.d.ts.map +1 -1
  1128. package/dist/unstable/observability/OtlpLogger.js +29 -2
  1129. package/dist/unstable/observability/OtlpLogger.js.map +1 -1
  1130. package/dist/unstable/observability/OtlpMetrics.d.ts +17 -5
  1131. package/dist/unstable/observability/OtlpMetrics.d.ts.map +1 -1
  1132. package/dist/unstable/observability/OtlpMetrics.js +32 -2
  1133. package/dist/unstable/observability/OtlpMetrics.js.map +1 -1
  1134. package/dist/unstable/observability/OtlpResource.d.ts +49 -12
  1135. package/dist/unstable/observability/OtlpResource.d.ts.map +1 -1
  1136. package/dist/unstable/observability/OtlpResource.js +47 -5
  1137. package/dist/unstable/observability/OtlpResource.js.map +1 -1
  1138. package/dist/unstable/observability/OtlpSerialization.d.ts +28 -3
  1139. package/dist/unstable/observability/OtlpSerialization.d.ts.map +1 -1
  1140. package/dist/unstable/observability/OtlpSerialization.js +28 -3
  1141. package/dist/unstable/observability/OtlpSerialization.js.map +1 -1
  1142. package/dist/unstable/observability/OtlpTracer.d.ts +19 -2
  1143. package/dist/unstable/observability/OtlpTracer.d.ts.map +1 -1
  1144. package/dist/unstable/observability/OtlpTracer.js +32 -2
  1145. package/dist/unstable/observability/OtlpTracer.js.map +1 -1
  1146. package/dist/unstable/observability/PrometheusMetrics.d.ts +36 -16
  1147. package/dist/unstable/observability/PrometheusMetrics.d.ts.map +1 -1
  1148. package/dist/unstable/observability/PrometheusMetrics.js +9 -7
  1149. package/dist/unstable/observability/PrometheusMetrics.js.map +1 -1
  1150. package/dist/unstable/observability/index.d.ts +160 -3
  1151. package/dist/unstable/observability/index.d.ts.map +1 -1
  1152. package/dist/unstable/observability/index.js +160 -3
  1153. package/dist/unstable/observability/index.js.map +1 -1
  1154. package/dist/unstable/persistence/KeyValueStore.d.ts +93 -18
  1155. package/dist/unstable/persistence/KeyValueStore.d.ts.map +1 -1
  1156. package/dist/unstable/persistence/KeyValueStore.js +81 -21
  1157. package/dist/unstable/persistence/KeyValueStore.js.map +1 -1
  1158. package/dist/unstable/persistence/Persistable.d.ts +76 -15
  1159. package/dist/unstable/persistence/Persistable.d.ts.map +1 -1
  1160. package/dist/unstable/persistence/Persistable.js +22 -5
  1161. package/dist/unstable/persistence/Persistable.js.map +1 -1
  1162. package/dist/unstable/persistence/PersistedCache.d.ts +27 -2
  1163. package/dist/unstable/persistence/PersistedCache.d.ts.map +1 -1
  1164. package/dist/unstable/persistence/PersistedCache.js +24 -1
  1165. package/dist/unstable/persistence/PersistedCache.js.map +1 -1
  1166. package/dist/unstable/persistence/PersistedQueue.d.ts +73 -16
  1167. package/dist/unstable/persistence/PersistedQueue.d.ts.map +1 -1
  1168. package/dist/unstable/persistence/PersistedQueue.js +60 -13
  1169. package/dist/unstable/persistence/PersistedQueue.js.map +1 -1
  1170. package/dist/unstable/persistence/Persistence.d.ts +98 -16
  1171. package/dist/unstable/persistence/Persistence.d.ts.map +1 -1
  1172. package/dist/unstable/persistence/Persistence.js +91 -14
  1173. package/dist/unstable/persistence/Persistence.js.map +1 -1
  1174. package/dist/unstable/persistence/RateLimiter.d.ts +101 -21
  1175. package/dist/unstable/persistence/RateLimiter.d.ts.map +1 -1
  1176. package/dist/unstable/persistence/RateLimiter.js +85 -16
  1177. package/dist/unstable/persistence/RateLimiter.js.map +1 -1
  1178. package/dist/unstable/persistence/Redis.d.ts +26 -5
  1179. package/dist/unstable/persistence/Redis.d.ts.map +1 -1
  1180. package/dist/unstable/persistence/Redis.js +36 -4
  1181. package/dist/unstable/persistence/Redis.js.map +1 -1
  1182. package/dist/unstable/persistence/index.d.ts +147 -0
  1183. package/dist/unstable/persistence/index.d.ts.map +1 -1
  1184. package/dist/unstable/persistence/index.js +147 -0
  1185. package/dist/unstable/persistence/index.js.map +1 -1
  1186. package/dist/unstable/process/ChildProcess.d.ts +87 -64
  1187. package/dist/unstable/process/ChildProcess.d.ts.map +1 -1
  1188. package/dist/unstable/process/ChildProcess.js +25 -18
  1189. package/dist/unstable/process/ChildProcess.js.map +1 -1
  1190. package/dist/unstable/process/ChildProcessSpawner.d.ts +23 -12
  1191. package/dist/unstable/process/ChildProcessSpawner.d.ts.map +1 -1
  1192. package/dist/unstable/process/ChildProcessSpawner.js +11 -6
  1193. package/dist/unstable/process/ChildProcessSpawner.js.map +1 -1
  1194. package/dist/unstable/process/index.d.ts +2 -1
  1195. package/dist/unstable/process/index.d.ts.map +1 -1
  1196. package/dist/unstable/process/index.js +2 -1
  1197. package/dist/unstable/process/index.js.map +1 -1
  1198. package/dist/unstable/reactivity/AsyncResult.d.ts +198 -59
  1199. package/dist/unstable/reactivity/AsyncResult.d.ts.map +1 -1
  1200. package/dist/unstable/reactivity/AsyncResult.js +121 -36
  1201. package/dist/unstable/reactivity/AsyncResult.js.map +1 -1
  1202. package/dist/unstable/reactivity/Atom.d.ts +544 -130
  1203. package/dist/unstable/reactivity/Atom.d.ts.map +1 -1
  1204. package/dist/unstable/reactivity/Atom.js +252 -58
  1205. package/dist/unstable/reactivity/Atom.js.map +1 -1
  1206. package/dist/unstable/reactivity/AtomHttpApi.d.ts +41 -2
  1207. package/dist/unstable/reactivity/AtomHttpApi.d.ts.map +1 -1
  1208. package/dist/unstable/reactivity/AtomHttpApi.js +35 -1
  1209. package/dist/unstable/reactivity/AtomHttpApi.js.map +1 -1
  1210. package/dist/unstable/reactivity/AtomRef.d.ts +51 -7
  1211. package/dist/unstable/reactivity/AtomRef.d.ts.map +1 -1
  1212. package/dist/unstable/reactivity/AtomRef.js +29 -3
  1213. package/dist/unstable/reactivity/AtomRef.js.map +1 -1
  1214. package/dist/unstable/reactivity/AtomRegistry.d.ts +135 -21
  1215. package/dist/unstable/reactivity/AtomRegistry.d.ts.map +1 -1
  1216. package/dist/unstable/reactivity/AtomRegistry.js +69 -10
  1217. package/dist/unstable/reactivity/AtomRegistry.js.map +1 -1
  1218. package/dist/unstable/reactivity/AtomRpc.d.ts +36 -2
  1219. package/dist/unstable/reactivity/AtomRpc.d.ts.map +1 -1
  1220. package/dist/unstable/reactivity/AtomRpc.js +29 -1
  1221. package/dist/unstable/reactivity/AtomRpc.js.map +1 -1
  1222. package/dist/unstable/reactivity/Hydration.d.ts +28 -5
  1223. package/dist/unstable/reactivity/Hydration.d.ts.map +1 -1
  1224. package/dist/unstable/reactivity/Hydration.js +35 -3
  1225. package/dist/unstable/reactivity/Hydration.js.map +1 -1
  1226. package/dist/unstable/reactivity/Reactivity.d.ts +94 -13
  1227. package/dist/unstable/reactivity/Reactivity.d.ts.map +1 -1
  1228. package/dist/unstable/reactivity/Reactivity.js +60 -7
  1229. package/dist/unstable/reactivity/Reactivity.js.map +1 -1
  1230. package/dist/unstable/reactivity/index.d.ts +167 -0
  1231. package/dist/unstable/reactivity/index.d.ts.map +1 -1
  1232. package/dist/unstable/reactivity/index.js +167 -0
  1233. package/dist/unstable/reactivity/index.js.map +1 -1
  1234. package/dist/unstable/rpc/Rpc.d.ts +254 -56
  1235. package/dist/unstable/rpc/Rpc.d.ts.map +1 -1
  1236. package/dist/unstable/rpc/Rpc.js +44 -11
  1237. package/dist/unstable/rpc/Rpc.js.map +1 -1
  1238. package/dist/unstable/rpc/RpcClient.d.ts +80 -19
  1239. package/dist/unstable/rpc/RpcClient.d.ts.map +1 -1
  1240. package/dist/unstable/rpc/RpcClient.js +52 -12
  1241. package/dist/unstable/rpc/RpcClient.js.map +1 -1
  1242. package/dist/unstable/rpc/RpcClientError.d.ts +26 -2
  1243. package/dist/unstable/rpc/RpcClientError.d.ts.map +1 -1
  1244. package/dist/unstable/rpc/RpcClientError.js +26 -2
  1245. package/dist/unstable/rpc/RpcClientError.js.map +1 -1
  1246. package/dist/unstable/rpc/RpcGroup.d.ts +51 -8
  1247. package/dist/unstable/rpc/RpcGroup.d.ts.map +1 -1
  1248. package/dist/unstable/rpc/RpcGroup.js +3 -1
  1249. package/dist/unstable/rpc/RpcGroup.js.map +1 -1
  1250. package/dist/unstable/rpc/RpcMessage.d.ts +128 -32
  1251. package/dist/unstable/rpc/RpcMessage.d.ts.map +1 -1
  1252. package/dist/unstable/rpc/RpcMessage.js +23 -7
  1253. package/dist/unstable/rpc/RpcMessage.js.map +1 -1
  1254. package/dist/unstable/rpc/RpcMiddleware.d.ts +100 -20
  1255. package/dist/unstable/rpc/RpcMiddleware.d.ts.map +1 -1
  1256. package/dist/unstable/rpc/RpcMiddleware.js +39 -3
  1257. package/dist/unstable/rpc/RpcMiddleware.js.map +1 -1
  1258. package/dist/unstable/rpc/RpcSchema.d.ts +38 -4
  1259. package/dist/unstable/rpc/RpcSchema.d.ts.map +1 -1
  1260. package/dist/unstable/rpc/RpcSchema.js +34 -3
  1261. package/dist/unstable/rpc/RpcSchema.js.map +1 -1
  1262. package/dist/unstable/rpc/RpcSerialization.d.ts +60 -13
  1263. package/dist/unstable/rpc/RpcSerialization.d.ts.map +1 -1
  1264. package/dist/unstable/rpc/RpcSerialization.js +56 -12
  1265. package/dist/unstable/rpc/RpcSerialization.js.map +1 -1
  1266. package/dist/unstable/rpc/RpcServer.d.ts +73 -23
  1267. package/dist/unstable/rpc/RpcServer.d.ts.map +1 -1
  1268. package/dist/unstable/rpc/RpcServer.js +69 -22
  1269. package/dist/unstable/rpc/RpcServer.js.map +1 -1
  1270. package/dist/unstable/rpc/RpcTest.d.ts +20 -1
  1271. package/dist/unstable/rpc/RpcTest.d.ts.map +1 -1
  1272. package/dist/unstable/rpc/RpcTest.js +20 -1
  1273. package/dist/unstable/rpc/RpcTest.js.map +1 -1
  1274. package/dist/unstable/rpc/RpcWorker.d.ts +39 -6
  1275. package/dist/unstable/rpc/RpcWorker.d.ts.map +1 -1
  1276. package/dist/unstable/rpc/RpcWorker.js +16 -4
  1277. package/dist/unstable/rpc/RpcWorker.js.map +1 -1
  1278. package/dist/unstable/rpc/Utils.d.ts +10 -0
  1279. package/dist/unstable/rpc/Utils.d.ts.map +1 -1
  1280. package/dist/unstable/rpc/Utils.js +10 -0
  1281. package/dist/unstable/rpc/Utils.js.map +1 -1
  1282. package/dist/unstable/rpc/index.d.ts +272 -0
  1283. package/dist/unstable/rpc/index.d.ts.map +1 -1
  1284. package/dist/unstable/rpc/index.js +272 -0
  1285. package/dist/unstable/rpc/index.js.map +1 -1
  1286. package/dist/unstable/schema/Model.d.ts +192 -59
  1287. package/dist/unstable/schema/Model.d.ts.map +1 -1
  1288. package/dist/unstable/schema/Model.js +122 -38
  1289. package/dist/unstable/schema/Model.js.map +1 -1
  1290. package/dist/unstable/schema/VariantSchema.d.ts +101 -24
  1291. package/dist/unstable/schema/VariantSchema.d.ts.map +1 -1
  1292. package/dist/unstable/schema/VariantSchema.js +22 -6
  1293. package/dist/unstable/schema/VariantSchema.js.map +1 -1
  1294. package/dist/unstable/schema/index.d.ts +37 -0
  1295. package/dist/unstable/schema/index.d.ts.map +1 -1
  1296. package/dist/unstable/schema/index.js +37 -0
  1297. package/dist/unstable/schema/index.js.map +1 -1
  1298. package/dist/unstable/socket/Socket.d.ts +168 -34
  1299. package/dist/unstable/socket/Socket.d.ts.map +1 -1
  1300. package/dist/unstable/socket/Socket.js +124 -28
  1301. package/dist/unstable/socket/Socket.js.map +1 -1
  1302. package/dist/unstable/socket/SocketServer.d.ts +58 -10
  1303. package/dist/unstable/socket/SocketServer.d.ts.map +1 -1
  1304. package/dist/unstable/socket/SocketServer.js +43 -5
  1305. package/dist/unstable/socket/SocketServer.js.map +1 -1
  1306. package/dist/unstable/socket/index.d.ts +44 -0
  1307. package/dist/unstable/socket/index.d.ts.map +1 -1
  1308. package/dist/unstable/socket/index.js +44 -0
  1309. package/dist/unstable/socket/index.js.map +1 -1
  1310. package/dist/unstable/sql/Migrator.d.ts +40 -9
  1311. package/dist/unstable/sql/Migrator.d.ts.map +1 -1
  1312. package/dist/unstable/sql/Migrator.js +45 -5
  1313. package/dist/unstable/sql/Migrator.js.map +1 -1
  1314. package/dist/unstable/sql/SqlClient.d.ts +38 -2
  1315. package/dist/unstable/sql/SqlClient.d.ts.map +1 -1
  1316. package/dist/unstable/sql/SqlClient.js +40 -1
  1317. package/dist/unstable/sql/SqlClient.js.map +1 -1
  1318. package/dist/unstable/sql/SqlConnection.d.ts +34 -3
  1319. package/dist/unstable/sql/SqlConnection.d.ts.map +1 -1
  1320. package/dist/unstable/sql/SqlConnection.js +22 -0
  1321. package/dist/unstable/sql/SqlConnection.js.map +1 -1
  1322. package/dist/unstable/sql/SqlError.d.ts +117 -0
  1323. package/dist/unstable/sql/SqlError.d.ts.map +1 -1
  1324. package/dist/unstable/sql/SqlError.js +131 -0
  1325. package/dist/unstable/sql/SqlError.js.map +1 -1
  1326. package/dist/unstable/sql/SqlModel.d.ts +25 -5
  1327. package/dist/unstable/sql/SqlModel.d.ts.map +1 -1
  1328. package/dist/unstable/sql/SqlModel.js +8 -4
  1329. package/dist/unstable/sql/SqlModel.js.map +1 -1
  1330. package/dist/unstable/sql/SqlResolver.d.ts +56 -13
  1331. package/dist/unstable/sql/SqlResolver.d.ts.map +1 -1
  1332. package/dist/unstable/sql/SqlResolver.js +44 -10
  1333. package/dist/unstable/sql/SqlResolver.js.map +1 -1
  1334. package/dist/unstable/sql/SqlSchema.d.ts +29 -8
  1335. package/dist/unstable/sql/SqlSchema.d.ts.map +1 -1
  1336. package/dist/unstable/sql/SqlSchema.js +29 -8
  1337. package/dist/unstable/sql/SqlSchema.js.map +1 -1
  1338. package/dist/unstable/sql/SqlStream.d.ts +4 -0
  1339. package/dist/unstable/sql/SqlStream.d.ts.map +1 -1
  1340. package/dist/unstable/sql/SqlStream.js +24 -0
  1341. package/dist/unstable/sql/SqlStream.js.map +1 -1
  1342. package/dist/unstable/sql/Statement.d.ts +151 -24
  1343. package/dist/unstable/sql/Statement.d.ts.map +1 -1
  1344. package/dist/unstable/sql/Statement.js +91 -6
  1345. package/dist/unstable/sql/Statement.js.map +1 -1
  1346. package/dist/unstable/sql/index.d.ts +179 -1
  1347. package/dist/unstable/sql/index.d.ts.map +1 -1
  1348. package/dist/unstable/sql/index.js +179 -1
  1349. package/dist/unstable/sql/index.js.map +1 -1
  1350. package/dist/unstable/workers/Transferable.d.ts +72 -20
  1351. package/dist/unstable/workers/Transferable.d.ts.map +1 -1
  1352. package/dist/unstable/workers/Transferable.js +57 -14
  1353. package/dist/unstable/workers/Transferable.js.map +1 -1
  1354. package/dist/unstable/workers/Worker.d.ts +61 -8
  1355. package/dist/unstable/workers/Worker.d.ts.map +1 -1
  1356. package/dist/unstable/workers/Worker.js +44 -4
  1357. package/dist/unstable/workers/Worker.js.map +1 -1
  1358. package/dist/unstable/workers/WorkerError.d.ts +31 -9
  1359. package/dist/unstable/workers/WorkerError.d.ts.map +1 -1
  1360. package/dist/unstable/workers/WorkerError.js +44 -7
  1361. package/dist/unstable/workers/WorkerError.js.map +1 -1
  1362. package/dist/unstable/workers/WorkerRunner.d.ts +32 -3
  1363. package/dist/unstable/workers/WorkerRunner.d.ts.map +1 -1
  1364. package/dist/unstable/workers/WorkerRunner.js +24 -1
  1365. package/dist/unstable/workers/WorkerRunner.js.map +1 -1
  1366. package/dist/unstable/workers/index.d.ts +81 -1
  1367. package/dist/unstable/workers/index.d.ts.map +1 -1
  1368. package/dist/unstable/workers/index.js +81 -1
  1369. package/dist/unstable/workers/index.js.map +1 -1
  1370. package/dist/unstable/workflow/Activity.d.ts +61 -10
  1371. package/dist/unstable/workflow/Activity.d.ts.map +1 -1
  1372. package/dist/unstable/workflow/Activity.js +20 -5
  1373. package/dist/unstable/workflow/Activity.js.map +1 -1
  1374. package/dist/unstable/workflow/DurableClock.d.ts +12 -3
  1375. package/dist/unstable/workflow/DurableClock.d.ts.map +1 -1
  1376. package/dist/unstable/workflow/DurableClock.js +22 -2
  1377. package/dist/unstable/workflow/DurableClock.js.map +1 -1
  1378. package/dist/unstable/workflow/DurableDeferred.d.ts +128 -31
  1379. package/dist/unstable/workflow/DurableDeferred.d.ts.map +1 -1
  1380. package/dist/unstable/workflow/DurableDeferred.js +77 -13
  1381. package/dist/unstable/workflow/DurableDeferred.js.map +1 -1
  1382. package/dist/unstable/workflow/DurableQueue.d.ts +33 -8
  1383. package/dist/unstable/workflow/DurableQueue.d.ts.map +1 -1
  1384. package/dist/unstable/workflow/DurableQueue.js +26 -6
  1385. package/dist/unstable/workflow/DurableQueue.js.map +1 -1
  1386. package/dist/unstable/workflow/Workflow.d.ts +102 -31
  1387. package/dist/unstable/workflow/Workflow.d.ts.map +1 -1
  1388. package/dist/unstable/workflow/Workflow.js +75 -19
  1389. package/dist/unstable/workflow/Workflow.js.map +1 -1
  1390. package/dist/unstable/workflow/WorkflowEngine.d.ts +40 -5
  1391. package/dist/unstable/workflow/WorkflowEngine.d.ts.map +1 -1
  1392. package/dist/unstable/workflow/WorkflowEngine.js +16 -4
  1393. package/dist/unstable/workflow/WorkflowEngine.js.map +1 -1
  1394. package/dist/unstable/workflow/WorkflowProxy.d.ts +40 -12
  1395. package/dist/unstable/workflow/WorkflowProxy.d.ts.map +1 -1
  1396. package/dist/unstable/workflow/WorkflowProxy.js +8 -12
  1397. package/dist/unstable/workflow/WorkflowProxy.js.map +1 -1
  1398. package/dist/unstable/workflow/WorkflowProxyServer.d.ts +37 -2
  1399. package/dist/unstable/workflow/WorkflowProxyServer.d.ts.map +1 -1
  1400. package/dist/unstable/workflow/WorkflowProxyServer.js +12 -6
  1401. package/dist/unstable/workflow/WorkflowProxyServer.js.map +1 -1
  1402. package/dist/unstable/workflow/index.d.ts +160 -0
  1403. package/dist/unstable/workflow/index.d.ts.map +1 -1
  1404. package/dist/unstable/workflow/index.js +160 -0
  1405. package/dist/unstable/workflow/index.js.map +1 -1
  1406. package/package.json +11 -11
  1407. package/src/Array.ts +151 -106
  1408. package/src/BigDecimal.ts +620 -553
  1409. package/src/BigInt.ts +342 -274
  1410. package/src/Boolean.ts +189 -156
  1411. package/src/Brand.ts +30 -5
  1412. package/src/Cache.ts +334 -167
  1413. package/src/Cause.ts +84 -73
  1414. package/src/Channel.ts +1639 -667
  1415. package/src/ChannelSchema.ts +137 -12
  1416. package/src/Chunk.ts +575 -429
  1417. package/src/Clock.ts +16 -9
  1418. package/src/Combiner.ts +11 -5
  1419. package/src/Config.ts +80 -68
  1420. package/src/ConfigProvider.ts +33 -32
  1421. package/src/Console.ts +88 -58
  1422. package/src/Context.ts +401 -190
  1423. package/src/Cron.ts +109 -48
  1424. package/src/Crypto.ts +327 -0
  1425. package/src/Data.ts +9 -3
  1426. package/src/DateTime.ts +893 -464
  1427. package/src/Deferred.ts +367 -175
  1428. package/src/Differ.ts +44 -2
  1429. package/src/Duration.ts +333 -186
  1430. package/src/Effect.ts +2201 -2289
  1431. package/src/Effectable.ts +38 -3
  1432. package/src/Encoding.ts +78 -28
  1433. package/src/Equal.ts +4 -3
  1434. package/src/Equivalence.ts +18 -24
  1435. package/src/ErrorReporter.ts +66 -82
  1436. package/src/ExecutionPlan.ts +106 -12
  1437. package/src/Exit.ts +6 -5
  1438. package/src/Fiber.ts +71 -40
  1439. package/src/FiberHandle.ts +157 -57
  1440. package/src/FiberMap.ts +328 -163
  1441. package/src/FiberSet.ts +130 -52
  1442. package/src/FileSystem.ts +104 -74
  1443. package/src/Filter.ts +166 -88
  1444. package/src/Formatter.ts +4 -70
  1445. package/src/Function.ts +218 -151
  1446. package/src/Graph.ts +714 -415
  1447. package/src/HKT.ts +29 -13
  1448. package/src/Hash.ts +35 -24
  1449. package/src/HashMap.ts +540 -388
  1450. package/src/HashRing.ts +111 -34
  1451. package/src/HashSet.ts +239 -153
  1452. package/src/Inspectable.ts +30 -17
  1453. package/src/Iterable.ts +336 -222
  1454. package/src/JsonPatch.ts +13 -10
  1455. package/src/JsonPointer.ts +13 -11
  1456. package/src/JsonSchema.ts +16 -0
  1457. package/src/Latch.ts +97 -26
  1458. package/src/Layer.ts +547 -445
  1459. package/src/LayerMap.ts +99 -26
  1460. package/src/LogLevel.ts +92 -131
  1461. package/src/Logger.ts +365 -297
  1462. package/src/ManagedRuntime.ts +78 -19
  1463. package/src/Match.ts +135 -161
  1464. package/src/Metric.ts +362 -313
  1465. package/src/MutableHashMap.ts +202 -127
  1466. package/src/MutableHashSet.ts +120 -52
  1467. package/src/MutableList.ts +157 -100
  1468. package/src/MutableRef.ts +129 -90
  1469. package/src/Newtype.ts +15 -2
  1470. package/src/NonEmptyIterable.ts +38 -48
  1471. package/src/Number.ts +261 -205
  1472. package/src/Optic.ts +6 -7
  1473. package/src/Option.ts +133 -156
  1474. package/src/Order.ts +6 -6
  1475. package/src/Ordering.ts +56 -45
  1476. package/src/PartitionedSemaphore.ts +225 -40
  1477. package/src/Path.ts +77 -13
  1478. package/src/Pipeable.ts +82 -24
  1479. package/src/PlatformError.ts +74 -6
  1480. package/src/Pool.ts +94 -31
  1481. package/src/Predicate.ts +17 -24
  1482. package/src/PrimaryKey.ts +11 -3
  1483. package/src/PubSub.ts +385 -309
  1484. package/src/Pull.ts +94 -25
  1485. package/src/Queue.ts +303 -184
  1486. package/src/Random.ts +69 -93
  1487. package/src/RcMap.ts +151 -141
  1488. package/src/RcRef.ts +68 -32
  1489. package/src/Record.ts +282 -137
  1490. package/src/Redactable.ts +7 -5
  1491. package/src/Redacted.ts +63 -34
  1492. package/src/Reducer.ts +3 -1
  1493. package/src/Ref.ts +173 -134
  1494. package/src/References.ts +73 -31
  1495. package/src/RegExp.ts +12 -6
  1496. package/src/Request.ts +159 -34
  1497. package/src/RequestResolver.ts +278 -121
  1498. package/src/Resource.ts +45 -7
  1499. package/src/Result.ts +137 -153
  1500. package/src/Runtime.ts +42 -21
  1501. package/src/Schedule.ts +585 -613
  1502. package/src/Scheduler.ts +44 -7
  1503. package/src/Schema.ts +1309 -615
  1504. package/src/SchemaAST.ts +123 -93
  1505. package/src/SchemaGetter.ts +52 -37
  1506. package/src/SchemaIssue.ts +19 -24
  1507. package/src/SchemaParser.ts +306 -85
  1508. package/src/SchemaRepresentation.ts +89 -77
  1509. package/src/SchemaTransformation.ts +97 -46
  1510. package/src/SchemaUtils.ts +24 -1
  1511. package/src/Scope.ts +107 -65
  1512. package/src/ScopedCache.ts +195 -59
  1513. package/src/ScopedRef.ts +28 -8
  1514. package/src/Semaphore.ts +61 -37
  1515. package/src/Sink.ts +461 -206
  1516. package/src/Stdio.ts +43 -6
  1517. package/src/Stream.ts +2361 -1613
  1518. package/src/String.ts +174 -97
  1519. package/src/Struct.ts +20 -18
  1520. package/src/SubscriptionRef.ts +309 -204
  1521. package/src/Symbol.ts +13 -5
  1522. package/src/SynchronizedRef.ts +278 -62
  1523. package/src/Take.ts +26 -2
  1524. package/src/Terminal.ts +40 -7
  1525. package/src/Tracer.ts +233 -59
  1526. package/src/Trie.ts +280 -245
  1527. package/src/Tuple.ts +34 -32
  1528. package/src/TxChunk.ts +200 -155
  1529. package/src/TxDeferred.ts +43 -29
  1530. package/src/TxHashMap.ts +370 -231
  1531. package/src/TxHashSet.ts +253 -159
  1532. package/src/TxPriorityQueue.ts +97 -65
  1533. package/src/TxPubSub.ts +77 -49
  1534. package/src/TxQueue.ts +277 -242
  1535. package/src/TxReentrantLock.ts +70 -47
  1536. package/src/TxRef.ts +69 -40
  1537. package/src/TxSemaphore.ts +101 -115
  1538. package/src/TxSubscriptionRef.ts +74 -50
  1539. package/src/Types.ts +31 -34
  1540. package/src/UndefinedOr.ts +62 -25
  1541. package/src/Unify.ts +72 -117
  1542. package/src/Utils.ts +5 -2
  1543. package/src/index.ts +1976 -420
  1544. package/src/internal/schema/schema.ts +1 -1
  1545. package/src/testing/FastCheck.ts +9 -6
  1546. package/src/testing/TestClock.ts +63 -35
  1547. package/src/testing/TestConsole.ts +54 -36
  1548. package/src/testing/TestSchema.ts +10 -8
  1549. package/src/testing/index.ts +34 -0
  1550. package/src/unstable/ai/AiError.ts +195 -137
  1551. package/src/unstable/ai/AnthropicStructuredOutput.ts +2 -2
  1552. package/src/unstable/ai/Chat.ts +68 -43
  1553. package/src/unstable/ai/EmbeddingModel.ts +12 -11
  1554. package/src/unstable/ai/IdGenerator.ts +28 -18
  1555. package/src/unstable/ai/LanguageModel.ts +35 -27
  1556. package/src/unstable/ai/McpSchema.ts +342 -119
  1557. package/src/unstable/ai/McpServer.ts +79 -20
  1558. package/src/unstable/ai/Model.ts +10 -12
  1559. package/src/unstable/ai/OpenAiStructuredOutput.ts +2 -2
  1560. package/src/unstable/ai/Prompt.ts +216 -192
  1561. package/src/unstable/ai/Response.ts +179 -167
  1562. package/src/unstable/ai/ResponseIdTracker.ts +43 -4
  1563. package/src/unstable/ai/Telemetry.ts +43 -33
  1564. package/src/unstable/ai/Tokenizer.ts +14 -9
  1565. package/src/unstable/ai/Tool.ts +168 -97
  1566. package/src/unstable/ai/Toolkit.ts +51 -46
  1567. package/src/unstable/ai/index.ts +121 -29
  1568. package/src/unstable/cli/Argument.ts +226 -134
  1569. package/src/unstable/cli/CliError.ts +96 -26
  1570. package/src/unstable/cli/CliOutput.ts +48 -19
  1571. package/src/unstable/cli/Command.ts +196 -115
  1572. package/src/unstable/cli/Completions.ts +7 -7
  1573. package/src/unstable/cli/Flag.ts +235 -142
  1574. package/src/unstable/cli/GlobalFlag.ts +41 -13
  1575. package/src/unstable/cli/HelpDoc.ts +39 -14
  1576. package/src/unstable/cli/Param.ts +395 -260
  1577. package/src/unstable/cli/Primitive.ts +79 -42
  1578. package/src/unstable/cli/Prompt.ts +207 -59
  1579. package/src/unstable/cli/index.ts +205 -6
  1580. package/src/unstable/cli/internal/ansi.ts +13 -0
  1581. package/src/unstable/cli/internal/command.ts +5 -1
  1582. package/src/unstable/cli/internal/config.ts +3 -0
  1583. package/src/unstable/cli/internal/lexer.ts +11 -0
  1584. package/src/unstable/cli/internal/parser.ts +0 -1
  1585. package/src/unstable/cluster/ClusterCron.ts +35 -1
  1586. package/src/unstable/cluster/ClusterError.ts +56 -7
  1587. package/src/unstable/cluster/ClusterMetrics.ts +39 -5
  1588. package/src/unstable/cluster/ClusterSchema.ts +61 -8
  1589. package/src/unstable/cluster/ClusterWorkflowEngine.ts +35 -2
  1590. package/src/unstable/cluster/DeliverAt.ts +39 -4
  1591. package/src/unstable/cluster/Entity.ts +106 -16
  1592. package/src/unstable/cluster/EntityAddress.ts +30 -2
  1593. package/src/unstable/cluster/EntityId.ts +18 -3
  1594. package/src/unstable/cluster/EntityProxy.ts +42 -14
  1595. package/src/unstable/cluster/EntityProxyServer.ts +45 -8
  1596. package/src/unstable/cluster/EntityResource.ts +43 -6
  1597. package/src/unstable/cluster/EntityType.ts +27 -3
  1598. package/src/unstable/cluster/Envelope.ts +128 -23
  1599. package/src/unstable/cluster/HttpRunner.ts +88 -13
  1600. package/src/unstable/cluster/K8sHttpClient.ts +49 -6
  1601. package/src/unstable/cluster/MachineId.ts +24 -3
  1602. package/src/unstable/cluster/Message.ts +102 -13
  1603. package/src/unstable/cluster/MessageStorage.ts +126 -21
  1604. package/src/unstable/cluster/Reply.ts +101 -12
  1605. package/src/unstable/cluster/Runner.ts +47 -17
  1606. package/src/unstable/cluster/RunnerAddress.ts +34 -2
  1607. package/src/unstable/cluster/RunnerHealth.ts +40 -12
  1608. package/src/unstable/cluster/RunnerServer.ts +31 -4
  1609. package/src/unstable/cluster/RunnerStorage.ts +42 -5
  1610. package/src/unstable/cluster/Runners.ts +76 -13
  1611. package/src/unstable/cluster/ShardId.ts +53 -5
  1612. package/src/unstable/cluster/Sharding.ts +35 -4
  1613. package/src/unstable/cluster/ShardingConfig.ts +75 -10
  1614. package/src/unstable/cluster/ShardingRegistrationEvent.ts +31 -7
  1615. package/src/unstable/cluster/SingleRunner.ts +23 -1
  1616. package/src/unstable/cluster/Singleton.ts +15 -1
  1617. package/src/unstable/cluster/SingletonAddress.ts +21 -1
  1618. package/src/unstable/cluster/Snowflake.ts +90 -19
  1619. package/src/unstable/cluster/SocketRunner.ts +29 -2
  1620. package/src/unstable/cluster/SqlMessageStorage.ts +27 -3
  1621. package/src/unstable/cluster/SqlRunnerStorage.ts +46 -7
  1622. package/src/unstable/cluster/TestRunner.ts +18 -1
  1623. package/src/unstable/cluster/index.ts +790 -0
  1624. package/src/unstable/cluster/internal/hash.ts +12 -0
  1625. package/src/unstable/devtools/DevTools.ts +26 -3
  1626. package/src/unstable/devtools/DevToolsClient.ts +32 -5
  1627. package/src/unstable/devtools/DevToolsSchema.ts +201 -44
  1628. package/src/unstable/devtools/DevToolsServer.ts +27 -2
  1629. package/src/unstable/devtools/index.ts +58 -0
  1630. package/src/unstable/encoding/Msgpack.ts +97 -12
  1631. package/src/unstable/encoding/Ndjson.ts +149 -21
  1632. package/src/unstable/encoding/Sse.ts +109 -18
  1633. package/src/unstable/encoding/index.ts +49 -0
  1634. package/src/unstable/eventlog/Event.ts +131 -30
  1635. package/src/unstable/eventlog/EventGroup.ts +50 -17
  1636. package/src/unstable/eventlog/EventJournal.ts +120 -20
  1637. package/src/unstable/eventlog/EventLog.ts +150 -31
  1638. package/src/unstable/eventlog/EventLogEncryption.ts +42 -6
  1639. package/src/unstable/eventlog/EventLogMessage.ts +92 -18
  1640. package/src/unstable/eventlog/EventLogRemote.ts +54 -8
  1641. package/src/unstable/eventlog/EventLogServer.ts +33 -3
  1642. package/src/unstable/eventlog/EventLogServerEncrypted.ts +52 -6
  1643. package/src/unstable/eventlog/EventLogServerUnencrypted.ts +90 -16
  1644. package/src/unstable/eventlog/EventLogSessionAuth.ts +77 -15
  1645. package/src/unstable/eventlog/SqlEventJournal.ts +28 -2
  1646. package/src/unstable/eventlog/SqlEventLogServerEncrypted.ts +32 -3
  1647. package/src/unstable/eventlog/SqlEventLogServerUnencrypted.ts +28 -2
  1648. package/src/unstable/eventlog/index.ts +240 -0
  1649. package/src/unstable/http/Cookies.ts +156 -77
  1650. package/src/unstable/http/Etag.ts +40 -7
  1651. package/src/unstable/http/FetchHttpClient.ts +33 -4
  1652. package/src/unstable/http/FindMyWay.ts +1 -1
  1653. package/src/unstable/http/Headers.ts +252 -50
  1654. package/src/unstable/http/HttpBody.ts +128 -26
  1655. package/src/unstable/http/HttpClient.ts +204 -96
  1656. package/src/unstable/http/HttpClientError.ts +80 -12
  1657. package/src/unstable/http/HttpClientRequest.ts +318 -100
  1658. package/src/unstable/http/HttpClientResponse.ts +59 -16
  1659. package/src/unstable/http/HttpEffect.ts +66 -18
  1660. package/src/unstable/http/HttpIncomingMessage.ts +48 -7
  1661. package/src/unstable/http/HttpMethod.ts +38 -6
  1662. package/src/unstable/http/HttpMiddleware.ts +60 -11
  1663. package/src/unstable/http/HttpPlatform.ts +34 -3
  1664. package/src/unstable/http/HttpRouter.ts +232 -69
  1665. package/src/unstable/http/HttpServer.ts +151 -22
  1666. package/src/unstable/http/HttpServerError.ts +93 -10
  1667. package/src/unstable/http/HttpServerRequest.ts +125 -21
  1668. package/src/unstable/http/HttpServerRespondable.ts +49 -6
  1669. package/src/unstable/http/HttpServerResponse.ts +391 -67
  1670. package/src/unstable/http/HttpStaticServer.ts +24 -8
  1671. package/src/unstable/http/HttpTraceContext.ts +53 -6
  1672. package/src/unstable/http/Multipart.ts +179 -28
  1673. package/src/unstable/http/Multipasta/HeadersParser.ts +1 -1
  1674. package/src/unstable/http/Multipasta/Node.ts +1 -1
  1675. package/src/unstable/http/Multipasta/Search.ts +1 -1
  1676. package/src/unstable/http/Multipasta/Web.ts +1 -1
  1677. package/src/unstable/http/Multipasta.ts +1 -1
  1678. package/src/unstable/http/Template.ts +53 -1
  1679. package/src/unstable/http/Url.ts +70 -56
  1680. package/src/unstable/http/UrlParams.ts +237 -51
  1681. package/src/unstable/http/index.ts +452 -0
  1682. package/src/unstable/httpapi/HttpApi.ts +49 -14
  1683. package/src/unstable/httpapi/HttpApiBuilder.ts +81 -16
  1684. package/src/unstable/httpapi/HttpApiClient.ts +78 -15
  1685. package/src/unstable/httpapi/HttpApiEndpoint.ts +238 -59
  1686. package/src/unstable/httpapi/HttpApiError.ts +100 -1
  1687. package/src/unstable/httpapi/HttpApiGroup.ts +87 -20
  1688. package/src/unstable/httpapi/HttpApiMiddleware.ts +113 -22
  1689. package/src/unstable/httpapi/HttpApiScalar.ts +38 -4
  1690. package/src/unstable/httpapi/HttpApiSchema.ts +86 -38
  1691. package/src/unstable/httpapi/HttpApiSecurity.ts +73 -17
  1692. package/src/unstable/httpapi/HttpApiSwagger.ts +23 -3
  1693. package/src/unstable/httpapi/HttpApiTest.ts +26 -1
  1694. package/src/unstable/httpapi/OpenApi.ts +115 -15
  1695. package/src/unstable/httpapi/index.ts +310 -25
  1696. package/src/unstable/observability/Otlp.ts +33 -3
  1697. package/src/unstable/observability/OtlpExporter.ts +32 -1
  1698. package/src/unstable/observability/OtlpLogger.ts +32 -2
  1699. package/src/unstable/observability/OtlpMetrics.ts +39 -5
  1700. package/src/unstable/observability/OtlpResource.ts +68 -12
  1701. package/src/unstable/observability/OtlpSerialization.ts +28 -3
  1702. package/src/unstable/observability/OtlpTracer.ts +41 -2
  1703. package/src/unstable/observability/PrometheusMetrics.ts +36 -16
  1704. package/src/unstable/observability/index.ts +160 -3
  1705. package/src/unstable/persistence/KeyValueStore.ts +108 -28
  1706. package/src/unstable/persistence/Persistable.ts +76 -15
  1707. package/src/unstable/persistence/PersistedCache.ts +27 -2
  1708. package/src/unstable/persistence/PersistedQueue.ts +98 -16
  1709. package/src/unstable/persistence/Persistence.ts +98 -16
  1710. package/src/unstable/persistence/RateLimiter.ts +101 -21
  1711. package/src/unstable/persistence/Redis.ts +42 -5
  1712. package/src/unstable/persistence/index.ts +147 -0
  1713. package/src/unstable/process/ChildProcess.ts +90 -66
  1714. package/src/unstable/process/ChildProcessSpawner.ts +23 -12
  1715. package/src/unstable/process/index.ts +2 -1
  1716. package/src/unstable/reactivity/AsyncResult.ts +204 -61
  1717. package/src/unstable/reactivity/Atom.ts +598 -139
  1718. package/src/unstable/reactivity/AtomHttpApi.ts +41 -2
  1719. package/src/unstable/reactivity/AtomRef.ts +51 -7
  1720. package/src/unstable/reactivity/AtomRegistry.ts +141 -22
  1721. package/src/unstable/reactivity/AtomRpc.ts +36 -2
  1722. package/src/unstable/reactivity/Hydration.ts +45 -5
  1723. package/src/unstable/reactivity/Reactivity.ts +94 -13
  1724. package/src/unstable/reactivity/index.ts +167 -0
  1725. package/src/unstable/rpc/Rpc.ts +254 -56
  1726. package/src/unstable/rpc/RpcClient.ts +106 -19
  1727. package/src/unstable/rpc/RpcClientError.ts +26 -2
  1728. package/src/unstable/rpc/RpcGroup.ts +51 -8
  1729. package/src/unstable/rpc/RpcMessage.ts +128 -32
  1730. package/src/unstable/rpc/RpcMiddleware.ts +100 -20
  1731. package/src/unstable/rpc/RpcSchema.ts +38 -4
  1732. package/src/unstable/rpc/RpcSerialization.ts +60 -13
  1733. package/src/unstable/rpc/RpcServer.ts +107 -23
  1734. package/src/unstable/rpc/RpcTest.ts +20 -1
  1735. package/src/unstable/rpc/RpcWorker.ts +39 -6
  1736. package/src/unstable/rpc/Utils.ts +33 -0
  1737. package/src/unstable/rpc/index.ts +272 -0
  1738. package/src/unstable/schema/Model.ts +245 -61
  1739. package/src/unstable/schema/VariantSchema.ts +101 -24
  1740. package/src/unstable/schema/index.ts +37 -0
  1741. package/src/unstable/socket/Socket.ts +168 -34
  1742. package/src/unstable/socket/SocketServer.ts +58 -10
  1743. package/src/unstable/socket/index.ts +44 -0
  1744. package/src/unstable/sql/Migrator.ts +61 -9
  1745. package/src/unstable/sql/SqlClient.ts +59 -2
  1746. package/src/unstable/sql/SqlConnection.ts +34 -3
  1747. package/src/unstable/sql/SqlError.ts +135 -0
  1748. package/src/unstable/sql/SqlModel.ts +25 -5
  1749. package/src/unstable/sql/SqlResolver.ts +56 -13
  1750. package/src/unstable/sql/SqlSchema.ts +29 -8
  1751. package/src/unstable/sql/SqlStream.ts +24 -0
  1752. package/src/unstable/sql/Statement.ts +168 -24
  1753. package/src/unstable/sql/index.ts +179 -1
  1754. package/src/unstable/workers/Transferable.ts +72 -20
  1755. package/src/unstable/workers/Worker.ts +61 -8
  1756. package/src/unstable/workers/WorkerError.ts +50 -9
  1757. package/src/unstable/workers/WorkerRunner.ts +32 -3
  1758. package/src/unstable/workers/index.ts +81 -1
  1759. package/src/unstable/workflow/Activity.ts +61 -10
  1760. package/src/unstable/workflow/DurableClock.ts +26 -3
  1761. package/src/unstable/workflow/DurableDeferred.ts +148 -31
  1762. package/src/unstable/workflow/DurableQueue.ts +33 -8
  1763. package/src/unstable/workflow/Workflow.ts +123 -31
  1764. package/src/unstable/workflow/WorkflowEngine.ts +40 -5
  1765. package/src/unstable/workflow/WorkflowProxy.ts +40 -12
  1766. package/src/unstable/workflow/WorkflowProxyServer.ts +41 -6
  1767. package/src/unstable/workflow/index.ts +160 -0
@@ -24,14 +24,15 @@ declare const TypeId = "~effect/BigDecimal";
24
24
  /**
25
25
  * Represents an arbitrary precision decimal number.
26
26
  *
27
- * @example
27
+ * **Example** (Inspecting BigDecimal storage)
28
+ *
28
29
  * ```ts
29
30
  * import { BigDecimal } from "effect"
30
31
  *
31
- * const d = BigDecimal.fromNumberUnsafe(123.45)
32
+ * const d = BigDecimal.fromStringUnsafe("123.45")
32
33
  *
33
- * d.value // 12345n
34
- * d.scale // 2
34
+ * console.log(d.value) // 12345n
35
+ * console.log(d.scale) // 2
35
36
  * ```
36
37
  *
37
38
  * @category models
@@ -45,7 +46,8 @@ export interface BigDecimal extends Equal.Equal, Pipeable, Inspectable {
45
46
  /**
46
47
  * Checks if a given value is a `BigDecimal`.
47
48
  *
48
- * @example
49
+ * **Example** (Checking BigDecimal values)
50
+ *
49
51
  * ```ts
50
52
  * import { BigDecimal } from "effect"
51
53
  *
@@ -55,14 +57,15 @@ export interface BigDecimal extends Equal.Equal, Pipeable, Inspectable {
55
57
  * console.log(BigDecimal.isBigDecimal("123.45")) // false
56
58
  * ```
57
59
  *
58
- * @since 2.0.0
59
60
  * @category guards
61
+ * @since 2.0.0
60
62
  */
61
63
  export declare const isBigDecimal: (u: unknown) => u is BigDecimal;
62
64
  /**
63
65
  * Creates a `BigDecimal` from a `bigint` value and a scale.
64
66
  *
65
- * @example
67
+ * **Example** (Creating decimals from bigint and scale)
68
+ *
66
69
  * ```ts
67
70
  * import { BigDecimal } from "effect"
68
71
  *
@@ -75,39 +78,42 @@ export declare const isBigDecimal: (u: unknown) => u is BigDecimal;
75
78
  * console.log(BigDecimal.format(integer)) // "42"
76
79
  * ```
77
80
  *
78
- * @since 2.0.0
79
81
  * @category constructors
82
+ * @since 2.0.0
80
83
  */
81
84
  export declare const make: (value: bigint, scale: number) => BigDecimal;
82
85
  /**
83
86
  * Normalizes a given `BigDecimal` by removing trailing zeros.
84
87
  *
85
- * @example
88
+ * **Example** (Normalizing trailing zeros)
89
+ *
86
90
  * ```ts
87
- * import { fromStringUnsafe, make, normalize } from "effect/BigDecimal"
91
+ * import { BigDecimal } from "effect"
88
92
  * import * as assert from "node:assert"
89
93
  *
90
94
  * assert.deepStrictEqual(
91
- * normalize(fromStringUnsafe("123.00000")),
92
- * normalize(make(123n, 0))
95
+ * BigDecimal.normalize(BigDecimal.fromStringUnsafe("123.00000")),
96
+ * BigDecimal.normalize(BigDecimal.make(123n, 0))
93
97
  * )
94
98
  * assert.deepStrictEqual(
95
- * normalize(fromStringUnsafe("12300000")),
96
- * normalize(make(123n, -5))
99
+ * BigDecimal.normalize(BigDecimal.fromStringUnsafe("12300000")),
100
+ * BigDecimal.normalize(BigDecimal.make(123n, -5))
97
101
  * )
98
102
  * ```
99
103
  *
100
- * @since 2.0.0
101
104
  * @category scaling
105
+ * @since 2.0.0
102
106
  */
103
107
  export declare const normalize: (self: BigDecimal) => BigDecimal;
104
108
  /**
105
- * Scales a given `BigDecimal` to the specified scale.
109
+ * Scales a `BigDecimal` to the specified scale.
110
+ *
111
+ * Increasing the scale appends decimal zeros. Decreasing the scale discards
112
+ * digits beyond the target scale by `bigint` division, which truncates toward
113
+ * zero.
106
114
  *
107
- * If the given scale is smaller than the current scale, the value will be rounded down to
108
- * the nearest integer.
115
+ * **Example** (Scaling decimal precision)
109
116
  *
110
- * @example
111
117
  * ```ts
112
118
  * import { BigDecimal } from "effect"
113
119
  *
@@ -122,17 +128,19 @@ export declare const normalize: (self: BigDecimal) => BigDecimal;
122
128
  * console.log(BigDecimal.format(reduced)) // "123.4"
123
129
  * ```
124
130
  *
125
- * @since 2.0.0
126
131
  * @category scaling
132
+ * @since 2.0.0
127
133
  */
128
134
  export declare const scale: {
129
135
  /**
130
- * Scales a given `BigDecimal` to the specified scale.
136
+ * Scales a `BigDecimal` to the specified scale.
137
+ *
138
+ * Increasing the scale appends decimal zeros. Decreasing the scale discards
139
+ * digits beyond the target scale by `bigint` division, which truncates toward
140
+ * zero.
131
141
  *
132
- * If the given scale is smaller than the current scale, the value will be rounded down to
133
- * the nearest integer.
142
+ * **Example** (Scaling decimal precision)
134
143
  *
135
- * @example
136
144
  * ```ts
137
145
  * import { BigDecimal } from "effect"
138
146
  *
@@ -147,17 +155,19 @@ export declare const scale: {
147
155
  * console.log(BigDecimal.format(reduced)) // "123.4"
148
156
  * ```
149
157
  *
150
- * @since 2.0.0
151
158
  * @category scaling
159
+ * @since 2.0.0
152
160
  */
153
161
  (scale: number): (self: BigDecimal) => BigDecimal;
154
162
  /**
155
- * Scales a given `BigDecimal` to the specified scale.
163
+ * Scales a `BigDecimal` to the specified scale.
164
+ *
165
+ * Increasing the scale appends decimal zeros. Decreasing the scale discards
166
+ * digits beyond the target scale by `bigint` division, which truncates toward
167
+ * zero.
156
168
  *
157
- * If the given scale is smaller than the current scale, the value will be rounded down to
158
- * the nearest integer.
169
+ * **Example** (Scaling decimal precision)
159
170
  *
160
- * @example
161
171
  * ```ts
162
172
  * import { BigDecimal } from "effect"
163
173
  *
@@ -172,419 +182,422 @@ export declare const scale: {
172
182
  * console.log(BigDecimal.format(reduced)) // "123.4"
173
183
  * ```
174
184
  *
175
- * @since 2.0.0
176
185
  * @category scaling
186
+ * @since 2.0.0
177
187
  */
178
188
  (self: BigDecimal, scale: number): BigDecimal;
179
189
  };
180
190
  /**
181
191
  * Provides an addition operation on `BigDecimal`s.
182
192
  *
183
- * @example
193
+ * **Example** (Adding decimals)
194
+ *
184
195
  * ```ts
185
- * import { fromStringUnsafe, sum } from "effect/BigDecimal"
196
+ * import { BigDecimal } from "effect"
186
197
  * import * as assert from "node:assert"
187
198
  *
188
199
  * assert.deepStrictEqual(
189
- * sum(fromStringUnsafe("2"), fromStringUnsafe("3")),
190
- * fromStringUnsafe("5")
200
+ * BigDecimal.sum(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
201
+ * BigDecimal.fromStringUnsafe("5")
191
202
  * )
192
203
  * ```
193
204
  *
194
- * @since 2.0.0
195
205
  * @category math
206
+ * @since 2.0.0
196
207
  */
197
208
  export declare const sum: {
198
209
  /**
199
210
  * Provides an addition operation on `BigDecimal`s.
200
211
  *
201
- * @example
212
+ * **Example** (Adding decimals)
213
+ *
202
214
  * ```ts
203
- * import { fromStringUnsafe, sum } from "effect/BigDecimal"
215
+ * import { BigDecimal } from "effect"
204
216
  * import * as assert from "node:assert"
205
217
  *
206
218
  * assert.deepStrictEqual(
207
- * sum(fromStringUnsafe("2"), fromStringUnsafe("3")),
208
- * fromStringUnsafe("5")
219
+ * BigDecimal.sum(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
220
+ * BigDecimal.fromStringUnsafe("5")
209
221
  * )
210
222
  * ```
211
223
  *
212
- * @since 2.0.0
213
224
  * @category math
225
+ * @since 2.0.0
214
226
  */
215
227
  (that: BigDecimal): (self: BigDecimal) => BigDecimal;
216
228
  /**
217
229
  * Provides an addition operation on `BigDecimal`s.
218
230
  *
219
- * @example
231
+ * **Example** (Adding decimals)
232
+ *
220
233
  * ```ts
221
- * import { fromStringUnsafe, sum } from "effect/BigDecimal"
234
+ * import { BigDecimal } from "effect"
222
235
  * import * as assert from "node:assert"
223
236
  *
224
237
  * assert.deepStrictEqual(
225
- * sum(fromStringUnsafe("2"), fromStringUnsafe("3")),
226
- * fromStringUnsafe("5")
238
+ * BigDecimal.sum(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
239
+ * BigDecimal.fromStringUnsafe("5")
227
240
  * )
228
241
  * ```
229
242
  *
230
- * @since 2.0.0
231
243
  * @category math
244
+ * @since 2.0.0
232
245
  */
233
246
  (self: BigDecimal, that: BigDecimal): BigDecimal;
234
247
  };
235
248
  /**
236
249
  * Takes an `Iterable` of `BigDecimal`s and returns their sum as a single `BigDecimal`.
237
250
  *
238
- * @example
251
+ * **Example** (Adding multiple decimals)
252
+ *
239
253
  * ```ts
240
- * import { fromStringUnsafe, sumAll } from "effect/BigDecimal"
254
+ * import { BigDecimal } from "effect"
241
255
  * import * as assert from "node:assert"
242
256
  *
243
257
  * assert.deepStrictEqual(
244
- * sumAll([fromStringUnsafe("2"), fromStringUnsafe("3"), fromStringUnsafe("4")]),
245
- * fromStringUnsafe("9")
258
+ * BigDecimal.sumAll([BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("4")]),
259
+ * BigDecimal.fromStringUnsafe("9")
246
260
  * )
247
261
  * ```
248
262
  *
249
- * @since 4.0.0
250
263
  * @category math
264
+ * @since 3.16.0
251
265
  */
252
266
  export declare const sumAll: (collection: Iterable<BigDecimal>) => BigDecimal;
253
267
  /**
254
268
  * Provides a multiplication operation on `BigDecimal`s.
255
269
  *
256
- * @example
270
+ * **Example** (Multiplying decimals)
271
+ *
257
272
  * ```ts
258
- * import { fromStringUnsafe, multiply } from "effect/BigDecimal"
273
+ * import { BigDecimal } from "effect"
259
274
  * import * as assert from "node:assert"
260
275
  *
261
276
  * assert.deepStrictEqual(
262
- * multiply(fromStringUnsafe("2"), fromStringUnsafe("3")),
263
- * fromStringUnsafe("6")
277
+ * BigDecimal.multiply(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
278
+ * BigDecimal.fromStringUnsafe("6")
264
279
  * )
265
280
  * ```
266
281
  *
267
- * @since 2.0.0
268
282
  * @category math
283
+ * @since 2.0.0
269
284
  */
270
285
  export declare const multiply: {
271
286
  /**
272
287
  * Provides a multiplication operation on `BigDecimal`s.
273
288
  *
274
- * @example
289
+ * **Example** (Multiplying decimals)
290
+ *
275
291
  * ```ts
276
- * import { fromStringUnsafe, multiply } from "effect/BigDecimal"
292
+ * import { BigDecimal } from "effect"
277
293
  * import * as assert from "node:assert"
278
294
  *
279
295
  * assert.deepStrictEqual(
280
- * multiply(fromStringUnsafe("2"), fromStringUnsafe("3")),
281
- * fromStringUnsafe("6")
296
+ * BigDecimal.multiply(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
297
+ * BigDecimal.fromStringUnsafe("6")
282
298
  * )
283
299
  * ```
284
300
  *
285
- * @since 2.0.0
286
301
  * @category math
302
+ * @since 2.0.0
287
303
  */
288
304
  (that: BigDecimal): (self: BigDecimal) => BigDecimal;
289
305
  /**
290
306
  * Provides a multiplication operation on `BigDecimal`s.
291
307
  *
292
- * @example
308
+ * **Example** (Multiplying decimals)
309
+ *
293
310
  * ```ts
294
- * import { fromStringUnsafe, multiply } from "effect/BigDecimal"
311
+ * import { BigDecimal } from "effect"
295
312
  * import * as assert from "node:assert"
296
313
  *
297
314
  * assert.deepStrictEqual(
298
- * multiply(fromStringUnsafe("2"), fromStringUnsafe("3")),
299
- * fromStringUnsafe("6")
315
+ * BigDecimal.multiply(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
316
+ * BigDecimal.fromStringUnsafe("6")
300
317
  * )
301
318
  * ```
302
319
  *
303
- * @since 2.0.0
304
320
  * @category math
321
+ * @since 2.0.0
305
322
  */
306
323
  (self: BigDecimal, that: BigDecimal): BigDecimal;
307
324
  };
308
325
  /**
309
326
  * Takes an `Iterable` of `BigDecimal`s and returns their multiplication as a single `BigDecimal`.
310
327
  *
311
- * @example
328
+ * **Example** (Multiplying multiple decimals)
329
+ *
312
330
  * ```ts
313
- * import { fromStringUnsafe, multiplyAll } from "effect/BigDecimal"
331
+ * import { BigDecimal } from "effect"
314
332
  * import * as assert from "node:assert"
315
333
  *
316
334
  * assert.deepStrictEqual(
317
- * multiplyAll([fromStringUnsafe("2"), fromStringUnsafe("3"), fromStringUnsafe("4")]),
318
- * fromStringUnsafe("24")
335
+ * BigDecimal.multiplyAll([BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("4")]),
336
+ * BigDecimal.fromStringUnsafe("24")
319
337
  * )
320
338
  * ```
321
339
  *
322
- * @since 4.0.0
323
340
  * @category math
341
+ * @since 4.0.0
324
342
  */
325
343
  export declare const multiplyAll: (collection: Iterable<BigDecimal>) => BigDecimal;
326
344
  /**
327
345
  * Provides a subtraction operation on `BigDecimal`s.
328
346
  *
329
- * @example
347
+ * **Example** (Subtracting decimals)
348
+ *
330
349
  * ```ts
331
- * import { fromStringUnsafe, subtract } from "effect/BigDecimal"
350
+ * import { BigDecimal } from "effect"
332
351
  * import * as assert from "node:assert"
333
352
  *
334
353
  * assert.deepStrictEqual(
335
- * subtract(fromStringUnsafe("2"), fromStringUnsafe("3")),
336
- * fromStringUnsafe("-1")
354
+ * BigDecimal.subtract(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
355
+ * BigDecimal.fromStringUnsafe("-1")
337
356
  * )
338
357
  * ```
339
358
  *
340
- * @since 2.0.0
341
359
  * @category math
360
+ * @since 2.0.0
342
361
  */
343
362
  export declare const subtract: {
344
363
  /**
345
364
  * Provides a subtraction operation on `BigDecimal`s.
346
365
  *
347
- * @example
366
+ * **Example** (Subtracting decimals)
367
+ *
348
368
  * ```ts
349
- * import { fromStringUnsafe, subtract } from "effect/BigDecimal"
369
+ * import { BigDecimal } from "effect"
350
370
  * import * as assert from "node:assert"
351
371
  *
352
372
  * assert.deepStrictEqual(
353
- * subtract(fromStringUnsafe("2"), fromStringUnsafe("3")),
354
- * fromStringUnsafe("-1")
373
+ * BigDecimal.subtract(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
374
+ * BigDecimal.fromStringUnsafe("-1")
355
375
  * )
356
376
  * ```
357
377
  *
358
- * @since 2.0.0
359
378
  * @category math
379
+ * @since 2.0.0
360
380
  */
361
381
  (that: BigDecimal): (self: BigDecimal) => BigDecimal;
362
382
  /**
363
383
  * Provides a subtraction operation on `BigDecimal`s.
364
384
  *
365
- * @example
385
+ * **Example** (Subtracting decimals)
386
+ *
366
387
  * ```ts
367
- * import { fromStringUnsafe, subtract } from "effect/BigDecimal"
388
+ * import { BigDecimal } from "effect"
368
389
  * import * as assert from "node:assert"
369
390
  *
370
391
  * assert.deepStrictEqual(
371
- * subtract(fromStringUnsafe("2"), fromStringUnsafe("3")),
372
- * fromStringUnsafe("-1")
392
+ * BigDecimal.subtract(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
393
+ * BigDecimal.fromStringUnsafe("-1")
373
394
  * )
374
395
  * ```
375
396
  *
376
- * @since 2.0.0
377
397
  * @category math
398
+ * @since 2.0.0
378
399
  */
379
400
  (self: BigDecimal, that: BigDecimal): BigDecimal;
380
401
  };
381
402
  /**
382
403
  * Provides a division operation on `BigDecimal`s.
383
404
  *
384
- * If the dividend is not a multiple of the divisor the result will be a `BigDecimal` value
385
- * which represents the integer division rounded down to the nearest integer.
405
+ * If the dividend is not a multiple of the divisor, the result will be a `BigDecimal` value
406
+ * with up to the default division precision.
386
407
  *
387
408
  * If the divisor is `0`, the result will be `Option.none()`.
388
409
  *
389
- * @example
410
+ * **Example** (Dividing decimals safely)
411
+ *
390
412
  * ```ts
391
413
  * import { BigDecimal, Option } from "effect"
392
- * import * as assert from "node:assert"
393
414
  *
394
- * assert.deepStrictEqual(
395
- * BigDecimal.divide(
396
- * BigDecimal.fromStringUnsafe("6"),
397
- * BigDecimal.fromStringUnsafe("3")
398
- * ),
399
- * Option.some(BigDecimal.fromStringUnsafe("2"))
400
- * )
401
- * assert.deepStrictEqual(
402
- * BigDecimal.divide(
403
- * BigDecimal.fromStringUnsafe("6"),
404
- * BigDecimal.fromStringUnsafe("4")
405
- * ),
406
- * Option.some(BigDecimal.fromStringUnsafe("1.5"))
407
- * )
408
- * assert.deepStrictEqual(
409
- * BigDecimal.divide(
410
- * BigDecimal.fromStringUnsafe("6"),
411
- * BigDecimal.fromStringUnsafe("0")
412
- * ),
413
- * Option.none()
414
- * )
415
+ * console.log(
416
+ * Option.getOrThrow(
417
+ * BigDecimal.divide(
418
+ * BigDecimal.fromStringUnsafe("6"),
419
+ * BigDecimal.fromStringUnsafe("3")
420
+ * )
421
+ * )
422
+ * ) // BigDecimal(2)
423
+ * console.log(
424
+ * Option.getOrThrow(
425
+ * BigDecimal.divide(
426
+ * BigDecimal.fromStringUnsafe("6"),
427
+ * BigDecimal.fromStringUnsafe("4")
428
+ * )
429
+ * )
430
+ * ) // BigDecimal(1.5)
431
+ * console.log(
432
+ * Option.isNone(
433
+ * BigDecimal.divide(
434
+ * BigDecimal.fromStringUnsafe("6"),
435
+ * BigDecimal.fromStringUnsafe("0")
436
+ * )
437
+ * )
438
+ * ) // true
415
439
  * ```
416
440
  *
417
- * @since 2.0.0
418
441
  * @category math
442
+ * @since 2.0.0
419
443
  */
420
444
  export declare const divide: {
421
445
  /**
422
446
  * Provides a division operation on `BigDecimal`s.
423
447
  *
424
- * If the dividend is not a multiple of the divisor the result will be a `BigDecimal` value
425
- * which represents the integer division rounded down to the nearest integer.
448
+ * If the dividend is not a multiple of the divisor, the result will be a `BigDecimal` value
449
+ * with up to the default division precision.
426
450
  *
427
451
  * If the divisor is `0`, the result will be `Option.none()`.
428
452
  *
429
- * @example
453
+ * **Example** (Dividing decimals safely)
454
+ *
430
455
  * ```ts
431
456
  * import { BigDecimal, Option } from "effect"
432
- * import * as assert from "node:assert"
433
457
  *
434
- * assert.deepStrictEqual(
435
- * BigDecimal.divide(
436
- * BigDecimal.fromStringUnsafe("6"),
437
- * BigDecimal.fromStringUnsafe("3")
438
- * ),
439
- * Option.some(BigDecimal.fromStringUnsafe("2"))
440
- * )
441
- * assert.deepStrictEqual(
442
- * BigDecimal.divide(
443
- * BigDecimal.fromStringUnsafe("6"),
444
- * BigDecimal.fromStringUnsafe("4")
445
- * ),
446
- * Option.some(BigDecimal.fromStringUnsafe("1.5"))
447
- * )
448
- * assert.deepStrictEqual(
449
- * BigDecimal.divide(
450
- * BigDecimal.fromStringUnsafe("6"),
451
- * BigDecimal.fromStringUnsafe("0")
452
- * ),
453
- * Option.none()
454
- * )
458
+ * console.log(
459
+ * Option.getOrThrow(
460
+ * BigDecimal.divide(
461
+ * BigDecimal.fromStringUnsafe("6"),
462
+ * BigDecimal.fromStringUnsafe("3")
463
+ * )
464
+ * )
465
+ * ) // BigDecimal(2)
466
+ * console.log(
467
+ * Option.getOrThrow(
468
+ * BigDecimal.divide(
469
+ * BigDecimal.fromStringUnsafe("6"),
470
+ * BigDecimal.fromStringUnsafe("4")
471
+ * )
472
+ * )
473
+ * ) // BigDecimal(1.5)
474
+ * console.log(
475
+ * Option.isNone(
476
+ * BigDecimal.divide(
477
+ * BigDecimal.fromStringUnsafe("6"),
478
+ * BigDecimal.fromStringUnsafe("0")
479
+ * )
480
+ * )
481
+ * ) // true
455
482
  * ```
456
483
  *
457
- * @since 2.0.0
458
484
  * @category math
485
+ * @since 2.0.0
459
486
  */
460
487
  (that: BigDecimal): (self: BigDecimal) => Option.Option<BigDecimal>;
461
488
  /**
462
489
  * Provides a division operation on `BigDecimal`s.
463
490
  *
464
- * If the dividend is not a multiple of the divisor the result will be a `BigDecimal` value
465
- * which represents the integer division rounded down to the nearest integer.
491
+ * If the dividend is not a multiple of the divisor, the result will be a `BigDecimal` value
492
+ * with up to the default division precision.
466
493
  *
467
494
  * If the divisor is `0`, the result will be `Option.none()`.
468
495
  *
469
- * @example
496
+ * **Example** (Dividing decimals safely)
497
+ *
470
498
  * ```ts
471
499
  * import { BigDecimal, Option } from "effect"
472
- * import * as assert from "node:assert"
473
500
  *
474
- * assert.deepStrictEqual(
475
- * BigDecimal.divide(
476
- * BigDecimal.fromStringUnsafe("6"),
477
- * BigDecimal.fromStringUnsafe("3")
478
- * ),
479
- * Option.some(BigDecimal.fromStringUnsafe("2"))
480
- * )
481
- * assert.deepStrictEqual(
482
- * BigDecimal.divide(
483
- * BigDecimal.fromStringUnsafe("6"),
484
- * BigDecimal.fromStringUnsafe("4")
485
- * ),
486
- * Option.some(BigDecimal.fromStringUnsafe("1.5"))
487
- * )
488
- * assert.deepStrictEqual(
489
- * BigDecimal.divide(
490
- * BigDecimal.fromStringUnsafe("6"),
491
- * BigDecimal.fromStringUnsafe("0")
492
- * ),
493
- * Option.none()
494
- * )
501
+ * console.log(
502
+ * Option.getOrThrow(
503
+ * BigDecimal.divide(
504
+ * BigDecimal.fromStringUnsafe("6"),
505
+ * BigDecimal.fromStringUnsafe("3")
506
+ * )
507
+ * )
508
+ * ) // BigDecimal(2)
509
+ * console.log(
510
+ * Option.getOrThrow(
511
+ * BigDecimal.divide(
512
+ * BigDecimal.fromStringUnsafe("6"),
513
+ * BigDecimal.fromStringUnsafe("4")
514
+ * )
515
+ * )
516
+ * ) // BigDecimal(1.5)
517
+ * console.log(
518
+ * Option.isNone(
519
+ * BigDecimal.divide(
520
+ * BigDecimal.fromStringUnsafe("6"),
521
+ * BigDecimal.fromStringUnsafe("0")
522
+ * )
523
+ * )
524
+ * ) // true
495
525
  * ```
496
526
  *
497
- * @since 2.0.0
498
527
  * @category math
528
+ * @since 2.0.0
499
529
  */
500
530
  (self: BigDecimal, that: BigDecimal): Option.Option<BigDecimal>;
501
531
  };
502
532
  /**
503
533
  * Provides an unsafe division operation on `BigDecimal`s.
504
534
  *
505
- * If the dividend is not a multiple of the divisor the result will be a `BigDecimal` value
506
- * which represents the integer division rounded down to the nearest integer.
535
+ * If the dividend is not a multiple of the divisor, the result will be a `BigDecimal` value
536
+ * with up to the default division precision.
507
537
  *
508
538
  * Throws a `RangeError` if the divisor is `0`.
509
539
  *
510
- * @example
540
+ * **Example** (Dividing decimals unsafely)
541
+ *
511
542
  * ```ts
512
- * import { divideUnsafe, fromStringUnsafe } from "effect/BigDecimal"
513
- * import * as assert from "node:assert"
543
+ * import { BigDecimal } from "effect"
514
544
  *
515
- * assert.deepStrictEqual(
516
- * divideUnsafe(fromStringUnsafe("6"), fromStringUnsafe("3")),
517
- * fromStringUnsafe("2")
518
- * )
519
- * assert.deepStrictEqual(
520
- * divideUnsafe(fromStringUnsafe("6"), fromStringUnsafe("4")),
521
- * fromStringUnsafe("1.5")
522
- * )
545
+ * console.log(BigDecimal.divideUnsafe(BigDecimal.fromStringUnsafe("6"), BigDecimal.fromStringUnsafe("3"))) // BigDecimal(2)
546
+ * console.log(BigDecimal.divideUnsafe(BigDecimal.fromStringUnsafe("6"), BigDecimal.fromStringUnsafe("4"))) // BigDecimal(1.5)
523
547
  * ```
524
548
  *
525
- * @since 2.0.0
526
549
  * @category math
550
+ * @since 4.0.0
527
551
  */
528
552
  export declare const divideUnsafe: {
529
553
  /**
530
554
  * Provides an unsafe division operation on `BigDecimal`s.
531
555
  *
532
- * If the dividend is not a multiple of the divisor the result will be a `BigDecimal` value
533
- * which represents the integer division rounded down to the nearest integer.
556
+ * If the dividend is not a multiple of the divisor, the result will be a `BigDecimal` value
557
+ * with up to the default division precision.
534
558
  *
535
559
  * Throws a `RangeError` if the divisor is `0`.
536
560
  *
537
- * @example
561
+ * **Example** (Dividing decimals unsafely)
562
+ *
538
563
  * ```ts
539
- * import { divideUnsafe, fromStringUnsafe } from "effect/BigDecimal"
540
- * import * as assert from "node:assert"
564
+ * import { BigDecimal } from "effect"
541
565
  *
542
- * assert.deepStrictEqual(
543
- * divideUnsafe(fromStringUnsafe("6"), fromStringUnsafe("3")),
544
- * fromStringUnsafe("2")
545
- * )
546
- * assert.deepStrictEqual(
547
- * divideUnsafe(fromStringUnsafe("6"), fromStringUnsafe("4")),
548
- * fromStringUnsafe("1.5")
549
- * )
566
+ * console.log(BigDecimal.divideUnsafe(BigDecimal.fromStringUnsafe("6"), BigDecimal.fromStringUnsafe("3"))) // BigDecimal(2)
567
+ * console.log(BigDecimal.divideUnsafe(BigDecimal.fromStringUnsafe("6"), BigDecimal.fromStringUnsafe("4"))) // BigDecimal(1.5)
550
568
  * ```
551
569
  *
552
- * @since 2.0.0
553
570
  * @category math
571
+ * @since 4.0.0
554
572
  */
555
573
  (that: BigDecimal): (self: BigDecimal) => BigDecimal;
556
574
  /**
557
575
  * Provides an unsafe division operation on `BigDecimal`s.
558
576
  *
559
- * If the dividend is not a multiple of the divisor the result will be a `BigDecimal` value
560
- * which represents the integer division rounded down to the nearest integer.
577
+ * If the dividend is not a multiple of the divisor, the result will be a `BigDecimal` value
578
+ * with up to the default division precision.
561
579
  *
562
580
  * Throws a `RangeError` if the divisor is `0`.
563
581
  *
564
- * @example
582
+ * **Example** (Dividing decimals unsafely)
583
+ *
565
584
  * ```ts
566
- * import { divideUnsafe, fromStringUnsafe } from "effect/BigDecimal"
567
- * import * as assert from "node:assert"
585
+ * import { BigDecimal } from "effect"
568
586
  *
569
- * assert.deepStrictEqual(
570
- * divideUnsafe(fromStringUnsafe("6"), fromStringUnsafe("3")),
571
- * fromStringUnsafe("2")
572
- * )
573
- * assert.deepStrictEqual(
574
- * divideUnsafe(fromStringUnsafe("6"), fromStringUnsafe("4")),
575
- * fromStringUnsafe("1.5")
576
- * )
587
+ * console.log(BigDecimal.divideUnsafe(BigDecimal.fromStringUnsafe("6"), BigDecimal.fromStringUnsafe("3"))) // BigDecimal(2)
588
+ * console.log(BigDecimal.divideUnsafe(BigDecimal.fromStringUnsafe("6"), BigDecimal.fromStringUnsafe("4"))) // BigDecimal(1.5)
577
589
  * ```
578
590
  *
579
- * @since 2.0.0
580
591
  * @category math
592
+ * @since 4.0.0
581
593
  */
582
594
  (self: BigDecimal, that: BigDecimal): BigDecimal;
583
595
  };
584
596
  /**
585
597
  * Provides an `Order` instance for `BigDecimal` that allows comparing and sorting BigDecimal values.
586
598
  *
587
- * @example
599
+ * **Example** (Comparing decimals)
600
+ *
588
601
  * ```ts
589
602
  * import { BigDecimal } from "effect"
590
603
  *
@@ -597,330 +610,343 @@ export declare const divideUnsafe: {
597
610
  * console.log(BigDecimal.Order(a, c)) // 0 (a === c)
598
611
  * ```
599
612
  *
600
- * @since 2.0.0
601
613
  * @category instances
614
+ * @since 2.0.0
602
615
  */
603
616
  export declare const Order: order.Order<BigDecimal>;
604
617
  /**
605
618
  * Returns `true` if the first argument is less than the second, otherwise `false`.
606
619
  *
607
- * @example
620
+ * **Example** (Checking less-than comparisons)
621
+ *
608
622
  * ```ts
609
- * import { fromStringUnsafe, isLessThan } from "effect/BigDecimal"
623
+ * import { BigDecimal } from "effect"
610
624
  * import * as assert from "node:assert"
611
625
  *
612
626
  * assert.deepStrictEqual(
613
- * isLessThan(fromStringUnsafe("2"), fromStringUnsafe("3")),
627
+ * BigDecimal.isLessThan(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
614
628
  * true
615
629
  * )
616
630
  * assert.deepStrictEqual(
617
- * isLessThan(fromStringUnsafe("3"), fromStringUnsafe("3")),
631
+ * BigDecimal.isLessThan(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
618
632
  * false
619
633
  * )
620
634
  * assert.deepStrictEqual(
621
- * isLessThan(fromStringUnsafe("4"), fromStringUnsafe("3")),
635
+ * BigDecimal.isLessThan(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
622
636
  * false
623
637
  * )
624
638
  * ```
625
639
  *
626
- * @since 2.0.0
627
640
  * @category predicates
641
+ * @since 4.0.0
628
642
  */
629
643
  export declare const isLessThan: {
630
644
  /**
631
645
  * Returns `true` if the first argument is less than the second, otherwise `false`.
632
646
  *
633
- * @example
647
+ * **Example** (Checking less-than comparisons)
648
+ *
634
649
  * ```ts
635
- * import { fromStringUnsafe, isLessThan } from "effect/BigDecimal"
650
+ * import { BigDecimal } from "effect"
636
651
  * import * as assert from "node:assert"
637
652
  *
638
653
  * assert.deepStrictEqual(
639
- * isLessThan(fromStringUnsafe("2"), fromStringUnsafe("3")),
654
+ * BigDecimal.isLessThan(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
640
655
  * true
641
656
  * )
642
657
  * assert.deepStrictEqual(
643
- * isLessThan(fromStringUnsafe("3"), fromStringUnsafe("3")),
658
+ * BigDecimal.isLessThan(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
644
659
  * false
645
660
  * )
646
661
  * assert.deepStrictEqual(
647
- * isLessThan(fromStringUnsafe("4"), fromStringUnsafe("3")),
662
+ * BigDecimal.isLessThan(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
648
663
  * false
649
664
  * )
650
665
  * ```
651
666
  *
652
- * @since 2.0.0
653
667
  * @category predicates
668
+ * @since 4.0.0
654
669
  */
655
670
  (that: BigDecimal): (self: BigDecimal) => boolean;
656
671
  /**
657
672
  * Returns `true` if the first argument is less than the second, otherwise `false`.
658
673
  *
659
- * @example
674
+ * **Example** (Checking less-than comparisons)
675
+ *
660
676
  * ```ts
661
- * import { fromStringUnsafe, isLessThan } from "effect/BigDecimal"
677
+ * import { BigDecimal } from "effect"
662
678
  * import * as assert from "node:assert"
663
679
  *
664
680
  * assert.deepStrictEqual(
665
- * isLessThan(fromStringUnsafe("2"), fromStringUnsafe("3")),
681
+ * BigDecimal.isLessThan(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
666
682
  * true
667
683
  * )
668
684
  * assert.deepStrictEqual(
669
- * isLessThan(fromStringUnsafe("3"), fromStringUnsafe("3")),
685
+ * BigDecimal.isLessThan(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
670
686
  * false
671
687
  * )
672
688
  * assert.deepStrictEqual(
673
- * isLessThan(fromStringUnsafe("4"), fromStringUnsafe("3")),
689
+ * BigDecimal.isLessThan(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
674
690
  * false
675
691
  * )
676
692
  * ```
677
693
  *
678
- * @since 2.0.0
679
694
  * @category predicates
695
+ * @since 4.0.0
680
696
  */
681
697
  (self: BigDecimal, that: BigDecimal): boolean;
682
698
  };
683
699
  /**
684
700
  * Checks if a given `BigDecimal` is less than or equal to the provided one.
685
701
  *
686
- * @example
702
+ * **Example** (Checking less-than-or-equal comparisons)
703
+ *
687
704
  * ```ts
688
- * import { fromStringUnsafe, isLessThanOrEqualTo } from "effect/BigDecimal"
705
+ * import { BigDecimal } from "effect"
689
706
  * import * as assert from "node:assert"
690
707
  *
691
708
  * assert.deepStrictEqual(
692
- * isLessThanOrEqualTo(fromStringUnsafe("2"), fromStringUnsafe("3")),
709
+ * BigDecimal.isLessThanOrEqualTo(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
693
710
  * true
694
711
  * )
695
712
  * assert.deepStrictEqual(
696
- * isLessThanOrEqualTo(fromStringUnsafe("3"), fromStringUnsafe("3")),
713
+ * BigDecimal.isLessThanOrEqualTo(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
697
714
  * true
698
715
  * )
699
716
  * assert.deepStrictEqual(
700
- * isLessThanOrEqualTo(fromStringUnsafe("4"), fromStringUnsafe("3")),
717
+ * BigDecimal.isLessThanOrEqualTo(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
701
718
  * false
702
719
  * )
703
720
  * ```
704
721
  *
705
- * @since 2.0.0
706
722
  * @category predicates
723
+ * @since 4.0.0
707
724
  */
708
725
  export declare const isLessThanOrEqualTo: {
709
726
  /**
710
727
  * Checks if a given `BigDecimal` is less than or equal to the provided one.
711
728
  *
712
- * @example
729
+ * **Example** (Checking less-than-or-equal comparisons)
730
+ *
713
731
  * ```ts
714
- * import { fromStringUnsafe, isLessThanOrEqualTo } from "effect/BigDecimal"
732
+ * import { BigDecimal } from "effect"
715
733
  * import * as assert from "node:assert"
716
734
  *
717
735
  * assert.deepStrictEqual(
718
- * isLessThanOrEqualTo(fromStringUnsafe("2"), fromStringUnsafe("3")),
736
+ * BigDecimal.isLessThanOrEqualTo(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
719
737
  * true
720
738
  * )
721
739
  * assert.deepStrictEqual(
722
- * isLessThanOrEqualTo(fromStringUnsafe("3"), fromStringUnsafe("3")),
740
+ * BigDecimal.isLessThanOrEqualTo(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
723
741
  * true
724
742
  * )
725
743
  * assert.deepStrictEqual(
726
- * isLessThanOrEqualTo(fromStringUnsafe("4"), fromStringUnsafe("3")),
744
+ * BigDecimal.isLessThanOrEqualTo(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
727
745
  * false
728
746
  * )
729
747
  * ```
730
748
  *
731
- * @since 2.0.0
732
749
  * @category predicates
750
+ * @since 4.0.0
733
751
  */
734
752
  (that: BigDecimal): (self: BigDecimal) => boolean;
735
753
  /**
736
754
  * Checks if a given `BigDecimal` is less than or equal to the provided one.
737
755
  *
738
- * @example
756
+ * **Example** (Checking less-than-or-equal comparisons)
757
+ *
739
758
  * ```ts
740
- * import { fromStringUnsafe, isLessThanOrEqualTo } from "effect/BigDecimal"
759
+ * import { BigDecimal } from "effect"
741
760
  * import * as assert from "node:assert"
742
761
  *
743
762
  * assert.deepStrictEqual(
744
- * isLessThanOrEqualTo(fromStringUnsafe("2"), fromStringUnsafe("3")),
763
+ * BigDecimal.isLessThanOrEqualTo(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
745
764
  * true
746
765
  * )
747
766
  * assert.deepStrictEqual(
748
- * isLessThanOrEqualTo(fromStringUnsafe("3"), fromStringUnsafe("3")),
767
+ * BigDecimal.isLessThanOrEqualTo(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
749
768
  * true
750
769
  * )
751
770
  * assert.deepStrictEqual(
752
- * isLessThanOrEqualTo(fromStringUnsafe("4"), fromStringUnsafe("3")),
771
+ * BigDecimal.isLessThanOrEqualTo(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
753
772
  * false
754
773
  * )
755
774
  * ```
756
775
  *
757
- * @since 2.0.0
758
776
  * @category predicates
777
+ * @since 4.0.0
759
778
  */
760
779
  (self: BigDecimal, that: BigDecimal): boolean;
761
780
  };
762
781
  /**
763
782
  * Returns `true` if the first argument is greater than the second, otherwise `false`.
764
783
  *
765
- * @example
784
+ * **Example** (Checking greater-than comparisons)
785
+ *
766
786
  * ```ts
767
- * import { fromStringUnsafe, isGreaterThan } from "effect/BigDecimal"
787
+ * import { BigDecimal } from "effect"
768
788
  * import * as assert from "node:assert"
769
789
  *
770
790
  * assert.deepStrictEqual(
771
- * isGreaterThan(fromStringUnsafe("2"), fromStringUnsafe("3")),
791
+ * BigDecimal.isGreaterThan(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
772
792
  * false
773
793
  * )
774
794
  * assert.deepStrictEqual(
775
- * isGreaterThan(fromStringUnsafe("3"), fromStringUnsafe("3")),
795
+ * BigDecimal.isGreaterThan(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
776
796
  * false
777
797
  * )
778
798
  * assert.deepStrictEqual(
779
- * isGreaterThan(fromStringUnsafe("4"), fromStringUnsafe("3")),
799
+ * BigDecimal.isGreaterThan(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
780
800
  * true
781
801
  * )
782
802
  * ```
783
803
  *
784
- * @since 2.0.0
785
804
  * @category predicates
805
+ * @since 4.0.0
786
806
  */
787
807
  export declare const isGreaterThan: {
788
808
  /**
789
809
  * Returns `true` if the first argument is greater than the second, otherwise `false`.
790
810
  *
791
- * @example
811
+ * **Example** (Checking greater-than comparisons)
812
+ *
792
813
  * ```ts
793
- * import { fromStringUnsafe, isGreaterThan } from "effect/BigDecimal"
814
+ * import { BigDecimal } from "effect"
794
815
  * import * as assert from "node:assert"
795
816
  *
796
817
  * assert.deepStrictEqual(
797
- * isGreaterThan(fromStringUnsafe("2"), fromStringUnsafe("3")),
818
+ * BigDecimal.isGreaterThan(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
798
819
  * false
799
820
  * )
800
821
  * assert.deepStrictEqual(
801
- * isGreaterThan(fromStringUnsafe("3"), fromStringUnsafe("3")),
822
+ * BigDecimal.isGreaterThan(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
802
823
  * false
803
824
  * )
804
825
  * assert.deepStrictEqual(
805
- * isGreaterThan(fromStringUnsafe("4"), fromStringUnsafe("3")),
826
+ * BigDecimal.isGreaterThan(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
806
827
  * true
807
828
  * )
808
829
  * ```
809
830
  *
810
- * @since 2.0.0
811
831
  * @category predicates
832
+ * @since 4.0.0
812
833
  */
813
834
  (that: BigDecimal): (self: BigDecimal) => boolean;
814
835
  /**
815
836
  * Returns `true` if the first argument is greater than the second, otherwise `false`.
816
837
  *
817
- * @example
838
+ * **Example** (Checking greater-than comparisons)
839
+ *
818
840
  * ```ts
819
- * import { fromStringUnsafe, isGreaterThan } from "effect/BigDecimal"
841
+ * import { BigDecimal } from "effect"
820
842
  * import * as assert from "node:assert"
821
843
  *
822
844
  * assert.deepStrictEqual(
823
- * isGreaterThan(fromStringUnsafe("2"), fromStringUnsafe("3")),
845
+ * BigDecimal.isGreaterThan(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
824
846
  * false
825
847
  * )
826
848
  * assert.deepStrictEqual(
827
- * isGreaterThan(fromStringUnsafe("3"), fromStringUnsafe("3")),
849
+ * BigDecimal.isGreaterThan(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
828
850
  * false
829
851
  * )
830
852
  * assert.deepStrictEqual(
831
- * isGreaterThan(fromStringUnsafe("4"), fromStringUnsafe("3")),
853
+ * BigDecimal.isGreaterThan(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
832
854
  * true
833
855
  * )
834
856
  * ```
835
857
  *
836
- * @since 2.0.0
837
858
  * @category predicates
859
+ * @since 4.0.0
838
860
  */
839
861
  (self: BigDecimal, that: BigDecimal): boolean;
840
862
  };
841
863
  /**
842
864
  * Checks if a given `BigDecimal` is greater than or equal to the provided one.
843
865
  *
844
- * @example
866
+ * **Example** (Checking greater-than-or-equal comparisons)
867
+ *
845
868
  * ```ts
846
- * import { fromStringUnsafe, isGreaterThanOrEqualTo } from "effect/BigDecimal"
869
+ * import { BigDecimal } from "effect"
847
870
  * import * as assert from "node:assert"
848
871
  *
849
872
  * assert.deepStrictEqual(
850
- * isGreaterThanOrEqualTo(fromStringUnsafe("2"), fromStringUnsafe("3")),
873
+ * BigDecimal.isGreaterThanOrEqualTo(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
851
874
  * false
852
875
  * )
853
876
  * assert.deepStrictEqual(
854
- * isGreaterThanOrEqualTo(fromStringUnsafe("3"), fromStringUnsafe("3")),
877
+ * BigDecimal.isGreaterThanOrEqualTo(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
855
878
  * true
856
879
  * )
857
880
  * assert.deepStrictEqual(
858
- * isGreaterThanOrEqualTo(fromStringUnsafe("4"), fromStringUnsafe("3")),
881
+ * BigDecimal.isGreaterThanOrEqualTo(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
859
882
  * true
860
883
  * )
861
884
  * ```
862
885
  *
863
- * @since 2.0.0
864
886
  * @category predicates
887
+ * @since 4.0.0
865
888
  */
866
889
  export declare const isGreaterThanOrEqualTo: {
867
890
  /**
868
891
  * Checks if a given `BigDecimal` is greater than or equal to the provided one.
869
892
  *
870
- * @example
893
+ * **Example** (Checking greater-than-or-equal comparisons)
894
+ *
871
895
  * ```ts
872
- * import { fromStringUnsafe, isGreaterThanOrEqualTo } from "effect/BigDecimal"
896
+ * import { BigDecimal } from "effect"
873
897
  * import * as assert from "node:assert"
874
898
  *
875
899
  * assert.deepStrictEqual(
876
- * isGreaterThanOrEqualTo(fromStringUnsafe("2"), fromStringUnsafe("3")),
900
+ * BigDecimal.isGreaterThanOrEqualTo(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
877
901
  * false
878
902
  * )
879
903
  * assert.deepStrictEqual(
880
- * isGreaterThanOrEqualTo(fromStringUnsafe("3"), fromStringUnsafe("3")),
904
+ * BigDecimal.isGreaterThanOrEqualTo(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
881
905
  * true
882
906
  * )
883
907
  * assert.deepStrictEqual(
884
- * isGreaterThanOrEqualTo(fromStringUnsafe("4"), fromStringUnsafe("3")),
908
+ * BigDecimal.isGreaterThanOrEqualTo(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
885
909
  * true
886
910
  * )
887
911
  * ```
888
912
  *
889
- * @since 2.0.0
890
913
  * @category predicates
914
+ * @since 4.0.0
891
915
  */
892
916
  (that: BigDecimal): (self: BigDecimal) => boolean;
893
917
  /**
894
918
  * Checks if a given `BigDecimal` is greater than or equal to the provided one.
895
919
  *
896
- * @example
920
+ * **Example** (Checking greater-than-or-equal comparisons)
921
+ *
897
922
  * ```ts
898
- * import { fromStringUnsafe, isGreaterThanOrEqualTo } from "effect/BigDecimal"
923
+ * import { BigDecimal } from "effect"
899
924
  * import * as assert from "node:assert"
900
925
  *
901
926
  * assert.deepStrictEqual(
902
- * isGreaterThanOrEqualTo(fromStringUnsafe("2"), fromStringUnsafe("3")),
927
+ * BigDecimal.isGreaterThanOrEqualTo(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
903
928
  * false
904
929
  * )
905
930
  * assert.deepStrictEqual(
906
- * isGreaterThanOrEqualTo(fromStringUnsafe("3"), fromStringUnsafe("3")),
931
+ * BigDecimal.isGreaterThanOrEqualTo(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("3")),
907
932
  * true
908
933
  * )
909
934
  * assert.deepStrictEqual(
910
- * isGreaterThanOrEqualTo(fromStringUnsafe("4"), fromStringUnsafe("3")),
935
+ * BigDecimal.isGreaterThanOrEqualTo(BigDecimal.fromStringUnsafe("4"), BigDecimal.fromStringUnsafe("3")),
911
936
  * true
912
937
  * )
913
938
  * ```
914
939
  *
915
- * @since 2.0.0
916
940
  * @category predicates
941
+ * @since 4.0.0
917
942
  */
918
943
  (self: BigDecimal, that: BigDecimal): boolean;
919
944
  };
920
945
  /**
921
946
  * Checks if a `BigDecimal` is between a `minimum` and `maximum` value (inclusive).
922
947
  *
923
- * @example
948
+ * **Example** (Checking decimal ranges)
949
+ *
924
950
  * ```ts
925
951
  * import { BigDecimal } from "effect"
926
952
  * import * as assert from "node:assert"
@@ -935,14 +961,15 @@ export declare const isGreaterThanOrEqualTo: {
935
961
  * assert.deepStrictEqual(between(BigDecimal.fromStringUnsafe("6")), false)
936
962
  * ```
937
963
  *
938
- * @since 2.0.0
939
964
  * @category predicates
965
+ * @since 2.0.0
940
966
  */
941
967
  export declare const between: {
942
968
  /**
943
969
  * Checks if a `BigDecimal` is between a `minimum` and `maximum` value (inclusive).
944
970
  *
945
- * @example
971
+ * **Example** (Checking decimal ranges)
972
+ *
946
973
  * ```ts
947
974
  * import { BigDecimal } from "effect"
948
975
  * import * as assert from "node:assert"
@@ -957,8 +984,8 @@ export declare const between: {
957
984
  * assert.deepStrictEqual(between(BigDecimal.fromStringUnsafe("6")), false)
958
985
  * ```
959
986
  *
960
- * @since 2.0.0
961
987
  * @category predicates
988
+ * @since 2.0.0
962
989
  */
963
990
  (options: {
964
991
  minimum: BigDecimal;
@@ -967,7 +994,8 @@ export declare const between: {
967
994
  /**
968
995
  * Checks if a `BigDecimal` is between a `minimum` and `maximum` value (inclusive).
969
996
  *
970
- * @example
997
+ * **Example** (Checking decimal ranges)
998
+ *
971
999
  * ```ts
972
1000
  * import { BigDecimal } from "effect"
973
1001
  * import * as assert from "node:assert"
@@ -982,8 +1010,8 @@ export declare const between: {
982
1010
  * assert.deepStrictEqual(between(BigDecimal.fromStringUnsafe("6")), false)
983
1011
  * ```
984
1012
  *
985
- * @since 2.0.0
986
1013
  * @category predicates
1014
+ * @since 2.0.0
987
1015
  */
988
1016
  (self: BigDecimal, options: {
989
1017
  minimum: BigDecimal;
@@ -997,7 +1025,8 @@ export declare const between: {
997
1025
  * - If the `BigDecimal` is greater than the `maximum` value, the function returns the `maximum` value.
998
1026
  * - Otherwise, it returns the original `BigDecimal`.
999
1027
  *
1000
- * @example
1028
+ * **Example** (Clamping decimals to a range)
1029
+ *
1001
1030
  * ```ts
1002
1031
  * import { BigDecimal } from "effect"
1003
1032
  * import * as assert from "node:assert"
@@ -1021,8 +1050,8 @@ export declare const between: {
1021
1050
  * )
1022
1051
  * ```
1023
1052
  *
1024
- * @since 2.0.0
1025
1053
  * @category math
1054
+ * @since 2.0.0
1026
1055
  */
1027
1056
  export declare const clamp: {
1028
1057
  /**
@@ -1032,7 +1061,8 @@ export declare const clamp: {
1032
1061
  * - If the `BigDecimal` is greater than the `maximum` value, the function returns the `maximum` value.
1033
1062
  * - Otherwise, it returns the original `BigDecimal`.
1034
1063
  *
1035
- * @example
1064
+ * **Example** (Clamping decimals to a range)
1065
+ *
1036
1066
  * ```ts
1037
1067
  * import { BigDecimal } from "effect"
1038
1068
  * import * as assert from "node:assert"
@@ -1056,8 +1086,8 @@ export declare const clamp: {
1056
1086
  * )
1057
1087
  * ```
1058
1088
  *
1059
- * @since 2.0.0
1060
1089
  * @category math
1090
+ * @since 2.0.0
1061
1091
  */
1062
1092
  (options: {
1063
1093
  minimum: BigDecimal;
@@ -1070,7 +1100,8 @@ export declare const clamp: {
1070
1100
  * - If the `BigDecimal` is greater than the `maximum` value, the function returns the `maximum` value.
1071
1101
  * - Otherwise, it returns the original `BigDecimal`.
1072
1102
  *
1073
- * @example
1103
+ * **Example** (Clamping decimals to a range)
1104
+ *
1074
1105
  * ```ts
1075
1106
  * import { BigDecimal } from "effect"
1076
1107
  * import * as assert from "node:assert"
@@ -1094,8 +1125,8 @@ export declare const clamp: {
1094
1125
  * )
1095
1126
  * ```
1096
1127
  *
1097
- * @since 2.0.0
1098
1128
  * @category math
1129
+ * @since 2.0.0
1099
1130
  */
1100
1131
  (self: BigDecimal, options: {
1101
1132
  minimum: BigDecimal;
@@ -1105,161 +1136,170 @@ export declare const clamp: {
1105
1136
  /**
1106
1137
  * Returns the minimum between two `BigDecimal`s.
1107
1138
  *
1108
- * @example
1139
+ * **Example** (Selecting the smaller decimal)
1140
+ *
1109
1141
  * ```ts
1110
- * import { fromStringUnsafe, min } from "effect/BigDecimal"
1142
+ * import { BigDecimal } from "effect"
1111
1143
  * import * as assert from "node:assert"
1112
1144
  *
1113
1145
  * assert.deepStrictEqual(
1114
- * min(fromStringUnsafe("2"), fromStringUnsafe("3")),
1115
- * fromStringUnsafe("2")
1146
+ * BigDecimal.min(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
1147
+ * BigDecimal.fromStringUnsafe("2")
1116
1148
  * )
1117
1149
  * ```
1118
1150
  *
1119
- * @since 2.0.0
1120
1151
  * @category math
1152
+ * @since 2.0.0
1121
1153
  */
1122
1154
  export declare const min: {
1123
1155
  /**
1124
1156
  * Returns the minimum between two `BigDecimal`s.
1125
1157
  *
1126
- * @example
1158
+ * **Example** (Selecting the smaller decimal)
1159
+ *
1127
1160
  * ```ts
1128
- * import { fromStringUnsafe, min } from "effect/BigDecimal"
1161
+ * import { BigDecimal } from "effect"
1129
1162
  * import * as assert from "node:assert"
1130
1163
  *
1131
1164
  * assert.deepStrictEqual(
1132
- * min(fromStringUnsafe("2"), fromStringUnsafe("3")),
1133
- * fromStringUnsafe("2")
1165
+ * BigDecimal.min(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
1166
+ * BigDecimal.fromStringUnsafe("2")
1134
1167
  * )
1135
1168
  * ```
1136
1169
  *
1137
- * @since 2.0.0
1138
1170
  * @category math
1171
+ * @since 2.0.0
1139
1172
  */
1140
1173
  (that: BigDecimal): (self: BigDecimal) => BigDecimal;
1141
1174
  /**
1142
1175
  * Returns the minimum between two `BigDecimal`s.
1143
1176
  *
1144
- * @example
1177
+ * **Example** (Selecting the smaller decimal)
1178
+ *
1145
1179
  * ```ts
1146
- * import { fromStringUnsafe, min } from "effect/BigDecimal"
1180
+ * import { BigDecimal } from "effect"
1147
1181
  * import * as assert from "node:assert"
1148
1182
  *
1149
1183
  * assert.deepStrictEqual(
1150
- * min(fromStringUnsafe("2"), fromStringUnsafe("3")),
1151
- * fromStringUnsafe("2")
1184
+ * BigDecimal.min(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
1185
+ * BigDecimal.fromStringUnsafe("2")
1152
1186
  * )
1153
1187
  * ```
1154
1188
  *
1155
- * @since 2.0.0
1156
1189
  * @category math
1190
+ * @since 2.0.0
1157
1191
  */
1158
1192
  (self: BigDecimal, that: BigDecimal): BigDecimal;
1159
1193
  };
1160
1194
  /**
1161
1195
  * Returns the maximum between two `BigDecimal`s.
1162
1196
  *
1163
- * @example
1197
+ * **Example** (Selecting the larger decimal)
1198
+ *
1164
1199
  * ```ts
1165
- * import { fromStringUnsafe, max } from "effect/BigDecimal"
1200
+ * import { BigDecimal } from "effect"
1166
1201
  * import * as assert from "node:assert"
1167
1202
  *
1168
1203
  * assert.deepStrictEqual(
1169
- * max(fromStringUnsafe("2"), fromStringUnsafe("3")),
1170
- * fromStringUnsafe("3")
1204
+ * BigDecimal.max(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
1205
+ * BigDecimal.fromStringUnsafe("3")
1171
1206
  * )
1172
1207
  * ```
1173
1208
  *
1174
- * @since 2.0.0
1175
1209
  * @category math
1210
+ * @since 2.0.0
1176
1211
  */
1177
1212
  export declare const max: {
1178
1213
  /**
1179
1214
  * Returns the maximum between two `BigDecimal`s.
1180
1215
  *
1181
- * @example
1216
+ * **Example** (Selecting the larger decimal)
1217
+ *
1182
1218
  * ```ts
1183
- * import { fromStringUnsafe, max } from "effect/BigDecimal"
1219
+ * import { BigDecimal } from "effect"
1184
1220
  * import * as assert from "node:assert"
1185
1221
  *
1186
1222
  * assert.deepStrictEqual(
1187
- * max(fromStringUnsafe("2"), fromStringUnsafe("3")),
1188
- * fromStringUnsafe("3")
1223
+ * BigDecimal.max(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
1224
+ * BigDecimal.fromStringUnsafe("3")
1189
1225
  * )
1190
1226
  * ```
1191
1227
  *
1192
- * @since 2.0.0
1193
1228
  * @category math
1229
+ * @since 2.0.0
1194
1230
  */
1195
1231
  (that: BigDecimal): (self: BigDecimal) => BigDecimal;
1196
1232
  /**
1197
1233
  * Returns the maximum between two `BigDecimal`s.
1198
1234
  *
1199
- * @example
1235
+ * **Example** (Selecting the larger decimal)
1236
+ *
1200
1237
  * ```ts
1201
- * import { fromStringUnsafe, max } from "effect/BigDecimal"
1238
+ * import { BigDecimal } from "effect"
1202
1239
  * import * as assert from "node:assert"
1203
1240
  *
1204
1241
  * assert.deepStrictEqual(
1205
- * max(fromStringUnsafe("2"), fromStringUnsafe("3")),
1206
- * fromStringUnsafe("3")
1242
+ * BigDecimal.max(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("3")),
1243
+ * BigDecimal.fromStringUnsafe("3")
1207
1244
  * )
1208
1245
  * ```
1209
1246
  *
1210
- * @since 2.0.0
1211
1247
  * @category math
1248
+ * @since 2.0.0
1212
1249
  */
1213
1250
  (self: BigDecimal, that: BigDecimal): BigDecimal;
1214
1251
  };
1215
1252
  /**
1216
1253
  * Determines the sign of a given `BigDecimal`.
1217
1254
  *
1218
- * @example
1255
+ * **Example** (Reading decimal signs)
1256
+ *
1219
1257
  * ```ts
1220
- * import { fromStringUnsafe, sign } from "effect/BigDecimal"
1258
+ * import { BigDecimal } from "effect"
1221
1259
  * import * as assert from "node:assert"
1222
1260
  *
1223
- * assert.deepStrictEqual(sign(fromStringUnsafe("-5")), -1)
1224
- * assert.deepStrictEqual(sign(fromStringUnsafe("0")), 0)
1225
- * assert.deepStrictEqual(sign(fromStringUnsafe("5")), 1)
1261
+ * assert.deepStrictEqual(BigDecimal.sign(BigDecimal.fromStringUnsafe("-5")), -1)
1262
+ * assert.deepStrictEqual(BigDecimal.sign(BigDecimal.fromStringUnsafe("0")), 0)
1263
+ * assert.deepStrictEqual(BigDecimal.sign(BigDecimal.fromStringUnsafe("5")), 1)
1226
1264
  * ```
1227
1265
  *
1228
- * @since 2.0.0
1229
1266
  * @category math
1267
+ * @since 2.0.0
1230
1268
  */
1231
1269
  export declare const sign: (n: BigDecimal) => Ordering;
1232
1270
  /**
1233
1271
  * Determines the absolute value of a given `BigDecimal`.
1234
1272
  *
1235
- * @example
1273
+ * **Example** (Calculating absolute values)
1274
+ *
1236
1275
  * ```ts
1237
- * import { abs, fromStringUnsafe } from "effect/BigDecimal"
1276
+ * import { BigDecimal } from "effect"
1238
1277
  * import * as assert from "node:assert"
1239
1278
  *
1240
- * assert.deepStrictEqual(abs(fromStringUnsafe("-5")), fromStringUnsafe("5"))
1241
- * assert.deepStrictEqual(abs(fromStringUnsafe("0")), fromStringUnsafe("0"))
1242
- * assert.deepStrictEqual(abs(fromStringUnsafe("5")), fromStringUnsafe("5"))
1279
+ * assert.deepStrictEqual(BigDecimal.abs(BigDecimal.fromStringUnsafe("-5")), BigDecimal.fromStringUnsafe("5"))
1280
+ * assert.deepStrictEqual(BigDecimal.abs(BigDecimal.fromStringUnsafe("0")), BigDecimal.fromStringUnsafe("0"))
1281
+ * assert.deepStrictEqual(BigDecimal.abs(BigDecimal.fromStringUnsafe("5")), BigDecimal.fromStringUnsafe("5"))
1243
1282
  * ```
1244
1283
  *
1245
- * @since 2.0.0
1246
1284
  * @category math
1285
+ * @since 2.0.0
1247
1286
  */
1248
1287
  export declare const abs: (n: BigDecimal) => BigDecimal;
1249
1288
  /**
1250
1289
  * Provides a negate operation on `BigDecimal`s.
1251
1290
  *
1252
- * @example
1291
+ * **Example** (Negating decimals)
1292
+ *
1253
1293
  * ```ts
1254
- * import { fromStringUnsafe, negate } from "effect/BigDecimal"
1294
+ * import { BigDecimal } from "effect"
1255
1295
  * import * as assert from "node:assert"
1256
1296
  *
1257
- * assert.deepStrictEqual(negate(fromStringUnsafe("3")), fromStringUnsafe("-3"))
1258
- * assert.deepStrictEqual(negate(fromStringUnsafe("-6")), fromStringUnsafe("6"))
1297
+ * assert.deepStrictEqual(BigDecimal.negate(BigDecimal.fromStringUnsafe("3")), BigDecimal.fromStringUnsafe("-3"))
1298
+ * assert.deepStrictEqual(BigDecimal.negate(BigDecimal.fromStringUnsafe("-6")), BigDecimal.fromStringUnsafe("6"))
1259
1299
  * ```
1260
1300
  *
1261
- * @since 2.0.0
1262
1301
  * @category math
1302
+ * @since 2.0.0
1263
1303
  */
1264
1304
  export declare const negate: (n: BigDecimal) => BigDecimal;
1265
1305
  /**
@@ -1267,7 +1307,8 @@ export declare const negate: (n: BigDecimal) => BigDecimal;
1267
1307
  *
1268
1308
  * If the divisor is `0`, the result will be `Option.none()`.
1269
1309
  *
1270
- * @example
1310
+ * **Example** (Computing remainders safely)
1311
+ *
1271
1312
  * ```ts
1272
1313
  * import { BigDecimal, Option } from "effect"
1273
1314
  * import * as assert from "node:assert"
@@ -1295,8 +1336,8 @@ export declare const negate: (n: BigDecimal) => BigDecimal;
1295
1336
  * )
1296
1337
  * ```
1297
1338
  *
1298
- * @since 2.0.0
1299
1339
  * @category math
1340
+ * @since 2.0.0
1300
1341
  */
1301
1342
  export declare const remainder: {
1302
1343
  /**
@@ -1304,7 +1345,8 @@ export declare const remainder: {
1304
1345
  *
1305
1346
  * If the divisor is `0`, the result will be `Option.none()`.
1306
1347
  *
1307
- * @example
1348
+ * **Example** (Computing remainders safely)
1349
+ *
1308
1350
  * ```ts
1309
1351
  * import { BigDecimal, Option } from "effect"
1310
1352
  * import * as assert from "node:assert"
@@ -1332,8 +1374,8 @@ export declare const remainder: {
1332
1374
  * )
1333
1375
  * ```
1334
1376
  *
1335
- * @since 2.0.0
1336
1377
  * @category math
1378
+ * @since 2.0.0
1337
1379
  */
1338
1380
  (divisor: BigDecimal): (self: BigDecimal) => Option.Option<BigDecimal>;
1339
1381
  /**
@@ -1341,7 +1383,8 @@ export declare const remainder: {
1341
1383
  *
1342
1384
  * If the divisor is `0`, the result will be `Option.none()`.
1343
1385
  *
1344
- * @example
1386
+ * **Example** (Computing remainders safely)
1387
+ *
1345
1388
  * ```ts
1346
1389
  * import { BigDecimal, Option } from "effect"
1347
1390
  * import * as assert from "node:assert"
@@ -1369,8 +1412,8 @@ export declare const remainder: {
1369
1412
  * )
1370
1413
  * ```
1371
1414
  *
1372
- * @since 2.0.0
1373
1415
  * @category math
1416
+ * @since 2.0.0
1374
1417
  */
1375
1418
  (self: BigDecimal, divisor: BigDecimal): Option.Option<BigDecimal>;
1376
1419
  };
@@ -1379,27 +1422,28 @@ export declare const remainder: {
1379
1422
  *
1380
1423
  * Throws a `RangeError` if the divisor is `0`.
1381
1424
  *
1382
- * @example
1425
+ * **Example** (Computing remainders unsafely)
1426
+ *
1383
1427
  * ```ts
1384
- * import { fromStringUnsafe, remainderUnsafe } from "effect/BigDecimal"
1428
+ * import { BigDecimal } from "effect"
1385
1429
  * import * as assert from "node:assert"
1386
1430
  *
1387
1431
  * assert.deepStrictEqual(
1388
- * remainderUnsafe(fromStringUnsafe("2"), fromStringUnsafe("2")),
1389
- * fromStringUnsafe("0")
1432
+ * BigDecimal.remainderUnsafe(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("2")),
1433
+ * BigDecimal.fromStringUnsafe("0")
1390
1434
  * )
1391
1435
  * assert.deepStrictEqual(
1392
- * remainderUnsafe(fromStringUnsafe("3"), fromStringUnsafe("2")),
1393
- * fromStringUnsafe("1")
1436
+ * BigDecimal.remainderUnsafe(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("2")),
1437
+ * BigDecimal.fromStringUnsafe("1")
1394
1438
  * )
1395
1439
  * assert.deepStrictEqual(
1396
- * remainderUnsafe(fromStringUnsafe("-4"), fromStringUnsafe("2")),
1397
- * fromStringUnsafe("0")
1440
+ * BigDecimal.remainderUnsafe(BigDecimal.fromStringUnsafe("-4"), BigDecimal.fromStringUnsafe("2")),
1441
+ * BigDecimal.fromStringUnsafe("0")
1398
1442
  * )
1399
1443
  * ```
1400
1444
  *
1401
- * @since 2.0.0
1402
1445
  * @category math
1446
+ * @since 4.0.0
1403
1447
  */
1404
1448
  export declare const remainderUnsafe: {
1405
1449
  /**
@@ -1407,27 +1451,28 @@ export declare const remainderUnsafe: {
1407
1451
  *
1408
1452
  * Throws a `RangeError` if the divisor is `0`.
1409
1453
  *
1410
- * @example
1454
+ * **Example** (Computing remainders unsafely)
1455
+ *
1411
1456
  * ```ts
1412
- * import { fromStringUnsafe, remainderUnsafe } from "effect/BigDecimal"
1457
+ * import { BigDecimal } from "effect"
1413
1458
  * import * as assert from "node:assert"
1414
1459
  *
1415
1460
  * assert.deepStrictEqual(
1416
- * remainderUnsafe(fromStringUnsafe("2"), fromStringUnsafe("2")),
1417
- * fromStringUnsafe("0")
1461
+ * BigDecimal.remainderUnsafe(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("2")),
1462
+ * BigDecimal.fromStringUnsafe("0")
1418
1463
  * )
1419
1464
  * assert.deepStrictEqual(
1420
- * remainderUnsafe(fromStringUnsafe("3"), fromStringUnsafe("2")),
1421
- * fromStringUnsafe("1")
1465
+ * BigDecimal.remainderUnsafe(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("2")),
1466
+ * BigDecimal.fromStringUnsafe("1")
1422
1467
  * )
1423
1468
  * assert.deepStrictEqual(
1424
- * remainderUnsafe(fromStringUnsafe("-4"), fromStringUnsafe("2")),
1425
- * fromStringUnsafe("0")
1469
+ * BigDecimal.remainderUnsafe(BigDecimal.fromStringUnsafe("-4"), BigDecimal.fromStringUnsafe("2")),
1470
+ * BigDecimal.fromStringUnsafe("0")
1426
1471
  * )
1427
1472
  * ```
1428
1473
  *
1429
- * @since 2.0.0
1430
1474
  * @category math
1475
+ * @since 4.0.0
1431
1476
  */
1432
1477
  (divisor: BigDecimal): (self: BigDecimal) => BigDecimal;
1433
1478
  /**
@@ -1435,40 +1480,42 @@ export declare const remainderUnsafe: {
1435
1480
  *
1436
1481
  * Throws a `RangeError` if the divisor is `0`.
1437
1482
  *
1438
- * @example
1483
+ * **Example** (Computing remainders unsafely)
1484
+ *
1439
1485
  * ```ts
1440
- * import { fromStringUnsafe, remainderUnsafe } from "effect/BigDecimal"
1486
+ * import { BigDecimal } from "effect"
1441
1487
  * import * as assert from "node:assert"
1442
1488
  *
1443
1489
  * assert.deepStrictEqual(
1444
- * remainderUnsafe(fromStringUnsafe("2"), fromStringUnsafe("2")),
1445
- * fromStringUnsafe("0")
1490
+ * BigDecimal.remainderUnsafe(BigDecimal.fromStringUnsafe("2"), BigDecimal.fromStringUnsafe("2")),
1491
+ * BigDecimal.fromStringUnsafe("0")
1446
1492
  * )
1447
1493
  * assert.deepStrictEqual(
1448
- * remainderUnsafe(fromStringUnsafe("3"), fromStringUnsafe("2")),
1449
- * fromStringUnsafe("1")
1494
+ * BigDecimal.remainderUnsafe(BigDecimal.fromStringUnsafe("3"), BigDecimal.fromStringUnsafe("2")),
1495
+ * BigDecimal.fromStringUnsafe("1")
1450
1496
  * )
1451
1497
  * assert.deepStrictEqual(
1452
- * remainderUnsafe(fromStringUnsafe("-4"), fromStringUnsafe("2")),
1453
- * fromStringUnsafe("0")
1498
+ * BigDecimal.remainderUnsafe(BigDecimal.fromStringUnsafe("-4"), BigDecimal.fromStringUnsafe("2")),
1499
+ * BigDecimal.fromStringUnsafe("0")
1454
1500
  * )
1455
1501
  * ```
1456
1502
  *
1457
- * @since 2.0.0
1458
1503
  * @category math
1504
+ * @since 4.0.0
1459
1505
  */
1460
1506
  (self: BigDecimal, divisor: BigDecimal): BigDecimal;
1461
1507
  };
1462
1508
  /**
1463
1509
  * Provides an `Equivalence` instance for `BigDecimal` that determines equality between BigDecimal values.
1464
1510
  *
1465
- * @example
1511
+ * **Example** (Checking decimal equivalence)
1512
+ *
1466
1513
  * ```ts
1467
1514
  * import { BigDecimal } from "effect"
1468
1515
  *
1469
- * const a = BigDecimal.fromNumberUnsafe(1.50)
1470
- * const b = BigDecimal.fromNumberUnsafe(1.5)
1471
- * const c = BigDecimal.fromNumberUnsafe(2.0)
1516
+ * const a = BigDecimal.fromStringUnsafe("1.50")
1517
+ * const b = BigDecimal.fromStringUnsafe("1.5")
1518
+ * const c = BigDecimal.fromStringUnsafe("2.0")
1472
1519
  *
1473
1520
  * console.log(BigDecimal.Equivalence(a, b)) // true (1.50 === 1.5)
1474
1521
  * console.log(BigDecimal.Equivalence(a, c)) // false (1.50 !== 2.0)
@@ -1481,65 +1528,69 @@ export declare const Equivalence: Equ.Equivalence<BigDecimal>;
1481
1528
  /**
1482
1529
  * Checks if two `BigDecimal`s are equal.
1483
1530
  *
1484
- * @example
1531
+ * **Example** (Checking decimal equality)
1532
+ *
1485
1533
  * ```ts
1486
1534
  * import { BigDecimal } from "effect"
1487
1535
  *
1488
- * const a = BigDecimal.fromNumberUnsafe(1.5)
1489
- * const b = BigDecimal.fromNumberUnsafe(1.50)
1490
- * const c = BigDecimal.fromNumberUnsafe(2.0)
1536
+ * const a = BigDecimal.fromStringUnsafe("1.5")
1537
+ * const b = BigDecimal.fromStringUnsafe("1.50")
1538
+ * const c = BigDecimal.fromStringUnsafe("2.0")
1491
1539
  *
1492
1540
  * console.log(BigDecimal.equals(a, b)) // true
1493
1541
  * console.log(BigDecimal.equals(a, c)) // false
1494
1542
  * ```
1495
1543
  *
1496
- * @since 2.0.0
1497
1544
  * @category predicates
1545
+ * @since 2.0.0
1498
1546
  */
1499
1547
  export declare const equals: {
1500
1548
  /**
1501
1549
  * Checks if two `BigDecimal`s are equal.
1502
1550
  *
1503
- * @example
1551
+ * **Example** (Checking decimal equality)
1552
+ *
1504
1553
  * ```ts
1505
1554
  * import { BigDecimal } from "effect"
1506
1555
  *
1507
- * const a = BigDecimal.fromNumberUnsafe(1.5)
1508
- * const b = BigDecimal.fromNumberUnsafe(1.50)
1509
- * const c = BigDecimal.fromNumberUnsafe(2.0)
1556
+ * const a = BigDecimal.fromStringUnsafe("1.5")
1557
+ * const b = BigDecimal.fromStringUnsafe("1.50")
1558
+ * const c = BigDecimal.fromStringUnsafe("2.0")
1510
1559
  *
1511
1560
  * console.log(BigDecimal.equals(a, b)) // true
1512
1561
  * console.log(BigDecimal.equals(a, c)) // false
1513
1562
  * ```
1514
1563
  *
1515
- * @since 2.0.0
1516
1564
  * @category predicates
1565
+ * @since 2.0.0
1517
1566
  */
1518
1567
  (that: BigDecimal): (self: BigDecimal) => boolean;
1519
1568
  /**
1520
1569
  * Checks if two `BigDecimal`s are equal.
1521
1570
  *
1522
- * @example
1571
+ * **Example** (Checking decimal equality)
1572
+ *
1523
1573
  * ```ts
1524
1574
  * import { BigDecimal } from "effect"
1525
1575
  *
1526
- * const a = BigDecimal.fromNumberUnsafe(1.5)
1527
- * const b = BigDecimal.fromNumberUnsafe(1.50)
1528
- * const c = BigDecimal.fromNumberUnsafe(2.0)
1576
+ * const a = BigDecimal.fromStringUnsafe("1.5")
1577
+ * const b = BigDecimal.fromStringUnsafe("1.50")
1578
+ * const c = BigDecimal.fromStringUnsafe("2.0")
1529
1579
  *
1530
1580
  * console.log(BigDecimal.equals(a, b)) // true
1531
1581
  * console.log(BigDecimal.equals(a, c)) // false
1532
1582
  * ```
1533
1583
  *
1534
- * @since 2.0.0
1535
1584
  * @category predicates
1585
+ * @since 2.0.0
1536
1586
  */
1537
1587
  (self: BigDecimal, that: BigDecimal): boolean;
1538
1588
  };
1539
1589
  /**
1540
1590
  * Creates a `BigDecimal` from a `bigint` value.
1541
1591
  *
1542
- * @example
1592
+ * **Example** (Creating decimals from bigint)
1593
+ *
1543
1594
  * ```ts
1544
1595
  * import { BigDecimal } from "effect"
1545
1596
  *
@@ -1550,8 +1601,8 @@ export declare const equals: {
1550
1601
  * console.log(BigDecimal.format(largeBigInt)) // "9007199254740991"
1551
1602
  * ```
1552
1603
  *
1553
- * @since 2.0.0
1554
1604
  * @category constructors
1605
+ * @since 2.0.0
1555
1606
  */
1556
1607
  export declare const fromBigInt: (n: bigint) => BigDecimal;
1557
1608
  /**
@@ -1562,17 +1613,18 @@ export declare const fromBigInt: (n: bigint) => BigDecimal;
1562
1613
  *
1563
1614
  * Throws a `RangeError` if the number is not finite (`NaN`, `+Infinity` or `-Infinity`).
1564
1615
  *
1565
- * @example
1616
+ * **Example** (Creating decimals from finite numbers)
1617
+ *
1566
1618
  * ```ts
1567
- * import { fromNumberUnsafe, make } from "effect/BigDecimal"
1619
+ * import { BigDecimal } from "effect"
1568
1620
  * import * as assert from "node:assert"
1569
1621
  *
1570
- * assert.deepStrictEqual(fromNumberUnsafe(123), make(123n, 0))
1571
- * assert.deepStrictEqual(fromNumberUnsafe(123.456), make(123456n, 3))
1622
+ * assert.deepStrictEqual(BigDecimal.fromNumberUnsafe(123), BigDecimal.make(123n, 0))
1623
+ * assert.deepStrictEqual(BigDecimal.fromNumberUnsafe(123.456), BigDecimal.make(123456n, 3))
1572
1624
  * ```
1573
1625
  *
1574
- * @since 4.0.0
1575
1626
  * @category constructors
1627
+ * @since 4.0.0
1576
1628
  */
1577
1629
  export declare const fromNumberUnsafe: (n: number) => BigDecimal;
1578
1630
  /**
@@ -1583,7 +1635,8 @@ export declare const fromNumberUnsafe: (n: number) => BigDecimal;
1583
1635
  *
1584
1636
  * Returns `Option.none()` for `NaN`, `+Infinity` or `-Infinity`.
1585
1637
  *
1586
- * @example
1638
+ * **Example** (Creating decimals from numbers safely)
1639
+ *
1587
1640
  * ```ts
1588
1641
  * import { BigDecimal, Option } from "effect"
1589
1642
  * import * as assert from "node:assert"
@@ -1596,14 +1649,19 @@ export declare const fromNumberUnsafe: (n: number) => BigDecimal;
1596
1649
  * assert.deepStrictEqual(BigDecimal.fromNumber(Infinity), Option.none())
1597
1650
  * ```
1598
1651
  *
1599
- * @since 4.0.0
1600
1652
  * @category constructors
1653
+ * @since 2.0.0
1601
1654
  */
1602
1655
  export declare const fromNumber: (n: number) => Option.Option<BigDecimal>;
1603
1656
  /**
1604
- * Parses a numerical `string` into a `BigDecimal`.
1657
+ * Safely parses a decimal string into a `BigDecimal`.
1658
+ *
1659
+ * Returns `Option.some` for valid decimal or exponent notation and
1660
+ * `Option.none` when the string cannot be parsed or would produce an unsafe
1661
+ * scale. The empty string parses as zero.
1662
+ *
1663
+ * **Example** (Parsing decimal strings safely)
1605
1664
  *
1606
- * @example
1607
1665
  * ```ts
1608
1666
  * import { BigDecimal, Option } from "effect"
1609
1667
  * import * as assert from "node:assert"
@@ -1616,144 +1674,159 @@ export declare const fromNumber: (n: number) => Option.Option<BigDecimal>;
1616
1674
  * assert.deepStrictEqual(BigDecimal.fromString("123.abc"), Option.none())
1617
1675
  * ```
1618
1676
  *
1619
- * @since 2.0.0
1620
1677
  * @category constructors
1678
+ * @since 2.0.0
1621
1679
  */
1622
1680
  export declare const fromString: (s: string) => Option.Option<BigDecimal>;
1623
1681
  /**
1624
- * Parses a numerical `string` into a `BigDecimal`.
1682
+ * Parses a decimal string into a `BigDecimal`, throwing if the string is
1683
+ * invalid.
1684
+ *
1685
+ * Accepts the same syntax as `fromString`. Use `fromString` when invalid input
1686
+ * should be represented as `Option.none` instead of throwing.
1687
+ *
1688
+ * **Example** (Parsing decimal strings unsafely)
1625
1689
  *
1626
- * @example
1627
1690
  * ```ts
1628
- * import { fromStringUnsafe, make } from "effect/BigDecimal"
1691
+ * import { BigDecimal } from "effect"
1629
1692
  * import * as assert from "node:assert"
1630
1693
  *
1631
- * assert.deepStrictEqual(fromStringUnsafe("123"), make(123n, 0))
1632
- * assert.deepStrictEqual(fromStringUnsafe("123.456"), make(123456n, 3))
1633
- * assert.throws(() => fromStringUnsafe("123.abc"))
1694
+ * assert.deepStrictEqual(BigDecimal.fromStringUnsafe("123"), BigDecimal.make(123n, 0))
1695
+ * assert.deepStrictEqual(BigDecimal.fromStringUnsafe("123.456"), BigDecimal.make(123456n, 3))
1696
+ * assert.throws(() => BigDecimal.fromStringUnsafe("123.abc"))
1634
1697
  * ```
1635
1698
  *
1636
- * @since 2.0.0
1637
1699
  * @category constructors
1700
+ * @since 4.0.0
1638
1701
  */
1639
1702
  export declare const fromStringUnsafe: (s: string) => BigDecimal;
1640
1703
  /**
1641
- * Formats a given `BigDecimal` as a `string`.
1704
+ * Formats a `BigDecimal` as a string.
1642
1705
  *
1643
- * If the scale of the `BigDecimal` is greater than or equal to 16, the `BigDecimal` will
1644
- * be formatted in scientific notation.
1706
+ * The value is normalized before formatting. Scientific notation is used when
1707
+ * the absolute value of the normalized scale is at least `16`; otherwise plain
1708
+ * decimal notation is used.
1709
+ *
1710
+ * **Example** (Formatting decimals)
1645
1711
  *
1646
- * @example
1647
1712
  * ```ts
1648
- * import { format, fromStringUnsafe } from "effect/BigDecimal"
1713
+ * import { BigDecimal } from "effect"
1649
1714
  * import * as assert from "node:assert"
1650
1715
  *
1651
- * assert.deepStrictEqual(format(fromStringUnsafe("-5")), "-5")
1652
- * assert.deepStrictEqual(format(fromStringUnsafe("123.456")), "123.456")
1653
- * assert.deepStrictEqual(format(fromStringUnsafe("-0.00000123")), "-0.00000123")
1716
+ * assert.deepStrictEqual(BigDecimal.format(BigDecimal.fromStringUnsafe("-5")), "-5")
1717
+ * assert.deepStrictEqual(BigDecimal.format(BigDecimal.fromStringUnsafe("123.456")), "123.456")
1718
+ * assert.deepStrictEqual(BigDecimal.format(BigDecimal.fromStringUnsafe("-0.00000123")), "-0.00000123")
1654
1719
  * ```
1655
1720
  *
1721
+ * @category converting
1656
1722
  * @since 2.0.0
1657
- * @category conversions
1658
1723
  */
1659
1724
  export declare const format: (n: BigDecimal) => string;
1660
1725
  /**
1661
1726
  * Formats a given `BigDecimal` as a `string` in scientific notation.
1662
1727
  *
1663
- * @example
1728
+ * **Example** (Formatting decimals exponentially)
1729
+ *
1664
1730
  * ```ts
1665
- * import { make, toExponential } from "effect/BigDecimal"
1731
+ * import { BigDecimal } from "effect"
1666
1732
  * import * as assert from "node:assert"
1667
1733
  *
1668
- * assert.deepStrictEqual(toExponential(make(123456n, -5)), "1.23456e+10")
1734
+ * assert.deepStrictEqual(BigDecimal.toExponential(BigDecimal.make(123456n, -5)), "1.23456e+10")
1669
1735
  * ```
1670
1736
  *
1671
- * @since 4.0.0
1672
- * @category conversions
1737
+ * @category converting
1738
+ * @since 3.11.0
1673
1739
  */
1674
1740
  export declare const toExponential: (n: BigDecimal) => string;
1675
1741
  /**
1676
- * Converts a `BigDecimal` to a `number`.
1742
+ * Converts a `BigDecimal` to a JavaScript `number`.
1743
+ *
1744
+ * This conversion is unsafe because the result can lose integer or fractional
1745
+ * precision, round to a nearby representable value, or become `Infinity` when
1746
+ * the decimal cannot be represented as a finite JavaScript `number`.
1677
1747
  *
1678
- * This function will produce incorrect results if the `BigDecimal` exceeds the 64-bit range of a `number`.
1748
+ * **Example** (Converting decimals to numbers)
1679
1749
  *
1680
- * @example
1681
1750
  * ```ts
1682
- * import { fromStringUnsafe, toNumberUnsafe } from "effect/BigDecimal"
1751
+ * import { BigDecimal } from "effect"
1683
1752
  * import * as assert from "node:assert"
1684
1753
  *
1685
- * assert.deepStrictEqual(toNumberUnsafe(fromStringUnsafe("123.456")), 123.456)
1754
+ * assert.deepStrictEqual(BigDecimal.toNumberUnsafe(BigDecimal.fromStringUnsafe("123.456")), 123.456)
1686
1755
  * ```
1687
1756
  *
1688
- * @since 2.0.0
1689
- * @category conversions
1757
+ * @category converting
1758
+ * @since 4.0.0
1690
1759
  */
1691
1760
  export declare const toNumberUnsafe: (n: BigDecimal) => number;
1692
1761
  /**
1693
1762
  * Checks if a given `BigDecimal` is an integer.
1694
1763
  *
1695
- * @example
1764
+ * **Example** (Checking integer decimals)
1765
+ *
1696
1766
  * ```ts
1697
- * import { fromStringUnsafe, isInteger } from "effect/BigDecimal"
1767
+ * import { BigDecimal } from "effect"
1698
1768
  * import * as assert from "node:assert"
1699
1769
  *
1700
- * assert.deepStrictEqual(isInteger(fromStringUnsafe("0")), true)
1701
- * assert.deepStrictEqual(isInteger(fromStringUnsafe("1")), true)
1702
- * assert.deepStrictEqual(isInteger(fromStringUnsafe("1.1")), false)
1770
+ * assert.deepStrictEqual(BigDecimal.isInteger(BigDecimal.fromStringUnsafe("0")), true)
1771
+ * assert.deepStrictEqual(BigDecimal.isInteger(BigDecimal.fromStringUnsafe("1")), true)
1772
+ * assert.deepStrictEqual(BigDecimal.isInteger(BigDecimal.fromStringUnsafe("1.1")), false)
1703
1773
  * ```
1704
1774
  *
1705
- * @since 2.0.0
1706
1775
  * @category predicates
1776
+ * @since 2.0.0
1707
1777
  */
1708
1778
  export declare const isInteger: (n: BigDecimal) => boolean;
1709
1779
  /**
1710
1780
  * Checks if a given `BigDecimal` is `0`.
1711
1781
  *
1712
- * @example
1782
+ * **Example** (Checking zero decimals)
1783
+ *
1713
1784
  * ```ts
1714
- * import { fromStringUnsafe, isZero } from "effect/BigDecimal"
1785
+ * import { BigDecimal } from "effect"
1715
1786
  * import * as assert from "node:assert"
1716
1787
  *
1717
- * assert.deepStrictEqual(isZero(fromStringUnsafe("0")), true)
1718
- * assert.deepStrictEqual(isZero(fromStringUnsafe("1")), false)
1788
+ * assert.deepStrictEqual(BigDecimal.isZero(BigDecimal.fromStringUnsafe("0")), true)
1789
+ * assert.deepStrictEqual(BigDecimal.isZero(BigDecimal.fromStringUnsafe("1")), false)
1719
1790
  * ```
1720
1791
  *
1721
- * @since 2.0.0
1722
1792
  * @category predicates
1793
+ * @since 2.0.0
1723
1794
  */
1724
1795
  export declare const isZero: (n: BigDecimal) => boolean;
1725
1796
  /**
1726
1797
  * Checks if a given `BigDecimal` is negative.
1727
1798
  *
1728
- * @example
1799
+ * **Example** (Checking negative decimals)
1800
+ *
1729
1801
  * ```ts
1730
- * import { fromStringUnsafe, isNegative } from "effect/BigDecimal"
1802
+ * import { BigDecimal } from "effect"
1731
1803
  * import * as assert from "node:assert"
1732
1804
  *
1733
- * assert.deepStrictEqual(isNegative(fromStringUnsafe("-1")), true)
1734
- * assert.deepStrictEqual(isNegative(fromStringUnsafe("0")), false)
1735
- * assert.deepStrictEqual(isNegative(fromStringUnsafe("1")), false)
1805
+ * assert.deepStrictEqual(BigDecimal.isNegative(BigDecimal.fromStringUnsafe("-1")), true)
1806
+ * assert.deepStrictEqual(BigDecimal.isNegative(BigDecimal.fromStringUnsafe("0")), false)
1807
+ * assert.deepStrictEqual(BigDecimal.isNegative(BigDecimal.fromStringUnsafe("1")), false)
1736
1808
  * ```
1737
1809
  *
1738
- * @since 2.0.0
1739
1810
  * @category predicates
1811
+ * @since 2.0.0
1740
1812
  */
1741
1813
  export declare const isNegative: (n: BigDecimal) => boolean;
1742
1814
  /**
1743
1815
  * Checks if a given `BigDecimal` is positive.
1744
1816
  *
1745
- * @example
1817
+ * **Example** (Checking positive decimals)
1818
+ *
1746
1819
  * ```ts
1747
- * import { fromStringUnsafe, isPositive } from "effect/BigDecimal"
1820
+ * import { BigDecimal } from "effect"
1748
1821
  * import * as assert from "node:assert"
1749
1822
  *
1750
- * assert.deepStrictEqual(isPositive(fromStringUnsafe("-1")), false)
1751
- * assert.deepStrictEqual(isPositive(fromStringUnsafe("0")), false)
1752
- * assert.deepStrictEqual(isPositive(fromStringUnsafe("1")), true)
1823
+ * assert.deepStrictEqual(BigDecimal.isPositive(BigDecimal.fromStringUnsafe("-1")), false)
1824
+ * assert.deepStrictEqual(BigDecimal.isPositive(BigDecimal.fromStringUnsafe("0")), false)
1825
+ * assert.deepStrictEqual(BigDecimal.isPositive(BigDecimal.fromStringUnsafe("1")), true)
1753
1826
  * ```
1754
1827
  *
1755
- * @since 2.0.0
1756
1828
  * @category predicates
1829
+ * @since 2.0.0
1757
1830
  */
1758
1831
  export declare const isPositive: (n: BigDecimal) => boolean;
1759
1832
  /**
@@ -1770,52 +1843,54 @@ export declare const isPositive: (n: BigDecimal) => boolean;
1770
1843
  * `half-even`: round to the nearest neighbor; if equidistant round to the neighbor with an even digit
1771
1844
  * `half-odd`: round to the nearest neighbor; if equidistant round to the neighbor with an odd digit
1772
1845
  *
1773
- * @since 4.0.0
1774
1846
  * @category math
1847
+ * @since 3.16.0
1775
1848
  */
1776
1849
  export type RoundingMode = "ceil" | "floor" | "to-zero" | "from-zero" | "half-ceil" | "half-floor" | "half-to-zero" | "half-from-zero" | "half-even" | "half-odd";
1777
1850
  /**
1778
1851
  * Rounds a `BigDecimal` at the given scale with the specified rounding mode.
1779
1852
  *
1780
- * @example
1853
+ * **Example** (Rounding decimals)
1854
+ *
1781
1855
  * ```ts
1782
- * import { fromStringUnsafe, round } from "effect/BigDecimal"
1856
+ * import { BigDecimal } from "effect"
1783
1857
  * import * as assert from "node:assert"
1784
1858
  *
1785
1859
  * assert.deepStrictEqual(
1786
- * round(fromStringUnsafe("145"), { mode: "from-zero", scale: -1 }),
1787
- * fromStringUnsafe("150")
1860
+ * BigDecimal.round(BigDecimal.fromStringUnsafe("145"), { mode: "from-zero", scale: -1 }),
1861
+ * BigDecimal.fromStringUnsafe("150")
1788
1862
  * )
1789
1863
  * assert.deepStrictEqual(
1790
- * round(fromStringUnsafe("-14.5")),
1791
- * fromStringUnsafe("-15")
1864
+ * BigDecimal.round(BigDecimal.fromStringUnsafe("-14.5")),
1865
+ * BigDecimal.fromStringUnsafe("-15")
1792
1866
  * )
1793
1867
  * ```
1794
1868
  *
1795
- * @since 4.0.0
1796
1869
  * @category math
1870
+ * @since 3.16.0
1797
1871
  */
1798
1872
  export declare const round: {
1799
1873
  /**
1800
1874
  * Rounds a `BigDecimal` at the given scale with the specified rounding mode.
1801
1875
  *
1802
- * @example
1876
+ * **Example** (Rounding decimals)
1877
+ *
1803
1878
  * ```ts
1804
- * import { fromStringUnsafe, round } from "effect/BigDecimal"
1879
+ * import { BigDecimal } from "effect"
1805
1880
  * import * as assert from "node:assert"
1806
1881
  *
1807
1882
  * assert.deepStrictEqual(
1808
- * round(fromStringUnsafe("145"), { mode: "from-zero", scale: -1 }),
1809
- * fromStringUnsafe("150")
1883
+ * BigDecimal.round(BigDecimal.fromStringUnsafe("145"), { mode: "from-zero", scale: -1 }),
1884
+ * BigDecimal.fromStringUnsafe("150")
1810
1885
  * )
1811
1886
  * assert.deepStrictEqual(
1812
- * round(fromStringUnsafe("-14.5")),
1813
- * fromStringUnsafe("-15")
1887
+ * BigDecimal.round(BigDecimal.fromStringUnsafe("-14.5")),
1888
+ * BigDecimal.fromStringUnsafe("-15")
1814
1889
  * )
1815
1890
  * ```
1816
1891
  *
1817
- * @since 4.0.0
1818
1892
  * @category math
1893
+ * @since 3.16.0
1819
1894
  */
1820
1895
  (options: {
1821
1896
  scale?: number;
@@ -1824,23 +1899,24 @@ export declare const round: {
1824
1899
  /**
1825
1900
  * Rounds a `BigDecimal` at the given scale with the specified rounding mode.
1826
1901
  *
1827
- * @example
1902
+ * **Example** (Rounding decimals)
1903
+ *
1828
1904
  * ```ts
1829
- * import { fromStringUnsafe, round } from "effect/BigDecimal"
1905
+ * import { BigDecimal } from "effect"
1830
1906
  * import * as assert from "node:assert"
1831
1907
  *
1832
1908
  * assert.deepStrictEqual(
1833
- * round(fromStringUnsafe("145"), { mode: "from-zero", scale: -1 }),
1834
- * fromStringUnsafe("150")
1909
+ * BigDecimal.round(BigDecimal.fromStringUnsafe("145"), { mode: "from-zero", scale: -1 }),
1910
+ * BigDecimal.fromStringUnsafe("150")
1835
1911
  * )
1836
1912
  * assert.deepStrictEqual(
1837
- * round(fromStringUnsafe("-14.5")),
1838
- * fromStringUnsafe("-15")
1913
+ * BigDecimal.round(BigDecimal.fromStringUnsafe("-14.5")),
1914
+ * BigDecimal.fromStringUnsafe("-15")
1839
1915
  * )
1840
1916
  * ```
1841
1917
  *
1842
- * @since 4.0.0
1843
1918
  * @category math
1919
+ * @since 3.16.0
1844
1920
  */
1845
1921
  (n: BigDecimal, options?: {
1846
1922
  scale?: number;
@@ -1848,194 +1924,185 @@ export declare const round: {
1848
1924
  }): BigDecimal;
1849
1925
  };
1850
1926
  /**
1851
- * Truncate a `BigDecimal` at the given scale. This is the same operation as rounding away from zero.
1927
+ * Truncate a `BigDecimal` at the given scale. This removes fractional digits beyond the scale,
1928
+ * rounding toward zero.
1929
+ *
1930
+ * **Example** (Truncating decimals)
1852
1931
  *
1853
- * @example
1854
1932
  * ```ts
1855
- * import { fromStringUnsafe, truncate } from "effect/BigDecimal"
1856
- * import * as assert from "node:assert"
1933
+ * import { BigDecimal } from "effect"
1857
1934
  *
1858
- * assert.deepStrictEqual(
1859
- * truncate(fromStringUnsafe("145"), -1),
1860
- * fromStringUnsafe("140")
1861
- * )
1862
- * assert.deepStrictEqual(
1863
- * truncate(fromStringUnsafe("-14.5")),
1864
- * fromStringUnsafe("-14")
1865
- * )
1935
+ * console.log(BigDecimal.truncate(BigDecimal.fromStringUnsafe("145"), -1)) // BigDecimal(140)
1936
+ * console.log(BigDecimal.truncate(BigDecimal.fromStringUnsafe("-14.5"))) // BigDecimal(-14)
1866
1937
  * ```
1867
1938
  *
1868
- * @since 4.0.0
1869
1939
  * @category math
1940
+ * @since 3.16.0
1870
1941
  */
1871
1942
  export declare const truncate: {
1872
1943
  /**
1873
- * Truncate a `BigDecimal` at the given scale. This is the same operation as rounding away from zero.
1944
+ * Truncate a `BigDecimal` at the given scale. This removes fractional digits beyond the scale,
1945
+ * rounding toward zero.
1946
+ *
1947
+ * **Example** (Truncating decimals)
1874
1948
  *
1875
- * @example
1876
1949
  * ```ts
1877
- * import { fromStringUnsafe, truncate } from "effect/BigDecimal"
1878
- * import * as assert from "node:assert"
1950
+ * import { BigDecimal } from "effect"
1879
1951
  *
1880
- * assert.deepStrictEqual(
1881
- * truncate(fromStringUnsafe("145"), -1),
1882
- * fromStringUnsafe("140")
1883
- * )
1884
- * assert.deepStrictEqual(
1885
- * truncate(fromStringUnsafe("-14.5")),
1886
- * fromStringUnsafe("-14")
1887
- * )
1952
+ * console.log(BigDecimal.truncate(BigDecimal.fromStringUnsafe("145"), -1)) // BigDecimal(140)
1953
+ * console.log(BigDecimal.truncate(BigDecimal.fromStringUnsafe("-14.5"))) // BigDecimal(-14)
1888
1954
  * ```
1889
1955
  *
1890
- * @since 4.0.0
1891
1956
  * @category math
1957
+ * @since 3.16.0
1892
1958
  */
1893
1959
  (scale: number): (self: BigDecimal) => BigDecimal;
1894
1960
  /**
1895
- * Truncate a `BigDecimal` at the given scale. This is the same operation as rounding away from zero.
1961
+ * Truncate a `BigDecimal` at the given scale. This removes fractional digits beyond the scale,
1962
+ * rounding toward zero.
1963
+ *
1964
+ * **Example** (Truncating decimals)
1896
1965
  *
1897
- * @example
1898
1966
  * ```ts
1899
- * import { fromStringUnsafe, truncate } from "effect/BigDecimal"
1900
- * import * as assert from "node:assert"
1967
+ * import { BigDecimal } from "effect"
1901
1968
  *
1902
- * assert.deepStrictEqual(
1903
- * truncate(fromStringUnsafe("145"), -1),
1904
- * fromStringUnsafe("140")
1905
- * )
1906
- * assert.deepStrictEqual(
1907
- * truncate(fromStringUnsafe("-14.5")),
1908
- * fromStringUnsafe("-14")
1909
- * )
1969
+ * console.log(BigDecimal.truncate(BigDecimal.fromStringUnsafe("145"), -1)) // BigDecimal(140)
1970
+ * console.log(BigDecimal.truncate(BigDecimal.fromStringUnsafe("-14.5"))) // BigDecimal(-14)
1910
1971
  * ```
1911
1972
  *
1912
- * @since 4.0.0
1913
1973
  * @category math
1974
+ * @since 3.16.0
1914
1975
  */
1915
1976
  (self: BigDecimal, scale?: number): BigDecimal;
1916
1977
  };
1917
1978
  /**
1918
1979
  * Calculate the ceiling of a `BigDecimal` at the given scale.
1919
1980
  *
1920
- * @example
1981
+ * **Example** (Rounding decimals up)
1982
+ *
1921
1983
  * ```ts
1922
- * import { ceil, fromStringUnsafe } from "effect/BigDecimal"
1984
+ * import { BigDecimal } from "effect"
1923
1985
  * import * as assert from "node:assert"
1924
1986
  *
1925
1987
  * assert.deepStrictEqual(
1926
- * ceil(fromStringUnsafe("145"), -1),
1927
- * fromStringUnsafe("150")
1988
+ * BigDecimal.ceil(BigDecimal.fromStringUnsafe("145"), -1),
1989
+ * BigDecimal.fromStringUnsafe("150")
1928
1990
  * )
1929
- * assert.deepStrictEqual(ceil(fromStringUnsafe("-14.5")), fromStringUnsafe("-14"))
1991
+ * assert.deepStrictEqual(BigDecimal.ceil(BigDecimal.fromStringUnsafe("-14.5")), BigDecimal.fromStringUnsafe("-14"))
1930
1992
  * ```
1931
1993
  *
1932
- * @since 4.0.0
1933
1994
  * @category math
1995
+ * @since 3.16.0
1934
1996
  */
1935
1997
  export declare const ceil: {
1936
1998
  /**
1937
1999
  * Calculate the ceiling of a `BigDecimal` at the given scale.
1938
2000
  *
1939
- * @example
2001
+ * **Example** (Rounding decimals up)
2002
+ *
1940
2003
  * ```ts
1941
- * import { ceil, fromStringUnsafe } from "effect/BigDecimal"
2004
+ * import { BigDecimal } from "effect"
1942
2005
  * import * as assert from "node:assert"
1943
2006
  *
1944
2007
  * assert.deepStrictEqual(
1945
- * ceil(fromStringUnsafe("145"), -1),
1946
- * fromStringUnsafe("150")
2008
+ * BigDecimal.ceil(BigDecimal.fromStringUnsafe("145"), -1),
2009
+ * BigDecimal.fromStringUnsafe("150")
1947
2010
  * )
1948
- * assert.deepStrictEqual(ceil(fromStringUnsafe("-14.5")), fromStringUnsafe("-14"))
2011
+ * assert.deepStrictEqual(BigDecimal.ceil(BigDecimal.fromStringUnsafe("-14.5")), BigDecimal.fromStringUnsafe("-14"))
1949
2012
  * ```
1950
2013
  *
1951
- * @since 4.0.0
1952
2014
  * @category math
2015
+ * @since 3.16.0
1953
2016
  */
1954
2017
  (scale: number): (self: BigDecimal) => BigDecimal;
1955
2018
  /**
1956
2019
  * Calculate the ceiling of a `BigDecimal` at the given scale.
1957
2020
  *
1958
- * @example
2021
+ * **Example** (Rounding decimals up)
2022
+ *
1959
2023
  * ```ts
1960
- * import { ceil, fromStringUnsafe } from "effect/BigDecimal"
2024
+ * import { BigDecimal } from "effect"
1961
2025
  * import * as assert from "node:assert"
1962
2026
  *
1963
2027
  * assert.deepStrictEqual(
1964
- * ceil(fromStringUnsafe("145"), -1),
1965
- * fromStringUnsafe("150")
2028
+ * BigDecimal.ceil(BigDecimal.fromStringUnsafe("145"), -1),
2029
+ * BigDecimal.fromStringUnsafe("150")
1966
2030
  * )
1967
- * assert.deepStrictEqual(ceil(fromStringUnsafe("-14.5")), fromStringUnsafe("-14"))
2031
+ * assert.deepStrictEqual(BigDecimal.ceil(BigDecimal.fromStringUnsafe("-14.5")), BigDecimal.fromStringUnsafe("-14"))
1968
2032
  * ```
1969
2033
  *
1970
- * @since 4.0.0
1971
2034
  * @category math
2035
+ * @since 3.16.0
1972
2036
  */
1973
2037
  (self: BigDecimal, scale?: number): BigDecimal;
1974
2038
  };
1975
2039
  /**
1976
2040
  * Calculate the floor of a `BigDecimal` at the given scale.
1977
2041
  *
1978
- * @example
2042
+ * **Example** (Rounding decimals down)
2043
+ *
1979
2044
  * ```ts
1980
- * import { floor, fromStringUnsafe } from "effect/BigDecimal"
2045
+ * import { BigDecimal } from "effect"
1981
2046
  * import * as assert from "node:assert"
1982
2047
  *
1983
2048
  * assert.deepStrictEqual(
1984
- * floor(fromStringUnsafe("145"), -1),
1985
- * fromStringUnsafe("140")
2049
+ * BigDecimal.floor(BigDecimal.fromStringUnsafe("145"), -1),
2050
+ * BigDecimal.fromStringUnsafe("140")
1986
2051
  * )
1987
2052
  * assert.deepStrictEqual(
1988
- * floor(fromStringUnsafe("-14.5")),
1989
- * fromStringUnsafe("-15")
2053
+ * BigDecimal.floor(BigDecimal.fromStringUnsafe("-14.5")),
2054
+ * BigDecimal.fromStringUnsafe("-15")
1990
2055
  * )
1991
2056
  * ```
1992
2057
  *
1993
- * @since 4.0.0
1994
2058
  * @category math
2059
+ * @since 3.16.0
1995
2060
  */
1996
2061
  export declare const floor: {
1997
2062
  /**
1998
2063
  * Calculate the floor of a `BigDecimal` at the given scale.
1999
2064
  *
2000
- * @example
2065
+ * **Example** (Rounding decimals down)
2066
+ *
2001
2067
  * ```ts
2002
- * import { floor, fromStringUnsafe } from "effect/BigDecimal"
2068
+ * import { BigDecimal } from "effect"
2003
2069
  * import * as assert from "node:assert"
2004
2070
  *
2005
2071
  * assert.deepStrictEqual(
2006
- * floor(fromStringUnsafe("145"), -1),
2007
- * fromStringUnsafe("140")
2072
+ * BigDecimal.floor(BigDecimal.fromStringUnsafe("145"), -1),
2073
+ * BigDecimal.fromStringUnsafe("140")
2008
2074
  * )
2009
2075
  * assert.deepStrictEqual(
2010
- * floor(fromStringUnsafe("-14.5")),
2011
- * fromStringUnsafe("-15")
2076
+ * BigDecimal.floor(BigDecimal.fromStringUnsafe("-14.5")),
2077
+ * BigDecimal.fromStringUnsafe("-15")
2012
2078
  * )
2013
2079
  * ```
2014
2080
  *
2015
- * @since 4.0.0
2016
2081
  * @category math
2082
+ * @since 3.16.0
2017
2083
  */
2018
2084
  (scale: number): (self: BigDecimal) => BigDecimal;
2019
2085
  /**
2020
2086
  * Calculate the floor of a `BigDecimal` at the given scale.
2021
2087
  *
2022
- * @example
2088
+ * **Example** (Rounding decimals down)
2089
+ *
2023
2090
  * ```ts
2024
- * import { floor, fromStringUnsafe } from "effect/BigDecimal"
2091
+ * import { BigDecimal } from "effect"
2025
2092
  * import * as assert from "node:assert"
2026
2093
  *
2027
2094
  * assert.deepStrictEqual(
2028
- * floor(fromStringUnsafe("145"), -1),
2029
- * fromStringUnsafe("140")
2095
+ * BigDecimal.floor(BigDecimal.fromStringUnsafe("145"), -1),
2096
+ * BigDecimal.fromStringUnsafe("140")
2030
2097
  * )
2031
2098
  * assert.deepStrictEqual(
2032
- * floor(fromStringUnsafe("-14.5")),
2033
- * fromStringUnsafe("-15")
2099
+ * BigDecimal.floor(BigDecimal.fromStringUnsafe("-14.5")),
2100
+ * BigDecimal.fromStringUnsafe("-15")
2034
2101
  * )
2035
2102
  * ```
2036
2103
  *
2037
- * @since 4.0.0
2038
2104
  * @category math
2105
+ * @since 3.16.0
2039
2106
  */
2040
2107
  (self: BigDecimal, scale?: number): BigDecimal;
2041
2108
  };