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
@@ -1,4 +1,53 @@
1
1
  /**
2
+ * The `DateTime` module provides immutable data types and utilities for working
3
+ * with instants, UTC date-times, zoned date-times, and time zones. A
4
+ * `DateTime` is always an absolute point in time, represented internally by
5
+ * epoch milliseconds, and may also carry a `TimeZone` for zone-aware calendar
6
+ * parts and formatting.
7
+ *
8
+ * **Mental model**
9
+ *
10
+ * - `DateTime` is a discriminated union: `Utc | Zoned`
11
+ * - `Utc` stores an absolute instant without an associated time zone
12
+ * - `Zoned` stores the same kind of absolute instant plus a `TimeZone`
13
+ * - Time zones can be fixed offsets or named IANA zones such as `"Europe/Rome"`
14
+ * - Comparison and ordering use the instant, so two values in different zones
15
+ * can still be equivalent
16
+ * - Calendar parts and formatted output depend on whether you ask for UTC parts
17
+ * or zone-adjusted parts
18
+ *
19
+ * **Common tasks**
20
+ *
21
+ * - Construct values: {@link make}, {@link makeUnsafe}, {@link makeZoned}, {@link makeZonedUnsafe}
22
+ * - Get the current instant: {@link now}, {@link nowInCurrentZone}
23
+ * - Create time zones: {@link zoneMakeOffset}, {@link zoneMakeNamed}, {@link zoneFromString}
24
+ * - Attach or change zones: {@link setZone}, {@link setZoneNamed}, {@link setZoneCurrent}, {@link toUtc}
25
+ * - Convert to platform values or parts: {@link toDate}, {@link toDateUtc}, {@link toEpochMillis}, {@link toParts}, {@link toPartsUtc}
26
+ * - Compare and bound values: {@link Equivalence}, {@link Order}, {@link distance}, {@link min}, {@link max}, {@link clamp}, {@link between}
27
+ * - Transform values: {@link add}, {@link subtract}, {@link startOf}, {@link endOf}, {@link nearest}, {@link setParts}, {@link mutate}
28
+ * - Format values: {@link format}, {@link formatUtc}, {@link formatLocal}, {@link formatIntl}, {@link formatIso}, {@link formatIsoZoned}
29
+ * - Provide an application time zone: {@link CurrentTimeZone}, {@link withCurrentZone}, {@link layerCurrentZone}
30
+ *
31
+ * **Gotchas**
32
+ *
33
+ * - `make` and `makeZoned` return `Option`; unsafe constructors throw on invalid
34
+ * input
35
+ * - `DateTime` equality is instant-based, not display-time-based
36
+ * - `setZone` changes the zone used for local parts and formatting without
37
+ * changing the represented instant
38
+ * - Use `adjustForTimeZone` with {@link makeZoned} when input parts should be
39
+ * interpreted as wall-clock time in the target zone
40
+ * - Daylight-saving gaps and repeated local times are resolved with
41
+ * `Disambiguation`
42
+ * - Prefer the Clock-backed {@link now} and `CurrentTimeZone` services in
43
+ * Effect workflows; unsafe helpers read from the host environment directly
44
+ *
45
+ * **See also**
46
+ *
47
+ * - {@link DateTime} for the UTC/zoned data model
48
+ * - {@link TimeZone} for offset and named time-zone values
49
+ * - {@link Disambiguation} for daylight-saving ambiguity handling
50
+ *
2
51
  * @since 3.6.0
3
52
  */
4
53
  import type { IllegalArgumentError } from "./Cause.ts";
@@ -18,13 +67,18 @@ declare const TimeZoneTypeId = "~effect/time/DateTime/TimeZone";
18
67
  * A `DateTime` represents a point in time. It can optionally have a time zone
19
68
  * associated with it.
20
69
  *
21
- * @since 3.6.0
22
70
  * @category models
71
+ * @since 3.6.0
23
72
  */
24
73
  export type DateTime = Utc | Zoned;
25
74
  /**
26
- * @since 3.6.0
75
+ * Represents a `DateTime` stored as an absolute UTC instant with no associated
76
+ * time zone.
77
+ *
78
+ * Use `DateTime.isUtc` to narrow a `DateTime` to this variant.
79
+ *
27
80
  * @category models
81
+ * @since 3.6.0
28
82
  */
29
83
  export interface Utc extends DateTime.Proto {
30
84
  readonly _tag: "Utc";
@@ -32,8 +86,14 @@ export interface Utc extends DateTime.Proto {
32
86
  partsUtc: DateTime.PartsWithWeekday | undefined;
33
87
  }
34
88
  /**
35
- * @since 3.6.0
89
+ * Represents a `DateTime` with an associated `TimeZone`.
90
+ *
91
+ * A zoned value still represents an absolute instant through
92
+ * `epochMilliseconds`, while the time zone is used for wall-clock parts,
93
+ * formatting, and zone-aware transformations.
94
+ *
36
95
  * @category models
96
+ * @since 3.6.0
37
97
  */
38
98
  export interface Zoned extends DateTime.Proto {
39
99
  readonly _tag: "Zoned";
@@ -44,38 +104,70 @@ export interface Zoned extends DateTime.Proto {
44
104
  partsUtc: DateTime.PartsWithWeekday | undefined;
45
105
  }
46
106
  /**
107
+ * Companion namespace containing the public helper types used by `DateTime`
108
+ * constructors, parts APIs, formatting, and date/time arithmetic.
109
+ *
47
110
  * @since 3.6.0
48
- * @category models
49
111
  */
50
112
  export declare namespace DateTime {
51
113
  /**
52
- * @since 3.6.0
114
+ * Input accepted by `DateTime.make`, `DateTime.makeUnsafe`, and the zoned
115
+ * constructors.
116
+ *
117
+ * Includes existing `DateTime` values, partial date parts, epoch-millisecond
118
+ * objects, epoch milliseconds, JavaScript `Date` instances, and parseable date
119
+ * strings.
120
+ *
53
121
  * @category models
122
+ * @since 3.6.0
54
123
  */
55
124
  type Input = DateTime | Partial<Parts> | Instant | InstantWithZone | Date | number | string;
56
125
  /**
57
- * @since 3.6.0
126
+ * Type-level helper used by constructors to preserve a zoned input.
127
+ *
128
+ * When the input type is `DateTime.Zoned`, the result type is
129
+ * `DateTime.Zoned`; otherwise the result type is `DateTime.Utc`.
130
+ *
58
131
  * @category models
132
+ * @since 3.6.0
59
133
  */
60
134
  type PreserveZone<A extends DateTime.Input> = A extends Zoned ? Zoned : Utc;
61
135
  /**
62
- * @since 3.6.0
136
+ * Date and time unit name accepted by `DateTime` rounding and arithmetic
137
+ * APIs.
138
+ *
139
+ * Includes both singular units, such as `"day"`, and plural units, such as
140
+ * `"days"`.
141
+ *
63
142
  * @category models
143
+ * @since 3.6.0
64
144
  */
65
145
  type Unit = UnitSingular | UnitPlural;
66
146
  /**
67
- * @since 3.6.0
147
+ * Singular date and time unit names used by rounding APIs such as
148
+ * `DateTime.startOf`, `DateTime.endOf`, and `DateTime.nearest`.
149
+ *
68
150
  * @category models
151
+ * @since 3.6.0
69
152
  */
70
153
  type UnitSingular = "millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "year";
71
154
  /**
72
- * @since 3.6.0
155
+ * Plural date and time unit names used by `DateTime.PartsForMath` for
156
+ * amount-based arithmetic.
157
+ *
73
158
  * @category models
159
+ * @since 3.6.0
74
160
  */
75
161
  type UnitPlural = "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years";
76
162
  /**
77
- * @since 3.6.0
163
+ * Calendar and time components of a `DateTime`, including the weekday.
164
+ *
165
+ * `month` is one-based (`1` for January through `12` for December), and
166
+ * `weekDay` follows JavaScript `Date#getUTCDay` numbering (`0` for Sunday
167
+ * through `6` for Saturday).
168
+ *
78
169
  * @category models
170
+ * @since 3.6.0
79
171
  */
80
172
  interface PartsWithWeekday {
81
173
  readonly millisecond: number;
@@ -88,8 +180,12 @@ export declare namespace DateTime {
88
180
  readonly year: number;
89
181
  }
90
182
  /**
91
- * @since 3.6.0
183
+ * Calendar and time components of a `DateTime`, without weekday information.
184
+ *
185
+ * `month` is one-based (`1` for January through `12` for December).
186
+ *
92
187
  * @category models
188
+ * @since 3.6.0
93
189
  */
94
190
  interface Parts {
95
191
  readonly millisecond: number;
@@ -101,8 +197,12 @@ export declare namespace DateTime {
101
197
  readonly year: number;
102
198
  }
103
199
  /**
104
- * @since 3.6.0
200
+ * Plural amount fields accepted by `DateTime.add` and `DateTime.subtract`.
201
+ *
202
+ * Each field represents the number of units to add or subtract for that part.
203
+ *
105
204
  * @category models
205
+ * @since 3.6.0
106
206
  */
107
207
  interface PartsForMath {
108
208
  readonly milliseconds: number;
@@ -115,56 +215,89 @@ export declare namespace DateTime {
115
215
  readonly years: number;
116
216
  }
117
217
  /**
118
- * @since 4.0.0
218
+ * Object input representing an absolute instant as milliseconds since the Unix
219
+ * epoch.
220
+ *
119
221
  * @category models
222
+ * @since 4.0.0
120
223
  */
121
224
  interface Instant {
122
225
  readonly epochMilliseconds: number;
123
226
  }
124
227
  /**
125
- * @since 4.0.0
228
+ * Object input representing an absolute instant plus a time zone identifier.
229
+ *
230
+ * `DateTime.makeZoned` and `DateTime.makeZonedUnsafe` use `timeZoneId` when
231
+ * no explicit `timeZone` option is supplied.
232
+ *
126
233
  * @category models
234
+ * @since 4.0.0
127
235
  */
128
236
  interface InstantWithZone {
129
237
  readonly timeZoneId: string;
130
238
  readonly epochMilliseconds: number;
131
239
  }
132
240
  /**
133
- * @since 3.6.0
241
+ * Shared protocol implemented by all `DateTime` values.
242
+ *
243
+ * Provides the `DateTime` type identifier along with pipe and inspection
244
+ * support.
245
+ *
134
246
  * @category models
247
+ * @since 3.6.0
135
248
  */
136
249
  interface Proto extends Pipeable, Inspectable {
137
250
  readonly [TypeId]: typeof TypeId;
138
251
  }
139
252
  }
140
253
  /**
141
- * @since 3.6.0
254
+ * Represents a time zone used by `DateTime.Zoned`.
255
+ *
256
+ * A `TimeZone` is either a fixed offset from UTC or a named IANA time zone.
257
+ *
142
258
  * @category models
259
+ * @since 3.6.0
143
260
  */
144
261
  export type TimeZone = TimeZone.Offset | TimeZone.Named;
145
262
  /**
263
+ * Companion namespace containing the public variant and protocol types for
264
+ * `TimeZone`.
265
+ *
146
266
  * @since 3.6.0
147
- * @category models
148
267
  */
149
268
  export declare namespace TimeZone {
150
269
  /**
151
- * @since 3.6.0
270
+ * Shared protocol implemented by all `TimeZone` values.
271
+ *
272
+ * Provides the `TimeZone` type identifier and inspection support.
273
+ *
152
274
  * @category models
275
+ * @since 3.6.0
153
276
  */
154
277
  interface Proto extends Inspectable {
155
278
  readonly [TimeZoneTypeId]: typeof TimeZoneTypeId;
156
279
  }
157
280
  /**
158
- * @since 3.6.0
281
+ * Fixed-offset time zone.
282
+ *
283
+ * The `offset` is measured in milliseconds from UTC. Positive offsets are
284
+ * ahead of UTC, and negative offsets are behind UTC.
285
+ *
159
286
  * @category models
287
+ * @since 3.6.0
160
288
  */
161
289
  interface Offset extends Proto {
162
290
  readonly _tag: "Offset";
163
291
  readonly offset: number;
164
292
  }
165
293
  /**
166
- * @since 3.6.0
294
+ * Named IANA time zone.
295
+ *
296
+ * The `id` field contains the resolved time zone identifier, such as
297
+ * `"Europe/London"` or `"America/New_York"`.
298
+ *
167
299
  * @category models
300
+ * @since 3.6.0
168
301
  */
169
302
  interface Named extends Proto {
170
303
  readonly _tag: "Named";
@@ -188,7 +321,8 @@ export declare namespace TimeZone {
188
321
  *
189
322
  * - `"reject"`: Throw an `RangeError` when encountering ambiguous or non-existent times.
190
323
  *
191
- * @example
324
+ * **Example** (Resolving ambiguous local times)
325
+ *
192
326
  * ```ts
193
327
  * import { DateTime } from "effect"
194
328
  *
@@ -228,48 +362,50 @@ export declare namespace TimeZone {
228
362
  * // Time after gap: 2025-03-09T07:30:00.000Z (03:30 EDT)
229
363
  * ```
230
364
  *
231
- * @since 3.18.0
232
365
  * @category models
366
+ * @since 3.18.0
233
367
  */
234
368
  export type Disambiguation = "compatible" | "earlier" | "later" | "reject";
235
369
  /**
236
- * @since 3.6.0
370
+ * Checks whether a value is a `DateTime`.
371
+ *
237
372
  * @category guards
373
+ * @since 3.6.0
238
374
  */
239
375
  export declare const isDateTime: (u: unknown) => u is DateTime;
240
376
  /**
241
377
  * Checks if a value is a `TimeZone`.
242
378
  *
243
- * @since 3.6.0
244
379
  * @category guards
380
+ * @since 3.6.0
245
381
  */
246
382
  export declare const isTimeZone: (u: unknown) => u is TimeZone;
247
383
  /**
248
384
  * Checks if a value is an offset-based `TimeZone`.
249
385
  *
250
- * @since 3.6.0
251
386
  * @category guards
387
+ * @since 3.6.0
252
388
  */
253
389
  export declare const isTimeZoneOffset: (u: unknown) => u is TimeZone.Offset;
254
390
  /**
255
391
  * Checks if a value is a named `TimeZone` (IANA time zone).
256
392
  *
257
- * @since 3.6.0
258
393
  * @category guards
394
+ * @since 3.6.0
259
395
  */
260
396
  export declare const isTimeZoneNamed: (u: unknown) => u is TimeZone.Named;
261
397
  /**
262
398
  * Checks if a `DateTime` is a UTC `DateTime` (no time zone information).
263
399
  *
264
- * @since 3.6.0
265
400
  * @category guards
401
+ * @since 3.6.0
266
402
  */
267
403
  export declare const isUtc: (self: DateTime) => self is Utc;
268
404
  /**
269
405
  * Checks if a `DateTime` is a zoned `DateTime` (has time zone information).
270
406
  *
271
- * @since 3.6.0
272
407
  * @category guards
408
+ * @since 3.6.0
273
409
  */
274
410
  export declare const isZoned: (self: DateTime) => self is Zoned;
275
411
  /**
@@ -278,7 +414,8 @@ export declare const isZoned: (self: DateTime) => self is Zoned;
278
414
  * Two `DateTime` values are considered equivalent if they represent the same
279
415
  * point in time, regardless of their time zone.
280
416
  *
281
- * @example
417
+ * **Example** (Comparing DateTime values for equivalence)
418
+ *
282
419
  * ```ts
283
420
  * import { DateTime } from "effect"
284
421
  *
@@ -300,7 +437,8 @@ export declare const Equivalence: Equ.Equivalence<DateTime>;
300
437
  * `DateTime` values are ordered by their epoch milliseconds, so earlier times
301
438
  * come before later times regardless of time zone.
302
439
  *
303
- * @example
440
+ * **Example** (Sorting DateTime values chronologically)
441
+ *
304
442
  * ```ts
305
443
  * import { Array, DateTime } from "effect"
306
444
  *
@@ -325,7 +463,8 @@ export declare const Order: order.Order<DateTime>;
325
463
  * If the `DateTime` is after the maximum, the maximum is returned.
326
464
  * Otherwise, the original `DateTime` is returned.
327
465
  *
328
- * @example
466
+ * **Example** (Clamping DateTime values)
467
+ *
329
468
  * ```ts
330
469
  * import { DateTime } from "effect"
331
470
  *
@@ -348,7 +487,8 @@ export declare const clamp: {
348
487
  * If the `DateTime` is after the maximum, the maximum is returned.
349
488
  * Otherwise, the original `DateTime` is returned.
350
489
  *
351
- * @example
490
+ * **Example** (Clamping DateTime values)
491
+ *
352
492
  * ```ts
353
493
  * import { DateTime } from "effect"
354
494
  *
@@ -374,7 +514,8 @@ export declare const clamp: {
374
514
  * If the `DateTime` is after the maximum, the maximum is returned.
375
515
  * Otherwise, the original `DateTime` is returned.
376
516
  *
377
- * @example
517
+ * **Example** (Clamping DateTime values)
518
+ *
378
519
  * ```ts
379
520
  * import { DateTime } from "effect"
380
521
  *
@@ -399,7 +540,8 @@ export declare const clamp: {
399
540
  *
400
541
  * If the `Date` is invalid, an `IllegalArgumentError` will be thrown.
401
542
  *
402
- * @example
543
+ * **Example** (Creating DateTime values from Dates)
544
+ *
403
545
  * ```ts
404
546
  * import { DateTime } from "effect"
405
547
  *
@@ -410,7 +552,7 @@ export declare const clamp: {
410
552
  * ```
411
553
  *
412
554
  * @category constructors
413
- * @since 3.6.0
555
+ * @since 4.0.0
414
556
  */
415
557
  export declare const fromDateUnsafe: (date: Date) => Utc;
416
558
  /**
@@ -422,21 +564,26 @@ export declare const fromDateUnsafe: (date: Date) => Utc;
422
564
  * - An object with the parts of a date
423
565
  * - A `string` that can be parsed by `Date.parse`
424
566
  *
425
- * @since 3.6.0
426
- * @category constructors
427
- * @example
567
+ * **Example** (Creating DateTime values unsafely)
568
+ *
428
569
  * ```ts
429
570
  * import { DateTime } from "effect"
430
571
  *
431
572
  * // from Date
432
- * DateTime.makeUnsafe(new Date())
573
+ * const fromDate = DateTime.makeUnsafe(new Date("2024-01-01T12:00:00Z"))
574
+ * console.log(DateTime.formatIso(fromDate)) // "2024-01-01T12:00:00.000Z"
433
575
  *
434
576
  * // from parts
435
- * DateTime.makeUnsafe({ year: 2024 })
577
+ * const fromParts = DateTime.makeUnsafe({ year: 2024 })
578
+ * console.log(DateTime.formatIso(fromParts)) // "2024-01-01T00:00:00.000Z"
436
579
  *
437
580
  * // from string
438
- * DateTime.makeUnsafe("2024-01-01")
581
+ * const fromString = DateTime.makeUnsafe("2024-01-01")
582
+ * console.log(DateTime.formatIso(fromString)) // "2024-01-01T00:00:00.000Z"
439
583
  * ```
584
+ *
585
+ * @category constructors
586
+ * @since 4.0.0
440
587
  */
441
588
  export declare const makeUnsafe: <A extends DateTime.Input>(input: A) => DateTime.PreserveZone<A>;
442
589
  /**
@@ -453,14 +600,20 @@ export declare const makeUnsafe: <A extends DateTime.Input>(input: A) => DateTim
453
600
  * - `later`: Always choose the later of two possible times
454
601
  * - `reject`: Throw an error when ambiguous times are encountered
455
602
  *
456
- * @since 3.6.0
457
- * @category constructors
458
- * @example
603
+ * **Example** (Creating zoned DateTime values unsafely)
604
+ *
459
605
  * ```ts
460
606
  * import { DateTime } from "effect"
461
607
  *
462
- * DateTime.makeZonedUnsafe(new Date(), { timeZone: "Europe/London" })
608
+ * const zoned = DateTime.makeZonedUnsafe("2024-06-15T14:30:00Z", {
609
+ * timeZone: "Europe/London"
610
+ * })
611
+ *
612
+ * console.log(DateTime.formatIsoZoned(zoned)) // "2024-06-15T15:30:00.000+01:00[Europe/London]"
463
613
  * ```
614
+ *
615
+ * @category constructors
616
+ * @since 4.0.0
464
617
  */
465
618
  export declare const makeZonedUnsafe: (input: DateTime.Input, options?: {
466
619
  readonly timeZone?: number | string | TimeZone | undefined;
@@ -468,29 +621,41 @@ export declare const makeZonedUnsafe: (input: DateTime.Input, options?: {
468
621
  readonly disambiguation?: Disambiguation | undefined;
469
622
  }) => Zoned;
470
623
  /**
471
- * Create a `DateTime.Zoned` using `DateTime.make` and a time zone.
624
+ * Creates a `DateTime.Zoned` from an input and a time zone.
472
625
  *
473
- * The input is treated as UTC and then the time zone is attached, unless
474
- * `adjustForTimeZone` is set to `true`. In that case, the input is treated as
475
- * already in the time zone.
626
+ * By default, the input is interpreted as a UTC instant and the time zone is
627
+ * attached without changing that instant. When `adjustForTimeZone` is `true`,
628
+ * the input is interpreted as wall-clock time in the target zone.
476
629
  *
477
- * When `adjustForTimeZone` is true and ambiguous times occur during DST transitions,
478
- * the `disambiguation` option controls how to resolve the ambiguity:
479
- * - `compatible` (default): Choose earlier time for repeated times, later for gaps
480
- * - `earlier`: Always choose the earlier of two possible times
481
- * - `later`: Always choose the later of two possible times
482
- * - `reject`: Throw an error when ambiguous times are encountered
630
+ * When `adjustForTimeZone` is `true`, `disambiguation` controls
631
+ * daylight-saving gaps and repeated times:
483
632
  *
484
- * If the date time input or time zone is invalid, `None` will be returned.
633
+ * - `"compatible"` (default): chooses the earlier occurrence for repeated
634
+ * times and the later interpretation for gaps
635
+ * - `"earlier"`: chooses the earlier possible instant
636
+ * - `"later"`: chooses the later possible instant
637
+ * - `"reject"`: rejects ambiguous or nonexistent wall-clock times
638
+ *
639
+ * Returns `Some` when construction succeeds, or `None` when the input, time
640
+ * zone, or disambiguation cannot be resolved.
641
+ *
642
+ * **Example** (Creating optional zoned DateTime values)
485
643
  *
486
- * @since 3.6.0
487
- * @category constructors
488
- * @example
489
644
  * ```ts
490
645
  * import { DateTime } from "effect"
491
646
  *
492
- * DateTime.makeZoned(new Date(), { timeZone: "Europe/London" })
647
+ * const result = DateTime.makeZoned("2024-06-15T14:30:00Z", {
648
+ * timeZone: "Europe/London"
649
+ * })
650
+ *
651
+ * console.log(result._tag) // "Some"
652
+ * if (result._tag === "Some") {
653
+ * console.log(DateTime.formatIsoZoned(result.value)) // "2024-06-15T15:30:00.000+01:00[Europe/London]"
654
+ * }
493
655
  * ```
656
+ *
657
+ * @category constructors
658
+ * @since 3.6.0
494
659
  */
495
660
  export declare const makeZoned: (input: DateTime.Input, options?: {
496
661
  readonly timeZone?: number | string | TimeZone | undefined;
@@ -498,39 +663,53 @@ export declare const makeZoned: (input: DateTime.Input, options?: {
498
663
  readonly disambiguation?: Disambiguation | undefined;
499
664
  }) => Option.Option<Zoned>;
500
665
  /**
501
- * Create a `DateTime` from one of the following:
666
+ * Creates a `DateTime` from one of the following:
502
667
  *
503
668
  * - A `DateTime`
504
- * - A `Date` instance (invalid dates will throw an `IllegalArgumentError`)
505
- * - The `number` of milliseconds since the Unix epoch
506
- * - An object with the parts of a date
507
- * - A `string` that can be parsed by `Date.parse`
669
+ * - A JavaScript `Date`
670
+ * - The number of milliseconds since the Unix epoch
671
+ * - An object with date and time parts
672
+ * - A string that can be parsed as a date
508
673
  *
509
- * If the input is invalid, `None` will be returned.
674
+ * Returns `Some` with the constructed `DateTime` when the input is valid, or
675
+ * `None` when construction would fail, including invalid `Date` instances or
676
+ * unparseable strings.
677
+ *
678
+ * **Example** (Creating optional DateTime values)
510
679
  *
511
- * @since 3.6.0
512
- * @category constructors
513
- * @example
514
680
  * ```ts
515
681
  * import { DateTime } from "effect"
516
682
  *
517
683
  * // from Date
518
- * DateTime.make(new Date())
684
+ * const fromDate = DateTime.make(new Date("2024-01-01T12:00:00Z"))
685
+ * console.log(fromDate._tag) // "Some"
519
686
  *
520
687
  * // from parts
521
- * DateTime.make({ year: 2024 })
688
+ * const fromParts = DateTime.make({ year: 2024 })
689
+ * console.log(fromParts._tag) // "Some"
522
690
  *
523
691
  * // from string
524
- * DateTime.make("2024-01-01")
692
+ * const fromString = DateTime.make("2024-01-01")
693
+ * console.log(fromString._tag) // "Some"
694
+ *
695
+ * const invalid = DateTime.make("not a date")
696
+ * console.log(invalid._tag) // "None"
525
697
  * ```
698
+ *
699
+ * @category constructors
700
+ * @since 3.6.0
526
701
  */
527
702
  export declare const make: <A extends DateTime.Input>(input: A) => Option.Option<DateTime.PreserveZone<A>>;
528
703
  /**
529
- * Create a `DateTime.Zoned` from a string.
704
+ * Parses an ISO zoned date-time string into a `DateTime.Zoned`.
530
705
  *
531
- * It uses the format: `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]`.
706
+ * Accepts named-zone strings such as
707
+ * `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]` and offset-only strings such as
708
+ * `YYYY-MM-DDTHH:mm:ss.sss+HH:MM`. Returns `None` when the input cannot be
709
+ * parsed.
710
+ *
711
+ * **Example** (Parsing zoned DateTime strings)
532
712
  *
533
- * @example
534
713
  * ```ts
535
714
  * import { DateTime } from "effect"
536
715
  *
@@ -546,31 +725,34 @@ export declare const make: <A extends DateTime.Input>(input: A) => Option.Option
546
725
  * console.log(invalid._tag === "None") // true
547
726
  * ```
548
727
  *
549
- * @since 3.6.0
550
728
  * @category constructors
729
+ * @since 3.6.0
551
730
  */
552
731
  export declare const makeZonedFromString: (input: string) => Option.Option<Zoned>;
553
732
  /**
554
733
  * Get the current time using the `Clock` service and convert it to a `DateTime`.
555
734
  *
556
- * @since 3.6.0
557
- * @category constructors
558
- * @example
735
+ * **Example** (Getting the current DateTime)
736
+ *
559
737
  * ```ts
560
738
  * import { DateTime, Effect } from "effect"
561
739
  *
562
740
  * Effect.gen(function*() {
563
- * const now = yield* DateTime.now
741
+ * const now = yield* DateTime.nowAsDate
742
+ * console.log(now instanceof Date) // true
564
743
  * })
565
744
  * ```
745
+ *
746
+ * @category constructors
747
+ * @since 3.6.0
566
748
  */
567
749
  export declare const now: Effect.Effect<Utc>;
568
750
  /**
569
- * Get the current time using the `Clock` service and convert it to a `DateTime`.
751
+ * Gets the current time from the `Clock` service and returns it as a
752
+ * JavaScript `Date`.
753
+ *
754
+ * **Example** (Getting the current Date)
570
755
  *
571
- * @since 3.6.0
572
- * @category constructors
573
- * @example
574
756
  * ```ts
575
757
  * import { DateTime, Effect } from "effect"
576
758
  *
@@ -578,6 +760,9 @@ export declare const now: Effect.Effect<Utc>;
578
760
  * const now = yield* DateTime.now
579
761
  * })
580
762
  * ```
763
+ *
764
+ * @category constructors
765
+ * @since 3.14.0
581
766
  */
582
767
  export declare const nowAsDate: Effect.Effect<Date>;
583
768
  /**
@@ -586,7 +771,8 @@ export declare const nowAsDate: Effect.Effect<Date>;
586
771
  * This is a synchronous version of `now` that directly uses `Date.now()`
587
772
  * instead of the Effect `Clock` service.
588
773
  *
589
- * @example
774
+ * **Example** (Getting the current DateTime unsafely)
775
+ *
590
776
  * ```ts
591
777
  * import { DateTime } from "effect"
592
778
  *
@@ -595,15 +781,14 @@ export declare const nowAsDate: Effect.Effect<Date>;
595
781
  * ```
596
782
  *
597
783
  * @category constructors
598
- * @since 3.6.0
784
+ * @since 4.0.0
599
785
  */
600
786
  export declare const nowUnsafe: LazyArg<Utc>;
601
787
  /**
602
788
  * For a `DateTime` returns a new `DateTime.Utc`.
603
789
  *
604
- * @since 3.13.0
605
- * @category time zones
606
- * @example
790
+ * **Example** (Converting DateTime values to UTC)
791
+ *
607
792
  * ```ts
608
793
  * import { DateTime } from "effect"
609
794
  *
@@ -614,14 +799,16 @@ export declare const nowUnsafe: LazyArg<Utc>;
614
799
  * // set as UTC
615
800
  * const utc: DateTime.Utc = DateTime.toUtc(now)
616
801
  * ```
802
+ *
803
+ * @category time zones
804
+ * @since 3.13.0
617
805
  */
618
806
  export declare const toUtc: (self: DateTime) => Utc;
619
807
  /**
620
808
  * Set the time zone of a `DateTime`, returning a new `DateTime.Zoned`.
621
809
  *
622
- * @since 3.6.0
623
- * @category time zones
624
- * @example
810
+ * **Example** (Setting time zones)
811
+ *
625
812
  * ```ts
626
813
  * import { DateTime, Effect } from "effect"
627
814
  *
@@ -633,14 +820,16 @@ export declare const toUtc: (self: DateTime) => Utc;
633
820
  * const zoned: DateTime.Zoned = DateTime.setZone(now, zone)
634
821
  * })
635
822
  * ```
823
+ *
824
+ * @category time zones
825
+ * @since 3.6.0
636
826
  */
637
827
  export declare const setZone: {
638
828
  /**
639
829
  * Set the time zone of a `DateTime`, returning a new `DateTime.Zoned`.
640
830
  *
641
- * @since 3.6.0
642
- * @category time zones
643
- * @example
831
+ * **Example** (Setting time zones)
832
+ *
644
833
  * ```ts
645
834
  * import { DateTime, Effect } from "effect"
646
835
  *
@@ -652,6 +841,9 @@ export declare const setZone: {
652
841
  * const zoned: DateTime.Zoned = DateTime.setZone(now, zone)
653
842
  * })
654
843
  * ```
844
+ *
845
+ * @category time zones
846
+ * @since 3.6.0
655
847
  */
656
848
  (zone: TimeZone, options?: {
657
849
  readonly adjustForTimeZone?: boolean | undefined;
@@ -660,9 +852,8 @@ export declare const setZone: {
660
852
  /**
661
853
  * Set the time zone of a `DateTime`, returning a new `DateTime.Zoned`.
662
854
  *
663
- * @since 3.6.0
664
- * @category time zones
665
- * @example
855
+ * **Example** (Setting time zones)
856
+ *
666
857
  * ```ts
667
858
  * import { DateTime, Effect } from "effect"
668
859
  *
@@ -674,6 +865,9 @@ export declare const setZone: {
674
865
  * const zoned: DateTime.Zoned = DateTime.setZone(now, zone)
675
866
  * })
676
867
  * ```
868
+ *
869
+ * @category time zones
870
+ * @since 3.6.0
677
871
  */
678
872
  (self: DateTime, zone: TimeZone, options?: {
679
873
  readonly adjustForTimeZone?: boolean | undefined;
@@ -685,9 +879,8 @@ export declare const setZone: {
685
879
  *
686
880
  * The offset is in milliseconds.
687
881
  *
688
- * @since 3.6.0
689
- * @category time zones
690
- * @example
882
+ * **Example** (Setting fixed-offset time zones)
883
+ *
691
884
  * ```ts
692
885
  * import { DateTime, Effect } from "effect"
693
886
  *
@@ -698,6 +891,9 @@ export declare const setZone: {
698
891
  * const zoned: DateTime.Zoned = DateTime.setZoneOffset(now, 3 * 60 * 60 * 1000)
699
892
  * })
700
893
  * ```
894
+ *
895
+ * @category time zones
896
+ * @since 3.6.0
701
897
  */
702
898
  export declare const setZoneOffset: {
703
899
  /**
@@ -705,9 +901,8 @@ export declare const setZoneOffset: {
705
901
  *
706
902
  * The offset is in milliseconds.
707
903
  *
708
- * @since 3.6.0
709
- * @category time zones
710
- * @example
904
+ * **Example** (Setting fixed-offset time zones)
905
+ *
711
906
  * ```ts
712
907
  * import { DateTime, Effect } from "effect"
713
908
  *
@@ -718,6 +913,9 @@ export declare const setZoneOffset: {
718
913
  * const zoned: DateTime.Zoned = DateTime.setZoneOffset(now, 3 * 60 * 60 * 1000)
719
914
  * })
720
915
  * ```
916
+ *
917
+ * @category time zones
918
+ * @since 3.6.0
721
919
  */
722
920
  (offset: number, options?: {
723
921
  readonly adjustForTimeZone?: boolean | undefined;
@@ -728,9 +926,8 @@ export declare const setZoneOffset: {
728
926
  *
729
927
  * The offset is in milliseconds.
730
928
  *
731
- * @since 3.6.0
732
- * @category time zones
733
- * @example
929
+ * **Example** (Setting fixed-offset time zones)
930
+ *
734
931
  * ```ts
735
932
  * import { DateTime, Effect } from "effect"
736
933
  *
@@ -741,6 +938,9 @@ export declare const setZoneOffset: {
741
938
  * const zoned: DateTime.Zoned = DateTime.setZoneOffset(now, 3 * 60 * 60 * 1000)
742
939
  * })
743
940
  * ```
941
+ *
942
+ * @category time zones
943
+ * @since 3.6.0
744
944
  */
745
945
  (self: DateTime, offset: number, options?: {
746
946
  readonly adjustForTimeZone?: boolean | undefined;
@@ -752,7 +952,8 @@ export declare const setZoneOffset: {
752
952
  *
753
953
  * If the time zone is invalid, an `IllegalArgumentError` will be thrown.
754
954
  *
755
- * @example
955
+ * **Example** (Creating named time zones unsafely)
956
+ *
756
957
  * ```ts
757
958
  * import { DateTime } from "effect"
758
959
  *
@@ -766,8 +967,8 @@ export declare const setZoneOffset: {
766
967
  * // DateTime.zoneMakeNamedUnsafe("Invalid/Zone")
767
968
  * ```
768
969
  *
769
- * @since 3.6.0
770
970
  * @category time zones
971
+ * @since 4.0.0
771
972
  */
772
973
  export declare const zoneMakeNamedUnsafe: (zoneId: string) => TimeZone.Named;
773
974
  /**
@@ -776,7 +977,8 @@ export declare const zoneMakeNamedUnsafe: (zoneId: string) => TimeZone.Named;
776
977
  * The offset is specified in milliseconds from UTC. Positive values are
777
978
  * ahead of UTC, negative values are behind UTC.
778
979
  *
779
- * @example
980
+ * **Example** (Creating fixed-offset time zones)
981
+ *
780
982
  * ```ts
781
983
  * import { DateTime } from "effect"
782
984
  *
@@ -797,7 +999,8 @@ export declare const zoneMakeOffset: (offset: number) => TimeZone.Offset;
797
999
  *
798
1000
  * If the time zone is invalid, `None` will be returned.
799
1001
  *
800
- * @example
1002
+ * **Example** (Creating optional named time zones)
1003
+ *
801
1004
  * ```ts
802
1005
  * import { DateTime } from "effect"
803
1006
  *
@@ -817,7 +1020,8 @@ export declare const zoneMakeNamed: (zoneId: string) => Option.Option<TimeZone.N
817
1020
  *
818
1021
  * If the time zone is invalid, it will fail with an `IllegalArgumentError`.
819
1022
  *
820
- * @example
1023
+ * **Example** (Creating named time zones effectfully)
1024
+ *
821
1025
  * ```ts
822
1026
  * import { DateTime, Effect } from "effect"
823
1027
  *
@@ -838,15 +1042,13 @@ export declare const zoneMakeNamedEffect: (zoneId: string) => Effect.Effect<Time
838
1042
  * This uses the system's configured time zone, which may vary depending
839
1043
  * on the runtime environment.
840
1044
  *
841
- * @example
1045
+ * **Example** (Creating local time zones)
1046
+ *
842
1047
  * ```ts
843
1048
  * import { DateTime } from "effect"
844
1049
  *
845
1050
  * const localZone = DateTime.zoneMakeLocal()
846
- * const now = DateTime.nowUnsafe()
847
- * const localTime = DateTime.setZone(now, localZone)
848
- *
849
- * console.log(DateTime.formatIsoZoned(localTime))
1051
+ * console.log(DateTime.zoneToString(localZone)) // Output depends on system time zone
850
1052
  * ```
851
1053
  *
852
1054
  * @category time zones
@@ -858,7 +1060,8 @@ export declare const zoneMakeLocal: () => TimeZone.Named;
858
1060
  *
859
1061
  * Supports both IANA time zone identifiers and offset formats like "+03:00".
860
1062
  *
861
- * @example
1063
+ * **Example** (Parsing time zones)
1064
+ *
862
1065
  * ```ts
863
1066
  * import { DateTime } from "effect"
864
1067
  *
@@ -878,9 +1081,8 @@ export declare const zoneFromString: (zone: string) => Option.Option<TimeZone>;
878
1081
  /**
879
1082
  * Format a `TimeZone` as a string.
880
1083
  *
881
- * @since 3.6.0
882
- * @category time zones
883
- * @example
1084
+ * **Example** (Formatting time zones)
1085
+ *
884
1086
  * ```ts
885
1087
  * import { DateTime } from "effect"
886
1088
  *
@@ -890,15 +1092,17 @@ export declare const zoneFromString: (zone: string) => Option.Option<TimeZone>;
890
1092
  * // Outputs "Europe/London"
891
1093
  * DateTime.zoneToString(DateTime.zoneMakeNamedUnsafe("Europe/London"))
892
1094
  * ```
1095
+ *
1096
+ * @category time zones
1097
+ * @since 3.6.0
893
1098
  */
894
1099
  export declare const zoneToString: (self: TimeZone) => string;
895
1100
  /**
896
1101
  * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
897
1102
  * time zone is invalid, `None` will be returned.
898
1103
  *
899
- * @since 3.6.0
900
- * @category time zones
901
- * @example
1104
+ * **Example** (Setting named time zones safely)
1105
+ *
902
1106
  * ```ts
903
1107
  * import { DateTime, Effect } from "effect"
904
1108
  *
@@ -908,15 +1112,17 @@ export declare const zoneToString: (self: TimeZone) => string;
908
1112
  * DateTime.setZoneNamed(now, "Europe/London")
909
1113
  * })
910
1114
  * ```
1115
+ *
1116
+ * @category time zones
1117
+ * @since 3.6.0
911
1118
  */
912
1119
  export declare const setZoneNamed: {
913
1120
  /**
914
1121
  * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
915
1122
  * time zone is invalid, `None` will be returned.
916
1123
  *
917
- * @since 3.6.0
918
- * @category time zones
919
- * @example
1124
+ * **Example** (Setting named time zones safely)
1125
+ *
920
1126
  * ```ts
921
1127
  * import { DateTime, Effect } from "effect"
922
1128
  *
@@ -926,6 +1132,9 @@ export declare const setZoneNamed: {
926
1132
  * DateTime.setZoneNamed(now, "Europe/London")
927
1133
  * })
928
1134
  * ```
1135
+ *
1136
+ * @category time zones
1137
+ * @since 3.6.0
929
1138
  */
930
1139
  (zoneId: string, options?: {
931
1140
  readonly adjustForTimeZone?: boolean | undefined;
@@ -935,9 +1144,8 @@ export declare const setZoneNamed: {
935
1144
  * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
936
1145
  * time zone is invalid, `None` will be returned.
937
1146
  *
938
- * @since 3.6.0
939
- * @category time zones
940
- * @example
1147
+ * **Example** (Setting named time zones safely)
1148
+ *
941
1149
  * ```ts
942
1150
  * import { DateTime, Effect } from "effect"
943
1151
  *
@@ -947,6 +1155,9 @@ export declare const setZoneNamed: {
947
1155
  * DateTime.setZoneNamed(now, "Europe/London")
948
1156
  * })
949
1157
  * ```
1158
+ *
1159
+ * @category time zones
1160
+ * @since 3.6.0
950
1161
  */
951
1162
  (self: DateTime, zoneId: string, options?: {
952
1163
  readonly adjustForTimeZone?: boolean | undefined;
@@ -957,9 +1168,8 @@ export declare const setZoneNamed: {
957
1168
  * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
958
1169
  * time zone is invalid, an `IllegalArgumentError` will be thrown.
959
1170
  *
960
- * @since 3.6.0
961
- * @category time zones
962
- * @example
1171
+ * **Example** (Setting named time zones unsafely)
1172
+ *
963
1173
  * ```ts
964
1174
  * import { DateTime, Effect } from "effect"
965
1175
  *
@@ -969,15 +1179,17 @@ export declare const setZoneNamed: {
969
1179
  * DateTime.setZoneNamedUnsafe(now, "Europe/London")
970
1180
  * })
971
1181
  * ```
1182
+ *
1183
+ * @category time zones
1184
+ * @since 4.0.0
972
1185
  */
973
1186
  export declare const setZoneNamedUnsafe: {
974
1187
  /**
975
1188
  * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
976
1189
  * time zone is invalid, an `IllegalArgumentError` will be thrown.
977
1190
  *
978
- * @since 3.6.0
979
- * @category time zones
980
- * @example
1191
+ * **Example** (Setting named time zones unsafely)
1192
+ *
981
1193
  * ```ts
982
1194
  * import { DateTime, Effect } from "effect"
983
1195
  *
@@ -987,6 +1199,9 @@ export declare const setZoneNamedUnsafe: {
987
1199
  * DateTime.setZoneNamedUnsafe(now, "Europe/London")
988
1200
  * })
989
1201
  * ```
1202
+ *
1203
+ * @category time zones
1204
+ * @since 4.0.0
990
1205
  */
991
1206
  (zoneId: string, options?: {
992
1207
  readonly adjustForTimeZone?: boolean | undefined;
@@ -996,9 +1211,8 @@ export declare const setZoneNamedUnsafe: {
996
1211
  * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
997
1212
  * time zone is invalid, an `IllegalArgumentError` will be thrown.
998
1213
  *
999
- * @since 3.6.0
1000
- * @category time zones
1001
- * @example
1214
+ * **Example** (Setting named time zones unsafely)
1215
+ *
1002
1216
  * ```ts
1003
1217
  * import { DateTime, Effect } from "effect"
1004
1218
  *
@@ -1008,6 +1222,9 @@ export declare const setZoneNamedUnsafe: {
1008
1222
  * DateTime.setZoneNamedUnsafe(now, "Europe/London")
1009
1223
  * })
1010
1224
  * ```
1225
+ *
1226
+ * @category time zones
1227
+ * @since 4.0.0
1011
1228
  */
1012
1229
  (self: DateTime, zoneId: string, options?: {
1013
1230
  readonly adjustForTimeZone?: boolean | undefined;
@@ -1022,9 +1239,8 @@ export declare const setZoneNamedUnsafe: {
1022
1239
  * `other` is *before* `self`, the result will be a negative `Duration`. If they
1023
1240
  * are equal, the result will be a `Duration` of zero.
1024
1241
  *
1025
- * @since 3.6.0
1026
- * @category comparisons
1027
- * @example
1242
+ * **Example** (Measuring distance between DateTime values)
1243
+ *
1028
1244
  * ```ts
1029
1245
  * import { DateTime, Effect } from "effect"
1030
1246
  *
@@ -1036,6 +1252,9 @@ export declare const setZoneNamedUnsafe: {
1036
1252
  * DateTime.distance(now, other)
1037
1253
  * })
1038
1254
  * ```
1255
+ *
1256
+ * @category comparisons
1257
+ * @since 3.6.0
1039
1258
  */
1040
1259
  export declare const distance: {
1041
1260
  /**
@@ -1046,9 +1265,8 @@ export declare const distance: {
1046
1265
  * `other` is *before* `self`, the result will be a negative `Duration`. If they
1047
1266
  * are equal, the result will be a `Duration` of zero.
1048
1267
  *
1049
- * @since 3.6.0
1050
- * @category comparisons
1051
- * @example
1268
+ * **Example** (Measuring distance between DateTime values)
1269
+ *
1052
1270
  * ```ts
1053
1271
  * import { DateTime, Effect } from "effect"
1054
1272
  *
@@ -1060,6 +1278,9 @@ export declare const distance: {
1060
1278
  * DateTime.distance(now, other)
1061
1279
  * })
1062
1280
  * ```
1281
+ *
1282
+ * @category comparisons
1283
+ * @since 3.6.0
1063
1284
  */
1064
1285
  (other: DateTime): (self: DateTime) => Duration.Duration;
1065
1286
  /**
@@ -1070,9 +1291,8 @@ export declare const distance: {
1070
1291
  * `other` is *before* `self`, the result will be a negative `Duration`. If they
1071
1292
  * are equal, the result will be a `Duration` of zero.
1072
1293
  *
1073
- * @since 3.6.0
1074
- * @category comparisons
1075
- * @example
1294
+ * **Example** (Measuring distance between DateTime values)
1295
+ *
1076
1296
  * ```ts
1077
1297
  * import { DateTime, Effect } from "effect"
1078
1298
  *
@@ -1084,13 +1304,17 @@ export declare const distance: {
1084
1304
  * DateTime.distance(now, other)
1085
1305
  * })
1086
1306
  * ```
1307
+ *
1308
+ * @category comparisons
1309
+ * @since 3.6.0
1087
1310
  */
1088
1311
  (self: DateTime, other: DateTime): Duration.Duration;
1089
1312
  };
1090
1313
  /**
1091
1314
  * Returns the earlier of two `DateTime` values.
1092
1315
  *
1093
- * @example
1316
+ * **Example** (Selecting the earlier DateTime)
1317
+ *
1094
1318
  * ```ts
1095
1319
  * import { DateTime } from "effect"
1096
1320
  *
@@ -1108,7 +1332,8 @@ export declare const min: {
1108
1332
  /**
1109
1333
  * Returns the earlier of two `DateTime` values.
1110
1334
  *
1111
- * @example
1335
+ * **Example** (Selecting the earlier DateTime)
1336
+ *
1112
1337
  * ```ts
1113
1338
  * import { DateTime } from "effect"
1114
1339
  *
@@ -1126,7 +1351,8 @@ export declare const min: {
1126
1351
  /**
1127
1352
  * Returns the earlier of two `DateTime` values.
1128
1353
  *
1129
- * @example
1354
+ * **Example** (Selecting the earlier DateTime)
1355
+ *
1130
1356
  * ```ts
1131
1357
  * import { DateTime } from "effect"
1132
1358
  *
@@ -1145,7 +1371,8 @@ export declare const min: {
1145
1371
  /**
1146
1372
  * Returns the later of two `DateTime` values.
1147
1373
  *
1148
- * @example
1374
+ * **Example** (Selecting the later DateTime)
1375
+ *
1149
1376
  * ```ts
1150
1377
  * import { DateTime } from "effect"
1151
1378
  *
@@ -1163,7 +1390,8 @@ export declare const max: {
1163
1390
  /**
1164
1391
  * Returns the later of two `DateTime` values.
1165
1392
  *
1166
- * @example
1393
+ * **Example** (Selecting the later DateTime)
1394
+ *
1167
1395
  * ```ts
1168
1396
  * import { DateTime } from "effect"
1169
1397
  *
@@ -1181,7 +1409,8 @@ export declare const max: {
1181
1409
  /**
1182
1410
  * Returns the later of two `DateTime` values.
1183
1411
  *
1184
- * @example
1412
+ * **Example** (Selecting the later DateTime)
1413
+ *
1185
1414
  * ```ts
1186
1415
  * import { DateTime } from "effect"
1187
1416
  *
@@ -1200,7 +1429,8 @@ export declare const max: {
1200
1429
  /**
1201
1430
  * Checks if the first `DateTime` is after the second `DateTime`.
1202
1431
  *
1203
- * @example
1432
+ * **Example** (Checking whether a DateTime is later)
1433
+ *
1204
1434
  * ```ts
1205
1435
  * import { DateTime } from "effect"
1206
1436
  *
@@ -1212,13 +1442,14 @@ export declare const max: {
1212
1442
  * ```
1213
1443
  *
1214
1444
  * @category comparisons
1215
- * @since 3.6.0
1445
+ * @since 4.0.0
1216
1446
  */
1217
1447
  export declare const isGreaterThan: {
1218
1448
  /**
1219
1449
  * Checks if the first `DateTime` is after the second `DateTime`.
1220
1450
  *
1221
- * @example
1451
+ * **Example** (Checking whether a DateTime is later)
1452
+ *
1222
1453
  * ```ts
1223
1454
  * import { DateTime } from "effect"
1224
1455
  *
@@ -1230,13 +1461,14 @@ export declare const isGreaterThan: {
1230
1461
  * ```
1231
1462
  *
1232
1463
  * @category comparisons
1233
- * @since 3.6.0
1464
+ * @since 4.0.0
1234
1465
  */
1235
1466
  (that: DateTime): (self: DateTime) => boolean;
1236
1467
  /**
1237
1468
  * Checks if the first `DateTime` is after the second `DateTime`.
1238
1469
  *
1239
- * @example
1470
+ * **Example** (Checking whether a DateTime is later)
1471
+ *
1240
1472
  * ```ts
1241
1473
  * import { DateTime } from "effect"
1242
1474
  *
@@ -1248,14 +1480,15 @@ export declare const isGreaterThan: {
1248
1480
  * ```
1249
1481
  *
1250
1482
  * @category comparisons
1251
- * @since 3.6.0
1483
+ * @since 4.0.0
1252
1484
  */
1253
1485
  (self: DateTime, that: DateTime): boolean;
1254
1486
  };
1255
1487
  /**
1256
1488
  * Checks if the first `DateTime` is after or equal to the second `DateTime`.
1257
1489
  *
1258
- * @example
1490
+ * **Example** (Checking whether a DateTime is later or equal)
1491
+ *
1259
1492
  * ```ts
1260
1493
  * import { DateTime } from "effect"
1261
1494
  *
@@ -1269,13 +1502,14 @@ export declare const isGreaterThan: {
1269
1502
  * ```
1270
1503
  *
1271
1504
  * @category comparisons
1272
- * @since 3.6.0
1505
+ * @since 4.0.0
1273
1506
  */
1274
1507
  export declare const isGreaterThanOrEqualTo: {
1275
1508
  /**
1276
1509
  * Checks if the first `DateTime` is after or equal to the second `DateTime`.
1277
1510
  *
1278
- * @example
1511
+ * **Example** (Checking whether a DateTime is later or equal)
1512
+ *
1279
1513
  * ```ts
1280
1514
  * import { DateTime } from "effect"
1281
1515
  *
@@ -1289,13 +1523,14 @@ export declare const isGreaterThanOrEqualTo: {
1289
1523
  * ```
1290
1524
  *
1291
1525
  * @category comparisons
1292
- * @since 3.6.0
1526
+ * @since 4.0.0
1293
1527
  */
1294
1528
  (that: DateTime): (self: DateTime) => boolean;
1295
1529
  /**
1296
1530
  * Checks if the first `DateTime` is after or equal to the second `DateTime`.
1297
1531
  *
1298
- * @example
1532
+ * **Example** (Checking whether a DateTime is later or equal)
1533
+ *
1299
1534
  * ```ts
1300
1535
  * import { DateTime } from "effect"
1301
1536
  *
@@ -1309,14 +1544,15 @@ export declare const isGreaterThanOrEqualTo: {
1309
1544
  * ```
1310
1545
  *
1311
1546
  * @category comparisons
1312
- * @since 3.6.0
1547
+ * @since 4.0.0
1313
1548
  */
1314
1549
  (self: DateTime, that: DateTime): boolean;
1315
1550
  };
1316
1551
  /**
1317
1552
  * Checks if the first `DateTime` is before the second `DateTime`.
1318
1553
  *
1319
- * @example
1554
+ * **Example** (Checking whether a DateTime is earlier)
1555
+ *
1320
1556
  * ```ts
1321
1557
  * import { DateTime } from "effect"
1322
1558
  *
@@ -1328,13 +1564,14 @@ export declare const isGreaterThanOrEqualTo: {
1328
1564
  * ```
1329
1565
  *
1330
1566
  * @category comparisons
1331
- * @since 3.6.0
1567
+ * @since 4.0.0
1332
1568
  */
1333
1569
  export declare const isLessThan: {
1334
1570
  /**
1335
1571
  * Checks if the first `DateTime` is before the second `DateTime`.
1336
1572
  *
1337
- * @example
1573
+ * **Example** (Checking whether a DateTime is earlier)
1574
+ *
1338
1575
  * ```ts
1339
1576
  * import { DateTime } from "effect"
1340
1577
  *
@@ -1346,13 +1583,14 @@ export declare const isLessThan: {
1346
1583
  * ```
1347
1584
  *
1348
1585
  * @category comparisons
1349
- * @since 3.6.0
1586
+ * @since 4.0.0
1350
1587
  */
1351
1588
  (that: DateTime): (self: DateTime) => boolean;
1352
1589
  /**
1353
1590
  * Checks if the first `DateTime` is before the second `DateTime`.
1354
1591
  *
1355
- * @example
1592
+ * **Example** (Checking whether a DateTime is earlier)
1593
+ *
1356
1594
  * ```ts
1357
1595
  * import { DateTime } from "effect"
1358
1596
  *
@@ -1364,14 +1602,15 @@ export declare const isLessThan: {
1364
1602
  * ```
1365
1603
  *
1366
1604
  * @category comparisons
1367
- * @since 3.6.0
1605
+ * @since 4.0.0
1368
1606
  */
1369
1607
  (self: DateTime, that: DateTime): boolean;
1370
1608
  };
1371
1609
  /**
1372
1610
  * Checks if the first `DateTime` is before or equal to the second `DateTime`.
1373
1611
  *
1374
- * @example
1612
+ * **Example** (Checking whether a DateTime is earlier or equal)
1613
+ *
1375
1614
  * ```ts
1376
1615
  * import { DateTime } from "effect"
1377
1616
  *
@@ -1385,13 +1624,14 @@ export declare const isLessThan: {
1385
1624
  * ```
1386
1625
  *
1387
1626
  * @category comparisons
1388
- * @since 3.6.0
1627
+ * @since 4.0.0
1389
1628
  */
1390
1629
  export declare const isLessThanOrEqualTo: {
1391
1630
  /**
1392
1631
  * Checks if the first `DateTime` is before or equal to the second `DateTime`.
1393
1632
  *
1394
- * @example
1633
+ * **Example** (Checking whether a DateTime is earlier or equal)
1634
+ *
1395
1635
  * ```ts
1396
1636
  * import { DateTime } from "effect"
1397
1637
  *
@@ -1405,13 +1645,14 @@ export declare const isLessThanOrEqualTo: {
1405
1645
  * ```
1406
1646
  *
1407
1647
  * @category comparisons
1408
- * @since 3.6.0
1648
+ * @since 4.0.0
1409
1649
  */
1410
1650
  (that: DateTime): (self: DateTime) => boolean;
1411
1651
  /**
1412
1652
  * Checks if the first `DateTime` is before or equal to the second `DateTime`.
1413
1653
  *
1414
- * @example
1654
+ * **Example** (Checking whether a DateTime is earlier or equal)
1655
+ *
1415
1656
  * ```ts
1416
1657
  * import { DateTime } from "effect"
1417
1658
  *
@@ -1425,14 +1666,15 @@ export declare const isLessThanOrEqualTo: {
1425
1666
  * ```
1426
1667
  *
1427
1668
  * @category comparisons
1428
- * @since 3.6.0
1669
+ * @since 4.0.0
1429
1670
  */
1430
1671
  (self: DateTime, that: DateTime): boolean;
1431
1672
  };
1432
1673
  /**
1433
1674
  * Checks if a `DateTime` is between two other `DateTime` values (inclusive).
1434
1675
  *
1435
- * @example
1676
+ * **Example** (Checking whether a DateTime is within bounds)
1677
+ *
1436
1678
  * ```ts
1437
1679
  * import { DateTime } from "effect"
1438
1680
  *
@@ -1450,7 +1692,8 @@ export declare const between: {
1450
1692
  /**
1451
1693
  * Checks if a `DateTime` is between two other `DateTime` values (inclusive).
1452
1694
  *
1453
- * @example
1695
+ * **Example** (Checking whether a DateTime is within bounds)
1696
+ *
1454
1697
  * ```ts
1455
1698
  * import { DateTime } from "effect"
1456
1699
  *
@@ -1471,7 +1714,8 @@ export declare const between: {
1471
1714
  /**
1472
1715
  * Checks if a `DateTime` is between two other `DateTime` values (inclusive).
1473
1716
  *
1474
- * @example
1717
+ * **Example** (Checking whether a DateTime is within bounds)
1718
+ *
1475
1719
  * ```ts
1476
1720
  * import { DateTime } from "effect"
1477
1721
  *
@@ -1495,7 +1739,8 @@ export declare const between: {
1495
1739
  *
1496
1740
  * This is an effectful operation that uses the current time from the `Clock` service.
1497
1741
  *
1498
- * @example
1742
+ * **Example** (Checking future DateTime values effectfully)
1743
+ *
1499
1744
  * ```ts
1500
1745
  * import { DateTime, Effect } from "effect"
1501
1746
  *
@@ -1515,7 +1760,8 @@ export declare const isFuture: (self: DateTime) => Effect.Effect<boolean>;
1515
1760
  *
1516
1761
  * This is a synchronous version that uses `Date.now()` directly.
1517
1762
  *
1518
- * @example
1763
+ * **Example** (Checking future DateTime values unsafely)
1764
+ *
1519
1765
  * ```ts
1520
1766
  * import { DateTime } from "effect"
1521
1767
  *
@@ -1527,7 +1773,7 @@ export declare const isFuture: (self: DateTime) => Effect.Effect<boolean>;
1527
1773
  * ```
1528
1774
  *
1529
1775
  * @category comparisons
1530
- * @since 3.6.0
1776
+ * @since 4.0.0
1531
1777
  */
1532
1778
  export declare const isFutureUnsafe: (self: DateTime) => boolean;
1533
1779
  /**
@@ -1535,7 +1781,8 @@ export declare const isFutureUnsafe: (self: DateTime) => boolean;
1535
1781
  *
1536
1782
  * This is an effectful operation that uses the current time from the `Clock` service.
1537
1783
  *
1538
- * @example
1784
+ * **Example** (Checking past DateTime values effectfully)
1785
+ *
1539
1786
  * ```ts
1540
1787
  * import { DateTime, Effect } from "effect"
1541
1788
  *
@@ -1555,7 +1802,8 @@ export declare const isPast: (self: DateTime) => Effect.Effect<boolean>;
1555
1802
  *
1556
1803
  * This is a synchronous version that uses `Date.now()` directly.
1557
1804
  *
1558
- * @example
1805
+ * **Example** (Checking past DateTime values unsafely)
1806
+ *
1559
1807
  * ```ts
1560
1808
  * import { DateTime } from "effect"
1561
1809
  *
@@ -1567,7 +1815,7 @@ export declare const isPast: (self: DateTime) => Effect.Effect<boolean>;
1567
1815
  * ```
1568
1816
  *
1569
1817
  * @category comparisons
1570
- * @since 3.6.0
1818
+ * @since 4.0.0
1571
1819
  */
1572
1820
  export declare const isPastUnsafe: (self: DateTime) => boolean;
1573
1821
  /**
@@ -1575,7 +1823,8 @@ export declare const isPastUnsafe: (self: DateTime) => boolean;
1575
1823
  *
1576
1824
  * This always returns the UTC representation, ignoring any time zone information.
1577
1825
  *
1578
- * @example
1826
+ * **Example** (Converting DateTime values to UTC Dates)
1827
+ *
1579
1828
  * ```ts
1580
1829
  * import { DateTime } from "effect"
1581
1830
  *
@@ -1587,7 +1836,7 @@ export declare const isPastUnsafe: (self: DateTime) => boolean;
1587
1836
  * console.log(utcDate.toISOString()) // "2024-01-01T12:00:00.000Z"
1588
1837
  * ```
1589
1838
  *
1590
- * @category conversions
1839
+ * @category converting
1591
1840
  * @since 3.6.0
1592
1841
  */
1593
1842
  export declare const toDateUtc: (self: DateTime) => Date;
@@ -1597,7 +1846,8 @@ export declare const toDateUtc: (self: DateTime) => Date;
1597
1846
  * For `DateTime.Zoned`, this adjusts for the time zone before converting.
1598
1847
  * For `DateTime.Utc`, this is equivalent to `toDateUtc`.
1599
1848
  *
1600
- * @example
1849
+ * **Example** (Converting DateTime values to Dates)
1850
+ *
1601
1851
  * ```ts
1602
1852
  * import { DateTime } from "effect"
1603
1853
  *
@@ -1610,7 +1860,7 @@ export declare const toDateUtc: (self: DateTime) => Date;
1610
1860
  * console.log(DateTime.toDate(zoned).toISOString())
1611
1861
  * ```
1612
1862
  *
1613
- * @category conversions
1863
+ * @category converting
1614
1864
  * @since 3.6.0
1615
1865
  */
1616
1866
  export declare const toDate: (self: DateTime) => Date;
@@ -1620,7 +1870,8 @@ export declare const toDate: (self: DateTime) => Date;
1620
1870
  * Returns the offset from UTC in milliseconds. Positive values indicate
1621
1871
  * time zones ahead of UTC, negative values indicate time zones behind UTC.
1622
1872
  *
1623
- * @example
1873
+ * **Example** (Reading zoned offsets)
1874
+ *
1624
1875
  * ```ts
1625
1876
  * import { DateTime } from "effect"
1626
1877
  *
@@ -1632,7 +1883,7 @@ export declare const toDate: (self: DateTime) => Date;
1632
1883
  * console.log(offset) // 0 (London is UTC+0 in winter)
1633
1884
  * ```
1634
1885
  *
1635
- * @category conversions
1886
+ * @category converting
1636
1887
  * @since 3.6.0
1637
1888
  */
1638
1889
  export declare const zonedOffset: (self: Zoned) => number;
@@ -1641,7 +1892,8 @@ export declare const zonedOffset: (self: Zoned) => number;
1641
1892
  *
1642
1893
  * The offset is formatted as "±HH:MM".
1643
1894
  *
1644
- * @example
1895
+ * **Example** (Formatting zoned offsets)
1896
+ *
1645
1897
  * ```ts
1646
1898
  * import { DateTime } from "effect"
1647
1899
  *
@@ -1653,7 +1905,7 @@ export declare const zonedOffset: (self: Zoned) => number;
1653
1905
  * console.log(offsetString) // "+03:00"
1654
1906
  * ```
1655
1907
  *
1656
- * @category conversions
1908
+ * @category converting
1657
1909
  * @since 3.6.0
1658
1910
  */
1659
1911
  export declare const zonedOffsetIso: (self: Zoned) => string;
@@ -1662,7 +1914,8 @@ export declare const zonedOffsetIso: (self: Zoned) => string;
1662
1914
  *
1663
1915
  * This returns the UTC timestamp regardless of any time zone information.
1664
1916
  *
1665
- * @example
1917
+ * **Example** (Reading epoch milliseconds)
1918
+ *
1666
1919
  * ```ts
1667
1920
  * import { DateTime } from "effect"
1668
1921
  *
@@ -1670,10 +1923,9 @@ export declare const zonedOffsetIso: (self: Zoned) => string;
1670
1923
  * const epochMillis = DateTime.toEpochMillis(dt)
1671
1924
  *
1672
1925
  * console.log(epochMillis) // 1704067200000
1673
- * console.log(new Date(epochMillis).toISOString()) // "2024-01-01T00:00:00.000Z"
1674
1926
  * ```
1675
1927
  *
1676
- * @category conversions
1928
+ * @category converting
1677
1929
  * @since 3.6.0
1678
1930
  */
1679
1931
  export declare const toEpochMillis: (self: DateTime) => number;
@@ -1681,9 +1933,8 @@ export declare const toEpochMillis: (self: DateTime) => number;
1681
1933
  * Remove the time aspect of a `DateTime`, first adjusting for the time
1682
1934
  * zone. It will return a `DateTime.Utc` only containing the date.
1683
1935
  *
1684
- * @since 3.6.0
1685
- * @category conversions
1686
- * @example
1936
+ * **Example** (Removing time components)
1937
+ *
1687
1938
  * ```ts
1688
1939
  * import { DateTime } from "effect"
1689
1940
  *
@@ -1696,6 +1947,9 @@ export declare const toEpochMillis: (self: DateTime) => number;
1696
1947
  * DateTime.formatIso
1697
1948
  * )
1698
1949
  * ```
1950
+ *
1951
+ * @category converting
1952
+ * @since 3.6.0
1699
1953
  */
1700
1954
  export declare const removeTime: (self: DateTime) => Utc;
1701
1955
  /**
@@ -1703,7 +1957,8 @@ export declare const removeTime: (self: DateTime) => Utc;
1703
1957
  *
1704
1958
  * The parts will be time zone adjusted if the `DateTime` is zoned.
1705
1959
  *
1706
- * @example
1960
+ * **Example** (Reading DateTime parts)
1961
+ *
1707
1962
  * ```ts
1708
1963
  * import { DateTime } from "effect"
1709
1964
  *
@@ -1732,7 +1987,8 @@ export declare const toParts: (self: DateTime) => DateTime.PartsWithWeekday;
1732
1987
  *
1733
1988
  * The parts will always be in UTC, ignoring any time zone information.
1734
1989
  *
1735
- * @example
1990
+ * **Example** (Reading UTC DateTime parts)
1991
+ *
1736
1992
  * ```ts
1737
1993
  * import { DateTime } from "effect"
1738
1994
  *
@@ -1754,17 +2010,18 @@ export declare const toPartsUtc: (self: DateTime) => DateTime.PartsWithWeekday;
1754
2010
  *
1755
2011
  * The part will be in the UTC time zone.
1756
2012
  *
1757
- * @since 3.6.0
1758
- * @category parts
1759
- * @example
2013
+ * **Example** (Reading UTC DateTime parts by key)
2014
+ *
1760
2015
  * ```ts
1761
2016
  * import { DateTime } from "effect"
1762
- * import * as assert from "node:assert"
1763
2017
  *
1764
- * const now = DateTime.makeUnsafe({ year: 2024 })
1765
- * const year = DateTime.getPartUtc(now, "year")
1766
- * assert.strictEqual(year, 2024)
2018
+ * const dateTime = DateTime.makeUnsafe({ year: 2024 })
2019
+ * const year = DateTime.getPartUtc(dateTime, "year")
2020
+ * console.log(year) // 2024
1767
2021
  * ```
2022
+ *
2023
+ * @category parts
2024
+ * @since 3.6.0
1768
2025
  */
1769
2026
  export declare const getPartUtc: {
1770
2027
  /**
@@ -1772,17 +2029,18 @@ export declare const getPartUtc: {
1772
2029
  *
1773
2030
  * The part will be in the UTC time zone.
1774
2031
  *
1775
- * @since 3.6.0
1776
- * @category parts
1777
- * @example
2032
+ * **Example** (Reading UTC DateTime parts by key)
2033
+ *
1778
2034
  * ```ts
1779
2035
  * import { DateTime } from "effect"
1780
- * import * as assert from "node:assert"
1781
2036
  *
1782
- * const now = DateTime.makeUnsafe({ year: 2024 })
1783
- * const year = DateTime.getPartUtc(now, "year")
1784
- * assert.strictEqual(year, 2024)
2037
+ * const dateTime = DateTime.makeUnsafe({ year: 2024 })
2038
+ * const year = DateTime.getPartUtc(dateTime, "year")
2039
+ * console.log(year) // 2024
1785
2040
  * ```
2041
+ *
2042
+ * @category parts
2043
+ * @since 3.6.0
1786
2044
  */
1787
2045
  (part: keyof DateTime.PartsWithWeekday): (self: DateTime) => number;
1788
2046
  /**
@@ -1790,17 +2048,18 @@ export declare const getPartUtc: {
1790
2048
  *
1791
2049
  * The part will be in the UTC time zone.
1792
2050
  *
1793
- * @since 3.6.0
1794
- * @category parts
1795
- * @example
2051
+ * **Example** (Reading UTC DateTime parts by key)
2052
+ *
1796
2053
  * ```ts
1797
2054
  * import { DateTime } from "effect"
1798
- * import * as assert from "node:assert"
1799
2055
  *
1800
- * const now = DateTime.makeUnsafe({ year: 2024 })
1801
- * const year = DateTime.getPartUtc(now, "year")
1802
- * assert.strictEqual(year, 2024)
2056
+ * const dateTime = DateTime.makeUnsafe({ year: 2024 })
2057
+ * const year = DateTime.getPartUtc(dateTime, "year")
2058
+ * console.log(year) // 2024
1803
2059
  * ```
2060
+ *
2061
+ * @category parts
2062
+ * @since 3.6.0
1804
2063
  */
1805
2064
  (self: DateTime, part: keyof DateTime.PartsWithWeekday): number;
1806
2065
  };
@@ -1809,19 +2068,20 @@ export declare const getPartUtc: {
1809
2068
  *
1810
2069
  * The part will be time zone adjusted.
1811
2070
  *
1812
- * @since 3.6.0
1813
- * @category parts
1814
- * @example
2071
+ * **Example** (Reading DateTime parts by key)
2072
+ *
1815
2073
  * ```ts
1816
2074
  * import { DateTime } from "effect"
1817
- * import * as assert from "node:assert"
1818
2075
  *
1819
- * const now = DateTime.makeZonedUnsafe({ year: 2024 }, {
2076
+ * const dateTime = DateTime.makeZonedUnsafe({ year: 2024 }, {
1820
2077
  * timeZone: "Europe/London"
1821
2078
  * })
1822
- * const year = DateTime.getPart(now, "year")
1823
- * assert.strictEqual(year, 2024)
2079
+ * const year = DateTime.getPart(dateTime, "year")
2080
+ * console.log(year) // 2024
1824
2081
  * ```
2082
+ *
2083
+ * @category parts
2084
+ * @since 3.6.0
1825
2085
  */
1826
2086
  export declare const getPart: {
1827
2087
  /**
@@ -1829,19 +2089,20 @@ export declare const getPart: {
1829
2089
  *
1830
2090
  * The part will be time zone adjusted.
1831
2091
  *
1832
- * @since 3.6.0
1833
- * @category parts
1834
- * @example
2092
+ * **Example** (Reading DateTime parts by key)
2093
+ *
1835
2094
  * ```ts
1836
2095
  * import { DateTime } from "effect"
1837
- * import * as assert from "node:assert"
1838
2096
  *
1839
- * const now = DateTime.makeZonedUnsafe({ year: 2024 }, {
2097
+ * const dateTime = DateTime.makeZonedUnsafe({ year: 2024 }, {
1840
2098
  * timeZone: "Europe/London"
1841
2099
  * })
1842
- * const year = DateTime.getPart(now, "year")
1843
- * assert.strictEqual(year, 2024)
2100
+ * const year = DateTime.getPart(dateTime, "year")
2101
+ * console.log(year) // 2024
1844
2102
  * ```
2103
+ *
2104
+ * @category parts
2105
+ * @since 3.6.0
1845
2106
  */
1846
2107
  (part: keyof DateTime.PartsWithWeekday): (self: DateTime) => number;
1847
2108
  /**
@@ -1849,19 +2110,20 @@ export declare const getPart: {
1849
2110
  *
1850
2111
  * The part will be time zone adjusted.
1851
2112
  *
1852
- * @since 3.6.0
1853
- * @category parts
1854
- * @example
2113
+ * **Example** (Reading DateTime parts by key)
2114
+ *
1855
2115
  * ```ts
1856
2116
  * import { DateTime } from "effect"
1857
- * import * as assert from "node:assert"
1858
2117
  *
1859
- * const now = DateTime.makeZonedUnsafe({ year: 2024 }, {
2118
+ * const dateTime = DateTime.makeZonedUnsafe({ year: 2024 }, {
1860
2119
  * timeZone: "Europe/London"
1861
2120
  * })
1862
- * const year = DateTime.getPart(now, "year")
1863
- * assert.strictEqual(year, 2024)
2121
+ * const year = DateTime.getPart(dateTime, "year")
2122
+ * console.log(year) // 2024
1864
2123
  * ```
2124
+ *
2125
+ * @category parts
2126
+ * @since 3.6.0
1865
2127
  */
1866
2128
  (self: DateTime, part: keyof DateTime.PartsWithWeekday): number;
1867
2129
  };
@@ -1870,7 +2132,8 @@ export declare const getPart: {
1870
2132
  *
1871
2133
  * The date will be time zone adjusted for `DateTime.Zoned`.
1872
2134
  *
1873
- * @example
2135
+ * **Example** (Updating DateTime parts)
2136
+ *
1874
2137
  * ```ts
1875
2138
  * import { DateTime } from "effect"
1876
2139
  *
@@ -1893,7 +2156,8 @@ export declare const setParts: {
1893
2156
  *
1894
2157
  * The date will be time zone adjusted for `DateTime.Zoned`.
1895
2158
  *
1896
- * @example
2159
+ * **Example** (Updating DateTime parts)
2160
+ *
1897
2161
  * ```ts
1898
2162
  * import { DateTime } from "effect"
1899
2163
  *
@@ -1916,7 +2180,8 @@ export declare const setParts: {
1916
2180
  *
1917
2181
  * The date will be time zone adjusted for `DateTime.Zoned`.
1918
2182
  *
1919
- * @example
2183
+ * **Example** (Updating DateTime parts)
2184
+ *
1920
2185
  * ```ts
1921
2186
  * import { DateTime } from "effect"
1922
2187
  *
@@ -1940,7 +2205,8 @@ export declare const setParts: {
1940
2205
  *
1941
2206
  * The parts are always interpreted as UTC, ignoring any time zone information.
1942
2207
  *
1943
- * @example
2208
+ * **Example** (Updating UTC DateTime parts)
2209
+ *
1944
2210
  * ```ts
1945
2211
  * import { DateTime } from "effect"
1946
2212
  *
@@ -1962,7 +2228,8 @@ export declare const setPartsUtc: {
1962
2228
  *
1963
2229
  * The parts are always interpreted as UTC, ignoring any time zone information.
1964
2230
  *
1965
- * @example
2231
+ * **Example** (Updating UTC DateTime parts)
2232
+ *
1966
2233
  * ```ts
1967
2234
  * import { DateTime } from "effect"
1968
2235
  *
@@ -1984,7 +2251,8 @@ export declare const setPartsUtc: {
1984
2251
  *
1985
2252
  * The parts are always interpreted as UTC, ignoring any time zone information.
1986
2253
  *
1987
- * @example
2254
+ * **Example** (Updating UTC DateTime parts)
2255
+ *
1988
2256
  * ```ts
1989
2257
  * import { DateTime } from "effect"
1990
2258
  *
@@ -2004,7 +2272,15 @@ export declare const setPartsUtc: {
2004
2272
  };
2005
2273
  declare const CurrentTimeZone_base: Context.ServiceClass<CurrentTimeZone, "effect/DateTime/CurrentTimeZone", TimeZone>;
2006
2274
  /**
2007
- * @example
2275
+ * Context service that supplies the ambient `TimeZone` for APIs that work in
2276
+ * the current zone, such as `DateTime.setZoneCurrent` and
2277
+ * `DateTime.nowInCurrentZone`.
2278
+ *
2279
+ * Provide it with `DateTime.withCurrentZone`, one of the `withCurrentZone*`
2280
+ * helpers, or one of the `layerCurrentZone*` layers.
2281
+ *
2282
+ * **Example** (Accessing the current time zone service)
2283
+ *
2008
2284
  * ```ts
2009
2285
  * import { DateTime, Effect } from "effect"
2010
2286
  *
@@ -2019,8 +2295,8 @@ declare const CurrentTimeZone_base: Context.ServiceClass<CurrentTimeZone, "effec
2019
2295
  * Effect.provide(program, layer)
2020
2296
  * ```
2021
2297
  *
2022
- * @since 3.11.0
2023
2298
  * @category current time zone
2299
+ * @since 3.11.0
2024
2300
  */
2025
2301
  export declare class CurrentTimeZone extends CurrentTimeZone_base {
2026
2302
  }
@@ -2028,9 +2304,8 @@ export declare class CurrentTimeZone extends CurrentTimeZone_base {
2028
2304
  * Set the time zone of a `DateTime` to the current time zone, which is
2029
2305
  * determined by the `CurrentTimeZone` service.
2030
2306
  *
2031
- * @since 3.6.0
2032
- * @category current time zone
2033
- * @example
2307
+ * **Example** (Setting the current time zone)
2308
+ *
2034
2309
  * ```ts
2035
2310
  * import { DateTime, Effect } from "effect"
2036
2311
  *
@@ -2041,14 +2316,16 @@ export declare class CurrentTimeZone extends CurrentTimeZone_base {
2041
2316
  * const zoned = yield* DateTime.setZoneCurrent(now)
2042
2317
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
2043
2318
  * ```
2319
+ *
2320
+ * @category current time zone
2321
+ * @since 3.6.0
2044
2322
  */
2045
2323
  export declare const setZoneCurrent: (self: DateTime) => Effect.Effect<Zoned, never, CurrentTimeZone>;
2046
2324
  /**
2047
2325
  * Provide the `CurrentTimeZone` to an effect.
2048
2326
  *
2049
- * @since 3.6.0
2050
- * @category current time zone
2051
- * @example
2327
+ * **Example** (Providing the current time zone)
2328
+ *
2052
2329
  * ```ts
2053
2330
  * import { DateTime, Effect } from "effect"
2054
2331
  *
@@ -2058,14 +2335,16 @@ export declare const setZoneCurrent: (self: DateTime) => Effect.Effect<Zoned, ne
2058
2335
  * const now = yield* DateTime.nowInCurrentZone
2059
2336
  * }).pipe(DateTime.withCurrentZone(zone))
2060
2337
  * ```
2338
+ *
2339
+ * @category current time zone
2340
+ * @since 3.6.0
2061
2341
  */
2062
2342
  export declare const withCurrentZone: {
2063
2343
  /**
2064
2344
  * Provide the `CurrentTimeZone` to an effect.
2065
2345
  *
2066
- * @since 3.6.0
2067
- * @category current time zone
2068
- * @example
2346
+ * **Example** (Providing the current time zone)
2347
+ *
2069
2348
  * ```ts
2070
2349
  * import { DateTime, Effect } from "effect"
2071
2350
  *
@@ -2075,14 +2354,16 @@ export declare const withCurrentZone: {
2075
2354
  * const now = yield* DateTime.nowInCurrentZone
2076
2355
  * }).pipe(DateTime.withCurrentZone(zone))
2077
2356
  * ```
2357
+ *
2358
+ * @category current time zone
2359
+ * @since 3.6.0
2078
2360
  */
2079
2361
  (value: TimeZone): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
2080
2362
  /**
2081
2363
  * Provide the `CurrentTimeZone` to an effect.
2082
2364
  *
2083
- * @since 3.6.0
2084
- * @category current time zone
2085
- * @example
2365
+ * **Example** (Providing the current time zone)
2366
+ *
2086
2367
  * ```ts
2087
2368
  * import { DateTime, Effect } from "effect"
2088
2369
  *
@@ -2092,6 +2373,9 @@ export declare const withCurrentZone: {
2092
2373
  * const now = yield* DateTime.nowInCurrentZone
2093
2374
  * }).pipe(DateTime.withCurrentZone(zone))
2094
2375
  * ```
2376
+ *
2377
+ * @category current time zone
2378
+ * @since 3.6.0
2095
2379
  */
2096
2380
  <A, E, R>(self: Effect.Effect<A, E, R>, value: TimeZone): Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
2097
2381
  };
@@ -2099,9 +2383,8 @@ export declare const withCurrentZone: {
2099
2383
  * Provide the `CurrentTimeZone` to an effect, using the system's local time
2100
2384
  * zone.
2101
2385
  *
2102
- * @since 3.6.0
2103
- * @category current time zone
2104
- * @example
2386
+ * **Example** (Providing the local time zone)
2387
+ *
2105
2388
  * ```ts
2106
2389
  * import { DateTime, Effect } from "effect"
2107
2390
  *
@@ -2110,54 +2393,63 @@ export declare const withCurrentZone: {
2110
2393
  * const now = yield* DateTime.nowInCurrentZone
2111
2394
  * }).pipe(DateTime.withCurrentZoneLocal)
2112
2395
  * ```
2396
+ *
2397
+ * @category current time zone
2398
+ * @since 3.6.0
2113
2399
  */
2114
2400
  export declare const withCurrentZoneLocal: <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
2115
2401
  /**
2116
2402
  * Provide the `CurrentTimeZone` to an effect, using a offset.
2117
2403
  *
2118
- * @since 3.6.0
2119
- * @category current time zone
2120
- * @example
2404
+ * **Example** (Providing a fixed-offset time zone)
2405
+ *
2121
2406
  * ```ts
2122
2407
  * import { DateTime, Effect } from "effect"
2123
2408
  *
2124
2409
  * Effect.gen(function*() {
2125
- * // will use the system's local time zone
2126
- * const now = yield* DateTime.nowInCurrentZone
2410
+ * const zone = yield* DateTime.CurrentTimeZone
2411
+ * console.log(DateTime.zoneToString(zone)) // "+03:00"
2127
2412
  * }).pipe(DateTime.withCurrentZoneOffset(3 * 60 * 60 * 1000))
2128
2413
  * ```
2414
+ *
2415
+ * @category current time zone
2416
+ * @since 3.6.0
2129
2417
  */
2130
2418
  export declare const withCurrentZoneOffset: {
2131
2419
  /**
2132
2420
  * Provide the `CurrentTimeZone` to an effect, using a offset.
2133
2421
  *
2134
- * @since 3.6.0
2135
- * @category current time zone
2136
- * @example
2422
+ * **Example** (Providing a fixed-offset time zone)
2423
+ *
2137
2424
  * ```ts
2138
2425
  * import { DateTime, Effect } from "effect"
2139
2426
  *
2140
2427
  * Effect.gen(function*() {
2141
- * // will use the system's local time zone
2142
- * const now = yield* DateTime.nowInCurrentZone
2428
+ * const zone = yield* DateTime.CurrentTimeZone
2429
+ * console.log(DateTime.zoneToString(zone)) // "+03:00"
2143
2430
  * }).pipe(DateTime.withCurrentZoneOffset(3 * 60 * 60 * 1000))
2144
2431
  * ```
2432
+ *
2433
+ * @category current time zone
2434
+ * @since 3.6.0
2145
2435
  */
2146
2436
  (offset: number): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
2147
2437
  /**
2148
2438
  * Provide the `CurrentTimeZone` to an effect, using a offset.
2149
2439
  *
2150
- * @since 3.6.0
2151
- * @category current time zone
2152
- * @example
2440
+ * **Example** (Providing a fixed-offset time zone)
2441
+ *
2153
2442
  * ```ts
2154
2443
  * import { DateTime, Effect } from "effect"
2155
2444
  *
2156
2445
  * Effect.gen(function*() {
2157
- * // will use the system's local time zone
2158
- * const now = yield* DateTime.nowInCurrentZone
2446
+ * const zone = yield* DateTime.CurrentTimeZone
2447
+ * console.log(DateTime.zoneToString(zone)) // "+03:00"
2159
2448
  * }).pipe(DateTime.withCurrentZoneOffset(3 * 60 * 60 * 1000))
2160
2449
  * ```
2450
+ *
2451
+ * @category current time zone
2452
+ * @since 3.6.0
2161
2453
  */
2162
2454
  <A, E, R>(effect: Effect.Effect<A, E, R>, offset: number): Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
2163
2455
  };
@@ -2167,9 +2459,8 @@ export declare const withCurrentZoneOffset: {
2167
2459
  *
2168
2460
  * If the time zone is invalid, it will fail with an `IllegalArgumentError`.
2169
2461
  *
2170
- * @since 3.6.0
2171
- * @category current time zone
2172
- * @example
2462
+ * **Example** (Providing a named time zone)
2463
+ *
2173
2464
  * ```ts
2174
2465
  * import { DateTime, Effect } from "effect"
2175
2466
  *
@@ -2178,6 +2469,9 @@ export declare const withCurrentZoneOffset: {
2178
2469
  * const now = yield* DateTime.nowInCurrentZone
2179
2470
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
2180
2471
  * ```
2472
+ *
2473
+ * @category current time zone
2474
+ * @since 3.6.0
2181
2475
  */
2182
2476
  export declare const withCurrentZoneNamed: {
2183
2477
  /**
@@ -2186,9 +2480,8 @@ export declare const withCurrentZoneNamed: {
2186
2480
  *
2187
2481
  * If the time zone is invalid, it will fail with an `IllegalArgumentError`.
2188
2482
  *
2189
- * @since 3.6.0
2190
- * @category current time zone
2191
- * @example
2483
+ * **Example** (Providing a named time zone)
2484
+ *
2192
2485
  * ```ts
2193
2486
  * import { DateTime, Effect } from "effect"
2194
2487
  *
@@ -2197,6 +2490,9 @@ export declare const withCurrentZoneNamed: {
2197
2490
  * const now = yield* DateTime.nowInCurrentZone
2198
2491
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
2199
2492
  * ```
2493
+ *
2494
+ * @category current time zone
2495
+ * @since 3.6.0
2200
2496
  */
2201
2497
  (zone: string): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E | IllegalArgumentError, Exclude<R, CurrentTimeZone>>;
2202
2498
  /**
@@ -2205,9 +2501,8 @@ export declare const withCurrentZoneNamed: {
2205
2501
  *
2206
2502
  * If the time zone is invalid, it will fail with an `IllegalArgumentError`.
2207
2503
  *
2208
- * @since 3.6.0
2209
- * @category current time zone
2210
- * @example
2504
+ * **Example** (Providing a named time zone)
2505
+ *
2211
2506
  * ```ts
2212
2507
  * import { DateTime, Effect } from "effect"
2213
2508
  *
@@ -2216,15 +2511,17 @@ export declare const withCurrentZoneNamed: {
2216
2511
  * const now = yield* DateTime.nowInCurrentZone
2217
2512
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
2218
2513
  * ```
2514
+ *
2515
+ * @category current time zone
2516
+ * @since 3.6.0
2219
2517
  */
2220
2518
  <A, E, R>(effect: Effect.Effect<A, E, R>, zone: string): Effect.Effect<A, E | IllegalArgumentError, Exclude<R, CurrentTimeZone>>;
2221
2519
  };
2222
2520
  /**
2223
2521
  * Get the current time as a `DateTime.Zoned`, using the `CurrentTimeZone`.
2224
2522
  *
2225
- * @since 3.6.0
2226
- * @category current time zone
2227
- * @example
2523
+ * **Example** (Getting the current time in the current zone)
2524
+ *
2228
2525
  * ```ts
2229
2526
  * import { DateTime, Effect } from "effect"
2230
2527
  *
@@ -2233,6 +2530,9 @@ export declare const withCurrentZoneNamed: {
2233
2530
  * const now = yield* DateTime.nowInCurrentZone
2234
2531
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
2235
2532
  * ```
2533
+ *
2534
+ * @category current time zone
2535
+ * @since 3.6.0
2236
2536
  */
2237
2537
  export declare const nowInCurrentZone: Effect.Effect<Zoned, never, CurrentTimeZone>;
2238
2538
  /**
@@ -2243,7 +2543,8 @@ export declare const nowInCurrentZone: Effect.Effect<Zoned, never, CurrentTimeZo
2243
2543
  *
2244
2544
  * Supports `disambiguation` when the new wall clock time is ambiguous.
2245
2545
  *
2246
- * @example
2546
+ * **Example** (Mutating DateTime values with Dates)
2547
+ *
2247
2548
  * ```ts
2248
2549
  * import { DateTime } from "effect"
2249
2550
  *
@@ -2257,8 +2558,8 @@ export declare const nowInCurrentZone: Effect.Effect<Zoned, never, CurrentTimeZo
2257
2558
  * console.log(DateTime.formatIso(modified)) // "2024-01-01T15:30:00.000Z"
2258
2559
  * ```
2259
2560
  *
2260
- * @since 3.6.0
2261
2561
  * @category mapping
2562
+ * @since 3.6.0
2262
2563
  */
2263
2564
  export declare const mutate: {
2264
2565
  /**
@@ -2269,7 +2570,8 @@ export declare const mutate: {
2269
2570
  *
2270
2571
  * Supports `disambiguation` when the new wall clock time is ambiguous.
2271
2572
  *
2272
- * @example
2573
+ * **Example** (Mutating DateTime values with Dates)
2574
+ *
2273
2575
  * ```ts
2274
2576
  * import { DateTime } from "effect"
2275
2577
  *
@@ -2283,8 +2585,8 @@ export declare const mutate: {
2283
2585
  * console.log(DateTime.formatIso(modified)) // "2024-01-01T15:30:00.000Z"
2284
2586
  * ```
2285
2587
  *
2286
- * @since 3.6.0
2287
2588
  * @category mapping
2589
+ * @since 3.6.0
2288
2590
  */
2289
2591
  (f: (date: Date) => void, options?: {
2290
2592
  readonly disambiguation?: Disambiguation | undefined;
@@ -2297,7 +2599,8 @@ export declare const mutate: {
2297
2599
  *
2298
2600
  * Supports `disambiguation` when the new wall clock time is ambiguous.
2299
2601
  *
2300
- * @example
2602
+ * **Example** (Mutating DateTime values with Dates)
2603
+ *
2301
2604
  * ```ts
2302
2605
  * import { DateTime } from "effect"
2303
2606
  *
@@ -2311,8 +2614,8 @@ export declare const mutate: {
2311
2614
  * console.log(DateTime.formatIso(modified)) // "2024-01-01T15:30:00.000Z"
2312
2615
  * ```
2313
2616
  *
2314
- * @since 3.6.0
2315
2617
  * @category mapping
2618
+ * @since 3.6.0
2316
2619
  */
2317
2620
  <A extends DateTime>(self: A, f: (date: Date) => void, options?: {
2318
2621
  readonly disambiguation?: Disambiguation | undefined;
@@ -2321,7 +2624,8 @@ export declare const mutate: {
2321
2624
  /**
2322
2625
  * Modify a `DateTime` by applying a function to a cloned UTC `Date` instance.
2323
2626
  *
2324
- * @example
2627
+ * **Example** (Mutating DateTime values with UTC Dates)
2628
+ *
2325
2629
  * ```ts
2326
2630
  * import { DateTime } from "effect"
2327
2631
  *
@@ -2336,14 +2640,15 @@ export declare const mutate: {
2336
2640
  * console.log(DateTime.formatIso(modified)) // "2024-01-01T18:00:00.000Z"
2337
2641
  * ```
2338
2642
  *
2339
- * @since 3.6.0
2340
2643
  * @category mapping
2644
+ * @since 3.6.0
2341
2645
  */
2342
2646
  export declare const mutateUtc: {
2343
2647
  /**
2344
2648
  * Modify a `DateTime` by applying a function to a cloned UTC `Date` instance.
2345
2649
  *
2346
- * @example
2650
+ * **Example** (Mutating DateTime values with UTC Dates)
2651
+ *
2347
2652
  * ```ts
2348
2653
  * import { DateTime } from "effect"
2349
2654
  *
@@ -2358,14 +2663,15 @@ export declare const mutateUtc: {
2358
2663
  * console.log(DateTime.formatIso(modified)) // "2024-01-01T18:00:00.000Z"
2359
2664
  * ```
2360
2665
  *
2361
- * @since 3.6.0
2362
2666
  * @category mapping
2667
+ * @since 3.6.0
2363
2668
  */
2364
2669
  (f: (date: Date) => void): <A extends DateTime>(self: A) => A;
2365
2670
  /**
2366
2671
  * Modify a `DateTime` by applying a function to a cloned UTC `Date` instance.
2367
2672
  *
2368
- * @example
2673
+ * **Example** (Mutating DateTime values with UTC Dates)
2674
+ *
2369
2675
  * ```ts
2370
2676
  * import { DateTime } from "effect"
2371
2677
  *
@@ -2380,8 +2686,8 @@ export declare const mutateUtc: {
2380
2686
  * console.log(DateTime.formatIso(modified)) // "2024-01-01T18:00:00.000Z"
2381
2687
  * ```
2382
2688
  *
2383
- * @since 3.6.0
2384
2689
  * @category mapping
2690
+ * @since 3.6.0
2385
2691
  */
2386
2692
  <A extends DateTime>(self: A, f: (date: Date) => void): A;
2387
2693
  };
@@ -2389,9 +2695,8 @@ export declare const mutateUtc: {
2389
2695
  * Transform a `DateTime` by applying a function to the number of milliseconds
2390
2696
  * since the Unix epoch.
2391
2697
  *
2392
- * @since 3.6.0
2393
- * @category mapping
2394
- * @example
2698
+ * **Example** (Mapping epoch milliseconds)
2699
+ *
2395
2700
  * ```ts
2396
2701
  * import { DateTime } from "effect"
2397
2702
  *
@@ -2400,15 +2705,17 @@ export declare const mutateUtc: {
2400
2705
  * DateTime.mapEpochMillis((millis) => millis + 10)
2401
2706
  * )
2402
2707
  * ```
2708
+ *
2709
+ * @category mapping
2710
+ * @since 3.6.0
2403
2711
  */
2404
2712
  export declare const mapEpochMillis: {
2405
2713
  /**
2406
2714
  * Transform a `DateTime` by applying a function to the number of milliseconds
2407
2715
  * since the Unix epoch.
2408
2716
  *
2409
- * @since 3.6.0
2410
- * @category mapping
2411
- * @example
2717
+ * **Example** (Mapping epoch milliseconds)
2718
+ *
2412
2719
  * ```ts
2413
2720
  * import { DateTime } from "effect"
2414
2721
  *
@@ -2417,15 +2724,17 @@ export declare const mapEpochMillis: {
2417
2724
  * DateTime.mapEpochMillis((millis) => millis + 10)
2418
2725
  * )
2419
2726
  * ```
2727
+ *
2728
+ * @category mapping
2729
+ * @since 3.6.0
2420
2730
  */
2421
2731
  (f: (millis: number) => number): <A extends DateTime>(self: A) => A;
2422
2732
  /**
2423
2733
  * Transform a `DateTime` by applying a function to the number of milliseconds
2424
2734
  * since the Unix epoch.
2425
2735
  *
2426
- * @since 3.6.0
2427
- * @category mapping
2428
- * @example
2736
+ * **Example** (Mapping epoch milliseconds)
2737
+ *
2429
2738
  * ```ts
2430
2739
  * import { DateTime } from "effect"
2431
2740
  *
@@ -2434,16 +2743,21 @@ export declare const mapEpochMillis: {
2434
2743
  * DateTime.mapEpochMillis((millis) => millis + 10)
2435
2744
  * )
2436
2745
  * ```
2746
+ *
2747
+ * @category mapping
2748
+ * @since 3.6.0
2437
2749
  */
2438
2750
  <A extends DateTime>(self: A, f: (millis: number) => number): A;
2439
2751
  };
2440
2752
  /**
2441
- * Using the time zone adjusted `Date`, apply a function to the `Date` and
2442
- * return the result.
2753
+ * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
2754
+ * instant and returns the function's result.
2755
+ *
2756
+ * This ignores any associated time zone. Use `DateTime.withDate` when the
2757
+ * callback should receive the time-zone-adjusted wall-clock date.
2758
+ *
2759
+ * **Example** (Using time zone adjusted Dates)
2443
2760
  *
2444
- * @since 3.6.0
2445
- * @category mapping
2446
- * @example
2447
2761
  * ```ts
2448
2762
  * import { DateTime } from "effect"
2449
2763
  *
@@ -2452,15 +2766,20 @@ export declare const mapEpochMillis: {
2452
2766
  * DateTime.withDate((date) => date.getTime())
2453
2767
  * )
2454
2768
  * ```
2769
+ *
2770
+ * @category mapping
2771
+ * @since 3.6.0
2455
2772
  */
2456
2773
  export declare const withDate: {
2457
2774
  /**
2458
- * Using the time zone adjusted `Date`, apply a function to the `Date` and
2459
- * return the result.
2775
+ * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
2776
+ * instant and returns the function's result.
2777
+ *
2778
+ * This ignores any associated time zone. Use `DateTime.withDate` when the
2779
+ * callback should receive the time-zone-adjusted wall-clock date.
2780
+ *
2781
+ * **Example** (Using time zone adjusted Dates)
2460
2782
  *
2461
- * @since 3.6.0
2462
- * @category mapping
2463
- * @example
2464
2783
  * ```ts
2465
2784
  * import { DateTime } from "effect"
2466
2785
  *
@@ -2469,15 +2788,20 @@ export declare const withDate: {
2469
2788
  * DateTime.withDate((date) => date.getTime())
2470
2789
  * )
2471
2790
  * ```
2791
+ *
2792
+ * @category mapping
2793
+ * @since 3.6.0
2472
2794
  */
2473
2795
  <A>(f: (date: Date) => A): (self: DateTime) => A;
2474
2796
  /**
2475
- * Using the time zone adjusted `Date`, apply a function to the `Date` and
2476
- * return the result.
2797
+ * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
2798
+ * instant and returns the function's result.
2799
+ *
2800
+ * This ignores any associated time zone. Use `DateTime.withDate` when the
2801
+ * callback should receive the time-zone-adjusted wall-clock date.
2802
+ *
2803
+ * **Example** (Using time zone adjusted Dates)
2477
2804
  *
2478
- * @since 3.6.0
2479
- * @category mapping
2480
- * @example
2481
2805
  * ```ts
2482
2806
  * import { DateTime } from "effect"
2483
2807
  *
@@ -2486,16 +2810,21 @@ export declare const withDate: {
2486
2810
  * DateTime.withDate((date) => date.getTime())
2487
2811
  * )
2488
2812
  * ```
2813
+ *
2814
+ * @category mapping
2815
+ * @since 3.6.0
2489
2816
  */
2490
2817
  <A>(self: DateTime, f: (date: Date) => A): A;
2491
2818
  };
2492
2819
  /**
2493
- * Using the time zone adjusted `Date`, apply a function to the `Date` and
2494
- * return the result.
2820
+ * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
2821
+ * instant and returns the function's result.
2822
+ *
2823
+ * This ignores any associated time zone. Use `DateTime.withDate` when the
2824
+ * callback should receive the time-zone-adjusted wall-clock date.
2825
+ *
2826
+ * **Example** (Using UTC Dates)
2495
2827
  *
2496
- * @since 3.6.0
2497
- * @category mapping
2498
- * @example
2499
2828
  * ```ts
2500
2829
  * import { DateTime } from "effect"
2501
2830
  *
@@ -2504,15 +2833,20 @@ export declare const withDate: {
2504
2833
  * DateTime.withDateUtc((date) => date.getTime())
2505
2834
  * )
2506
2835
  * ```
2836
+ *
2837
+ * @category mapping
2838
+ * @since 3.6.0
2507
2839
  */
2508
2840
  export declare const withDateUtc: {
2509
2841
  /**
2510
- * Using the time zone adjusted `Date`, apply a function to the `Date` and
2511
- * return the result.
2842
+ * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
2843
+ * instant and returns the function's result.
2844
+ *
2845
+ * This ignores any associated time zone. Use `DateTime.withDate` when the
2846
+ * callback should receive the time-zone-adjusted wall-clock date.
2847
+ *
2848
+ * **Example** (Using UTC Dates)
2512
2849
  *
2513
- * @since 3.6.0
2514
- * @category mapping
2515
- * @example
2516
2850
  * ```ts
2517
2851
  * import { DateTime } from "effect"
2518
2852
  *
@@ -2521,15 +2855,20 @@ export declare const withDateUtc: {
2521
2855
  * DateTime.withDateUtc((date) => date.getTime())
2522
2856
  * )
2523
2857
  * ```
2858
+ *
2859
+ * @category mapping
2860
+ * @since 3.6.0
2524
2861
  */
2525
2862
  <A>(f: (date: Date) => A): (self: DateTime) => A;
2526
2863
  /**
2527
- * Using the time zone adjusted `Date`, apply a function to the `Date` and
2528
- * return the result.
2864
+ * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
2865
+ * instant and returns the function's result.
2866
+ *
2867
+ * This ignores any associated time zone. Use `DateTime.withDate` when the
2868
+ * callback should receive the time-zone-adjusted wall-clock date.
2869
+ *
2870
+ * **Example** (Using UTC Dates)
2529
2871
  *
2530
- * @since 3.6.0
2531
- * @category mapping
2532
- * @example
2533
2872
  * ```ts
2534
2873
  * import { DateTime } from "effect"
2535
2874
  *
@@ -2538,18 +2877,24 @@ export declare const withDateUtc: {
2538
2877
  * DateTime.withDateUtc((date) => date.getTime())
2539
2878
  * )
2540
2879
  * ```
2880
+ *
2881
+ * @category mapping
2882
+ * @since 3.6.0
2541
2883
  */
2542
2884
  <A>(self: DateTime, f: (date: Date) => A): A;
2543
2885
  };
2544
2886
  /**
2545
2887
  * Pattern match on a `DateTime` to handle `Utc` and `Zoned` cases differently.
2546
2888
  *
2547
- * @example
2889
+ * **Example** (Pattern matching DateTime variants)
2890
+ *
2548
2891
  * ```ts
2549
2892
  * import { DateTime } from "effect"
2550
2893
  *
2551
- * const dt1 = DateTime.nowUnsafe() // Utc
2552
- * const dt2 = DateTime.makeZonedUnsafe(new Date(), { timeZone: "Europe/London" }) // Zoned
2894
+ * const dt1 = DateTime.makeUnsafe("2024-01-01T12:00:00Z") // Utc
2895
+ * const dt2 = DateTime.makeZonedUnsafe("2024-06-15T14:30:00Z", {
2896
+ * timeZone: "Europe/London"
2897
+ * }) // Zoned
2553
2898
  *
2554
2899
  * const result1 = DateTime.match(dt1, {
2555
2900
  * onUtc: (utc) => `UTC: ${DateTime.formatIso(utc)}`,
@@ -2560,6 +2905,9 @@ export declare const withDateUtc: {
2560
2905
  * onUtc: (utc) => `UTC: ${DateTime.formatIso(utc)}`,
2561
2906
  * onZoned: (zoned) => `Zoned: ${DateTime.formatIsoZoned(zoned)}`
2562
2907
  * })
2908
+ *
2909
+ * console.log(result1) // "UTC: 2024-01-01T12:00:00.000Z"
2910
+ * console.log(result2) // "Zoned: 2024-06-15T15:30:00.000+01:00[Europe/London]"
2563
2911
  * ```
2564
2912
  *
2565
2913
  * @category mapping
@@ -2569,12 +2917,15 @@ export declare const match: {
2569
2917
  /**
2570
2918
  * Pattern match on a `DateTime` to handle `Utc` and `Zoned` cases differently.
2571
2919
  *
2572
- * @example
2920
+ * **Example** (Pattern matching DateTime variants)
2921
+ *
2573
2922
  * ```ts
2574
2923
  * import { DateTime } from "effect"
2575
2924
  *
2576
- * const dt1 = DateTime.nowUnsafe() // Utc
2577
- * const dt2 = DateTime.makeZonedUnsafe(new Date(), { timeZone: "Europe/London" }) // Zoned
2925
+ * const dt1 = DateTime.makeUnsafe("2024-01-01T12:00:00Z") // Utc
2926
+ * const dt2 = DateTime.makeZonedUnsafe("2024-06-15T14:30:00Z", {
2927
+ * timeZone: "Europe/London"
2928
+ * }) // Zoned
2578
2929
  *
2579
2930
  * const result1 = DateTime.match(dt1, {
2580
2931
  * onUtc: (utc) => `UTC: ${DateTime.formatIso(utc)}`,
@@ -2585,6 +2936,9 @@ export declare const match: {
2585
2936
  * onUtc: (utc) => `UTC: ${DateTime.formatIso(utc)}`,
2586
2937
  * onZoned: (zoned) => `Zoned: ${DateTime.formatIsoZoned(zoned)}`
2587
2938
  * })
2939
+ *
2940
+ * console.log(result1) // "UTC: 2024-01-01T12:00:00.000Z"
2941
+ * console.log(result2) // "Zoned: 2024-06-15T15:30:00.000+01:00[Europe/London]"
2588
2942
  * ```
2589
2943
  *
2590
2944
  * @category mapping
@@ -2597,12 +2951,15 @@ export declare const match: {
2597
2951
  /**
2598
2952
  * Pattern match on a `DateTime` to handle `Utc` and `Zoned` cases differently.
2599
2953
  *
2600
- * @example
2954
+ * **Example** (Pattern matching DateTime variants)
2955
+ *
2601
2956
  * ```ts
2602
2957
  * import { DateTime } from "effect"
2603
2958
  *
2604
- * const dt1 = DateTime.nowUnsafe() // Utc
2605
- * const dt2 = DateTime.makeZonedUnsafe(new Date(), { timeZone: "Europe/London" }) // Zoned
2959
+ * const dt1 = DateTime.makeUnsafe("2024-01-01T12:00:00Z") // Utc
2960
+ * const dt2 = DateTime.makeZonedUnsafe("2024-06-15T14:30:00Z", {
2961
+ * timeZone: "Europe/London"
2962
+ * }) // Zoned
2606
2963
  *
2607
2964
  * const result1 = DateTime.match(dt1, {
2608
2965
  * onUtc: (utc) => `UTC: ${DateTime.formatIso(utc)}`,
@@ -2613,6 +2970,9 @@ export declare const match: {
2613
2970
  * onUtc: (utc) => `UTC: ${DateTime.formatIso(utc)}`,
2614
2971
  * onZoned: (zoned) => `Zoned: ${DateTime.formatIsoZoned(zoned)}`
2615
2972
  * })
2973
+ *
2974
+ * console.log(result1) // "UTC: 2024-01-01T12:00:00.000Z"
2975
+ * console.log(result2) // "Zoned: 2024-06-15T15:30:00.000+01:00[Europe/London]"
2616
2976
  * ```
2617
2977
  *
2618
2978
  * @category mapping
@@ -2626,9 +2986,8 @@ export declare const match: {
2626
2986
  /**
2627
2987
  * Add the given `Duration` to a `DateTime`.
2628
2988
  *
2629
- * @since 3.6.0
2630
- * @category math
2631
- * @example
2989
+ * **Example** (Adding durations)
2990
+ *
2632
2991
  * ```ts
2633
2992
  * import { DateTime } from "effect"
2634
2993
  *
@@ -2637,14 +2996,16 @@ export declare const match: {
2637
2996
  * DateTime.addDuration("5 minutes")
2638
2997
  * )
2639
2998
  * ```
2999
+ *
3000
+ * @category math
3001
+ * @since 3.6.0
2640
3002
  */
2641
3003
  export declare const addDuration: {
2642
3004
  /**
2643
3005
  * Add the given `Duration` to a `DateTime`.
2644
3006
  *
2645
- * @since 3.6.0
2646
- * @category math
2647
- * @example
3007
+ * **Example** (Adding durations)
3008
+ *
2648
3009
  * ```ts
2649
3010
  * import { DateTime } from "effect"
2650
3011
  *
@@ -2653,14 +3014,16 @@ export declare const addDuration: {
2653
3014
  * DateTime.addDuration("5 minutes")
2654
3015
  * )
2655
3016
  * ```
3017
+ *
3018
+ * @category math
3019
+ * @since 3.6.0
2656
3020
  */
2657
3021
  (duration: Duration.Input): <A extends DateTime>(self: A) => A;
2658
3022
  /**
2659
3023
  * Add the given `Duration` to a `DateTime`.
2660
3024
  *
2661
- * @since 3.6.0
2662
- * @category math
2663
- * @example
3025
+ * **Example** (Adding durations)
3026
+ *
2664
3027
  * ```ts
2665
3028
  * import { DateTime } from "effect"
2666
3029
  *
@@ -2669,15 +3032,17 @@ export declare const addDuration: {
2669
3032
  * DateTime.addDuration("5 minutes")
2670
3033
  * )
2671
3034
  * ```
3035
+ *
3036
+ * @category math
3037
+ * @since 3.6.0
2672
3038
  */
2673
3039
  <A extends DateTime>(self: A, duration: Duration.Input): A;
2674
3040
  };
2675
3041
  /**
2676
3042
  * Subtract the given `Duration` from a `DateTime`.
2677
3043
  *
2678
- * @since 3.6.0
2679
- * @category math
2680
- * @example
3044
+ * **Example** (Subtracting durations)
3045
+ *
2681
3046
  * ```ts
2682
3047
  * import { DateTime } from "effect"
2683
3048
  *
@@ -2686,14 +3051,16 @@ export declare const addDuration: {
2686
3051
  * DateTime.subtractDuration("5 minutes")
2687
3052
  * )
2688
3053
  * ```
3054
+ *
3055
+ * @category math
3056
+ * @since 3.6.0
2689
3057
  */
2690
3058
  export declare const subtractDuration: {
2691
3059
  /**
2692
3060
  * Subtract the given `Duration` from a `DateTime`.
2693
3061
  *
2694
- * @since 3.6.0
2695
- * @category math
2696
- * @example
3062
+ * **Example** (Subtracting durations)
3063
+ *
2697
3064
  * ```ts
2698
3065
  * import { DateTime } from "effect"
2699
3066
  *
@@ -2702,14 +3069,16 @@ export declare const subtractDuration: {
2702
3069
  * DateTime.subtractDuration("5 minutes")
2703
3070
  * )
2704
3071
  * ```
3072
+ *
3073
+ * @category math
3074
+ * @since 3.6.0
2705
3075
  */
2706
3076
  (duration: Duration.Input): <A extends DateTime>(self: A) => A;
2707
3077
  /**
2708
3078
  * Subtract the given `Duration` from a `DateTime`.
2709
3079
  *
2710
- * @since 3.6.0
2711
- * @category math
2712
- * @example
3080
+ * **Example** (Subtracting durations)
3081
+ *
2713
3082
  * ```ts
2714
3083
  * import { DateTime } from "effect"
2715
3084
  *
@@ -2718,6 +3087,9 @@ export declare const subtractDuration: {
2718
3087
  * DateTime.subtractDuration("5 minutes")
2719
3088
  * )
2720
3089
  * ```
3090
+ *
3091
+ * @category math
3092
+ * @since 3.6.0
2721
3093
  */
2722
3094
  <A extends DateTime>(self: A, duration: Duration.Input): A;
2723
3095
  };
@@ -2727,9 +3099,8 @@ export declare const subtractDuration: {
2727
3099
  * The time zone is taken into account when adding days, weeks, months, and
2728
3100
  * years.
2729
3101
  *
2730
- * @since 3.6.0
2731
- * @category math
2732
- * @example
3102
+ * **Example** (Adding date and time parts)
3103
+ *
2733
3104
  * ```ts
2734
3105
  * import { DateTime } from "effect"
2735
3106
  *
@@ -2738,6 +3109,9 @@ export declare const subtractDuration: {
2738
3109
  * DateTime.add({ minutes: 5 })
2739
3110
  * )
2740
3111
  * ```
3112
+ *
3113
+ * @category math
3114
+ * @since 3.6.0
2741
3115
  */
2742
3116
  export declare const add: {
2743
3117
  /**
@@ -2746,9 +3120,8 @@ export declare const add: {
2746
3120
  * The time zone is taken into account when adding days, weeks, months, and
2747
3121
  * years.
2748
3122
  *
2749
- * @since 3.6.0
2750
- * @category math
2751
- * @example
3123
+ * **Example** (Adding date and time parts)
3124
+ *
2752
3125
  * ```ts
2753
3126
  * import { DateTime } from "effect"
2754
3127
  *
@@ -2757,6 +3130,9 @@ export declare const add: {
2757
3130
  * DateTime.add({ minutes: 5 })
2758
3131
  * )
2759
3132
  * ```
3133
+ *
3134
+ * @category math
3135
+ * @since 3.6.0
2760
3136
  */
2761
3137
  (parts: Partial<DateTime.PartsForMath>): <A extends DateTime>(self: A) => A;
2762
3138
  /**
@@ -2765,9 +3141,8 @@ export declare const add: {
2765
3141
  * The time zone is taken into account when adding days, weeks, months, and
2766
3142
  * years.
2767
3143
  *
2768
- * @since 3.6.0
2769
- * @category math
2770
- * @example
3144
+ * **Example** (Adding date and time parts)
3145
+ *
2771
3146
  * ```ts
2772
3147
  * import { DateTime } from "effect"
2773
3148
  *
@@ -2776,15 +3151,17 @@ export declare const add: {
2776
3151
  * DateTime.add({ minutes: 5 })
2777
3152
  * )
2778
3153
  * ```
3154
+ *
3155
+ * @category math
3156
+ * @since 3.6.0
2779
3157
  */
2780
3158
  <A extends DateTime>(self: A, parts: Partial<DateTime.PartsForMath>): A;
2781
3159
  };
2782
3160
  /**
2783
3161
  * Subtract the given `amount` of `unit`'s from a `DateTime`.
2784
3162
  *
2785
- * @since 3.6.0
2786
- * @category math
2787
- * @example
3163
+ * **Example** (Subtracting date and time parts)
3164
+ *
2788
3165
  * ```ts
2789
3166
  * import { DateTime } from "effect"
2790
3167
  *
@@ -2793,14 +3170,16 @@ export declare const add: {
2793
3170
  * DateTime.subtract({ minutes: 5 })
2794
3171
  * )
2795
3172
  * ```
3173
+ *
3174
+ * @category math
3175
+ * @since 3.6.0
2796
3176
  */
2797
3177
  export declare const subtract: {
2798
3178
  /**
2799
3179
  * Subtract the given `amount` of `unit`'s from a `DateTime`.
2800
3180
  *
2801
- * @since 3.6.0
2802
- * @category math
2803
- * @example
3181
+ * **Example** (Subtracting date and time parts)
3182
+ *
2804
3183
  * ```ts
2805
3184
  * import { DateTime } from "effect"
2806
3185
  *
@@ -2809,14 +3188,16 @@ export declare const subtract: {
2809
3188
  * DateTime.subtract({ minutes: 5 })
2810
3189
  * )
2811
3190
  * ```
3191
+ *
3192
+ * @category math
3193
+ * @since 3.6.0
2812
3194
  */
2813
3195
  (parts: Partial<DateTime.PartsForMath>): <A extends DateTime>(self: A) => A;
2814
3196
  /**
2815
3197
  * Subtract the given `amount` of `unit`'s from a `DateTime`.
2816
3198
  *
2817
- * @since 3.6.0
2818
- * @category math
2819
- * @example
3199
+ * **Example** (Subtracting date and time parts)
3200
+ *
2820
3201
  * ```ts
2821
3202
  * import { DateTime } from "effect"
2822
3203
  *
@@ -2825,6 +3206,9 @@ export declare const subtract: {
2825
3206
  * DateTime.subtract({ minutes: 5 })
2826
3207
  * )
2827
3208
  * ```
3209
+ *
3210
+ * @category math
3211
+ * @since 3.6.0
2828
3212
  */
2829
3213
  <A extends DateTime>(self: A, parts: Partial<DateTime.PartsForMath>): A;
2830
3214
  };
@@ -2834,9 +3218,8 @@ export declare const subtract: {
2834
3218
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
2835
3219
  * day of the week that the week starts on. The default is 0 (Sunday).
2836
3220
  *
2837
- * @since 3.6.0
2838
- * @category math
2839
- * @example
3221
+ * **Example** (Rounding down DateTime values)
3222
+ *
2840
3223
  * ```ts
2841
3224
  * import { DateTime } from "effect"
2842
3225
  *
@@ -2846,6 +3229,9 @@ export declare const subtract: {
2846
3229
  * DateTime.formatIso
2847
3230
  * )
2848
3231
  * ```
3232
+ *
3233
+ * @category math
3234
+ * @since 3.6.0
2849
3235
  */
2850
3236
  export declare const startOf: {
2851
3237
  /**
@@ -2854,9 +3240,8 @@ export declare const startOf: {
2854
3240
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
2855
3241
  * day of the week that the week starts on. The default is 0 (Sunday).
2856
3242
  *
2857
- * @since 3.6.0
2858
- * @category math
2859
- * @example
3243
+ * **Example** (Rounding down DateTime values)
3244
+ *
2860
3245
  * ```ts
2861
3246
  * import { DateTime } from "effect"
2862
3247
  *
@@ -2866,6 +3251,9 @@ export declare const startOf: {
2866
3251
  * DateTime.formatIso
2867
3252
  * )
2868
3253
  * ```
3254
+ *
3255
+ * @category math
3256
+ * @since 3.6.0
2869
3257
  */
2870
3258
  (part: DateTime.UnitSingular, options?: {
2871
3259
  readonly weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | undefined;
@@ -2876,9 +3264,8 @@ export declare const startOf: {
2876
3264
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
2877
3265
  * day of the week that the week starts on. The default is 0 (Sunday).
2878
3266
  *
2879
- * @since 3.6.0
2880
- * @category math
2881
- * @example
3267
+ * **Example** (Rounding down DateTime values)
3268
+ *
2882
3269
  * ```ts
2883
3270
  * import { DateTime } from "effect"
2884
3271
  *
@@ -2888,6 +3275,9 @@ export declare const startOf: {
2888
3275
  * DateTime.formatIso
2889
3276
  * )
2890
3277
  * ```
3278
+ *
3279
+ * @category math
3280
+ * @since 3.6.0
2891
3281
  */
2892
3282
  <A extends DateTime>(self: A, part: DateTime.UnitSingular, options?: {
2893
3283
  readonly weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | undefined;
@@ -2899,9 +3289,8 @@ export declare const startOf: {
2899
3289
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
2900
3290
  * day of the week that the week starts on. The default is 0 (Sunday).
2901
3291
  *
2902
- * @since 3.6.0
2903
- * @category math
2904
- * @example
3292
+ * **Example** (Rounding up DateTime values)
3293
+ *
2905
3294
  * ```ts
2906
3295
  * import { DateTime } from "effect"
2907
3296
  *
@@ -2911,6 +3300,9 @@ export declare const startOf: {
2911
3300
  * DateTime.formatIso
2912
3301
  * )
2913
3302
  * ```
3303
+ *
3304
+ * @category math
3305
+ * @since 3.6.0
2914
3306
  */
2915
3307
  export declare const endOf: {
2916
3308
  /**
@@ -2919,9 +3311,8 @@ export declare const endOf: {
2919
3311
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
2920
3312
  * day of the week that the week starts on. The default is 0 (Sunday).
2921
3313
  *
2922
- * @since 3.6.0
2923
- * @category math
2924
- * @example
3314
+ * **Example** (Rounding up DateTime values)
3315
+ *
2925
3316
  * ```ts
2926
3317
  * import { DateTime } from "effect"
2927
3318
  *
@@ -2931,6 +3322,9 @@ export declare const endOf: {
2931
3322
  * DateTime.formatIso
2932
3323
  * )
2933
3324
  * ```
3325
+ *
3326
+ * @category math
3327
+ * @since 3.6.0
2934
3328
  */
2935
3329
  (part: DateTime.UnitSingular, options?: {
2936
3330
  readonly weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | undefined;
@@ -2941,9 +3335,8 @@ export declare const endOf: {
2941
3335
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
2942
3336
  * day of the week that the week starts on. The default is 0 (Sunday).
2943
3337
  *
2944
- * @since 3.6.0
2945
- * @category math
2946
- * @example
3338
+ * **Example** (Rounding up DateTime values)
3339
+ *
2947
3340
  * ```ts
2948
3341
  * import { DateTime } from "effect"
2949
3342
  *
@@ -2953,6 +3346,9 @@ export declare const endOf: {
2953
3346
  * DateTime.formatIso
2954
3347
  * )
2955
3348
  * ```
3349
+ *
3350
+ * @category math
3351
+ * @since 3.6.0
2956
3352
  */
2957
3353
  <A extends DateTime>(self: A, part: DateTime.UnitSingular, options?: {
2958
3354
  readonly weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | undefined;
@@ -2964,9 +3360,8 @@ export declare const endOf: {
2964
3360
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
2965
3361
  * day of the week that the week starts on. The default is 0 (Sunday).
2966
3362
  *
2967
- * @since 3.6.0
2968
- * @category math
2969
- * @example
3363
+ * **Example** (Rounding DateTime values to nearest units)
3364
+ *
2970
3365
  * ```ts
2971
3366
  * import { DateTime } from "effect"
2972
3367
  *
@@ -2976,6 +3371,9 @@ export declare const endOf: {
2976
3371
  * DateTime.formatIso
2977
3372
  * )
2978
3373
  * ```
3374
+ *
3375
+ * @category math
3376
+ * @since 3.6.0
2979
3377
  */
2980
3378
  export declare const nearest: {
2981
3379
  /**
@@ -2984,9 +3382,8 @@ export declare const nearest: {
2984
3382
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
2985
3383
  * day of the week that the week starts on. The default is 0 (Sunday).
2986
3384
  *
2987
- * @since 3.6.0
2988
- * @category math
2989
- * @example
3385
+ * **Example** (Rounding DateTime values to nearest units)
3386
+ *
2990
3387
  * ```ts
2991
3388
  * import { DateTime } from "effect"
2992
3389
  *
@@ -2996,6 +3393,9 @@ export declare const nearest: {
2996
3393
  * DateTime.formatIso
2997
3394
  * )
2998
3395
  * ```
3396
+ *
3397
+ * @category math
3398
+ * @since 3.6.0
2999
3399
  */
3000
3400
  (part: DateTime.UnitSingular, options?: {
3001
3401
  readonly weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | undefined;
@@ -3006,9 +3406,8 @@ export declare const nearest: {
3006
3406
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
3007
3407
  * day of the week that the week starts on. The default is 0 (Sunday).
3008
3408
  *
3009
- * @since 3.6.0
3010
- * @category math
3011
- * @example
3409
+ * **Example** (Rounding DateTime values to nearest units)
3410
+ *
3012
3411
  * ```ts
3013
3412
  * import { DateTime } from "effect"
3014
3413
  *
@@ -3018,20 +3417,26 @@ export declare const nearest: {
3018
3417
  * DateTime.formatIso
3019
3418
  * )
3020
3419
  * ```
3420
+ *
3421
+ * @category math
3422
+ * @since 3.6.0
3021
3423
  */
3022
3424
  <A extends DateTime>(self: A, part: DateTime.UnitSingular, options?: {
3023
3425
  readonly weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | undefined;
3024
3426
  }): A;
3025
3427
  };
3026
3428
  /**
3027
- * Format a `DateTime` as a string using the `DateTimeFormat` API.
3429
+ * Formats a `DateTime` with `Intl.DateTimeFormat`.
3430
+ *
3431
+ * Unless a `timeZone` option is supplied, UTC values are formatted in UTC and
3432
+ * zoned values are formatted in their named zone or fixed-offset zone.
3028
3433
  *
3029
- * The `timeZone` option is set to the offset of the time zone.
3434
+ * Fixed-offset zones depend on runtime support for offset `timeZone`
3435
+ * identifiers. When unsupported, formatting falls back to UTC with the
3436
+ * `DateTime` adjusted to the offset.
3030
3437
  *
3031
- * Note: On Node versions < 22, fixed "Offset" zones will set the time zone to
3032
- * "UTC" and use the adjusted `Date`.
3438
+ * **Example** (Formatting DateTime values with Intl options)
3033
3439
  *
3034
- * @example
3035
3440
  * ```ts
3036
3441
  * import { DateTime } from "effect"
3037
3442
  *
@@ -3048,19 +3453,22 @@ export declare const nearest: {
3048
3453
  * console.log(formatted) // "Saturday, June 15, 2024 at 3:30 PM"
3049
3454
  * ```
3050
3455
  *
3051
- * @since 3.6.0
3052
3456
  * @category formatting
3457
+ * @since 3.6.0
3053
3458
  */
3054
3459
  export declare const format: {
3055
3460
  /**
3056
- * Format a `DateTime` as a string using the `DateTimeFormat` API.
3461
+ * Formats a `DateTime` with `Intl.DateTimeFormat`.
3462
+ *
3463
+ * Unless a `timeZone` option is supplied, UTC values are formatted in UTC and
3464
+ * zoned values are formatted in their named zone or fixed-offset zone.
3057
3465
  *
3058
- * The `timeZone` option is set to the offset of the time zone.
3466
+ * Fixed-offset zones depend on runtime support for offset `timeZone`
3467
+ * identifiers. When unsupported, formatting falls back to UTC with the
3468
+ * `DateTime` adjusted to the offset.
3059
3469
  *
3060
- * Note: On Node versions < 22, fixed "Offset" zones will set the time zone to
3061
- * "UTC" and use the adjusted `Date`.
3470
+ * **Example** (Formatting DateTime values with Intl options)
3062
3471
  *
3063
- * @example
3064
3472
  * ```ts
3065
3473
  * import { DateTime } from "effect"
3066
3474
  *
@@ -3077,21 +3485,24 @@ export declare const format: {
3077
3485
  * console.log(formatted) // "Saturday, June 15, 2024 at 3:30 PM"
3078
3486
  * ```
3079
3487
  *
3080
- * @since 3.6.0
3081
3488
  * @category formatting
3489
+ * @since 3.6.0
3082
3490
  */
3083
3491
  (options?: Intl.DateTimeFormatOptions & {
3084
3492
  readonly locale?: string | undefined;
3085
3493
  } | undefined): (self: DateTime) => string;
3086
3494
  /**
3087
- * Format a `DateTime` as a string using the `DateTimeFormat` API.
3495
+ * Formats a `DateTime` with `Intl.DateTimeFormat`.
3496
+ *
3497
+ * Unless a `timeZone` option is supplied, UTC values are formatted in UTC and
3498
+ * zoned values are formatted in their named zone or fixed-offset zone.
3088
3499
  *
3089
- * The `timeZone` option is set to the offset of the time zone.
3500
+ * Fixed-offset zones depend on runtime support for offset `timeZone`
3501
+ * identifiers. When unsupported, formatting falls back to UTC with the
3502
+ * `DateTime` adjusted to the offset.
3090
3503
  *
3091
- * Note: On Node versions < 22, fixed "Offset" zones will set the time zone to
3092
- * "UTC" and use the adjusted `Date`.
3504
+ * **Example** (Formatting DateTime values with Intl options)
3093
3505
  *
3094
- * @example
3095
3506
  * ```ts
3096
3507
  * import { DateTime } from "effect"
3097
3508
  *
@@ -3108,8 +3519,8 @@ export declare const format: {
3108
3519
  * console.log(formatted) // "Saturday, June 15, 2024 at 3:30 PM"
3109
3520
  * ```
3110
3521
  *
3111
- * @since 3.6.0
3112
3522
  * @category formatting
3523
+ * @since 3.6.0
3113
3524
  */
3114
3525
  (self: DateTime, options?: Intl.DateTimeFormatOptions & {
3115
3526
  readonly locale?: string | undefined;
@@ -3120,7 +3531,8 @@ export declare const format: {
3120
3531
  *
3121
3532
  * It will use the system's local time zone & locale.
3122
3533
  *
3123
- * @example
3534
+ * **Example** (Formatting DateTime values locally)
3535
+ *
3124
3536
  * ```ts
3125
3537
  * import { DateTime } from "effect"
3126
3538
  *
@@ -3138,8 +3550,8 @@ export declare const format: {
3138
3550
  * console.log(local) // Output depends on system locale/timezone
3139
3551
  * ```
3140
3552
  *
3141
- * @since 3.6.0
3142
3553
  * @category formatting
3554
+ * @since 3.6.0
3143
3555
  */
3144
3556
  export declare const formatLocal: {
3145
3557
  /**
@@ -3147,7 +3559,8 @@ export declare const formatLocal: {
3147
3559
  *
3148
3560
  * It will use the system's local time zone & locale.
3149
3561
  *
3150
- * @example
3562
+ * **Example** (Formatting DateTime values locally)
3563
+ *
3151
3564
  * ```ts
3152
3565
  * import { DateTime } from "effect"
3153
3566
  *
@@ -3165,8 +3578,8 @@ export declare const formatLocal: {
3165
3578
  * console.log(local) // Output depends on system locale/timezone
3166
3579
  * ```
3167
3580
  *
3168
- * @since 3.6.0
3169
3581
  * @category formatting
3582
+ * @since 3.6.0
3170
3583
  */
3171
3584
  (options?: Intl.DateTimeFormatOptions & {
3172
3585
  readonly locale?: string | undefined;
@@ -3176,7 +3589,8 @@ export declare const formatLocal: {
3176
3589
  *
3177
3590
  * It will use the system's local time zone & locale.
3178
3591
  *
3179
- * @example
3592
+ * **Example** (Formatting DateTime values locally)
3593
+ *
3180
3594
  * ```ts
3181
3595
  * import { DateTime } from "effect"
3182
3596
  *
@@ -3194,8 +3608,8 @@ export declare const formatLocal: {
3194
3608
  * console.log(local) // Output depends on system locale/timezone
3195
3609
  * ```
3196
3610
  *
3197
- * @since 3.6.0
3198
3611
  * @category formatting
3612
+ * @since 3.6.0
3199
3613
  */
3200
3614
  (self: DateTime, options?: Intl.DateTimeFormatOptions & {
3201
3615
  readonly locale?: string | undefined;
@@ -3206,7 +3620,8 @@ export declare const formatLocal: {
3206
3620
  *
3207
3621
  * This forces the time zone to be UTC.
3208
3622
  *
3209
- * @example
3623
+ * **Example** (Formatting DateTime values in UTC)
3624
+ *
3210
3625
  * ```ts
3211
3626
  * import { DateTime } from "effect"
3212
3627
  *
@@ -3227,8 +3642,8 @@ export declare const formatLocal: {
3227
3642
  * console.log(utcFormatted) // "06/15/2024, 02:30 PM UTC"
3228
3643
  * ```
3229
3644
  *
3230
- * @since 3.6.0
3231
3645
  * @category formatting
3646
+ * @since 3.6.0
3232
3647
  */
3233
3648
  export declare const formatUtc: {
3234
3649
  /**
@@ -3236,7 +3651,8 @@ export declare const formatUtc: {
3236
3651
  *
3237
3652
  * This forces the time zone to be UTC.
3238
3653
  *
3239
- * @example
3654
+ * **Example** (Formatting DateTime values in UTC)
3655
+ *
3240
3656
  * ```ts
3241
3657
  * import { DateTime } from "effect"
3242
3658
  *
@@ -3257,8 +3673,8 @@ export declare const formatUtc: {
3257
3673
  * console.log(utcFormatted) // "06/15/2024, 02:30 PM UTC"
3258
3674
  * ```
3259
3675
  *
3260
- * @since 3.6.0
3261
3676
  * @category formatting
3677
+ * @since 3.6.0
3262
3678
  */
3263
3679
  (options?: Intl.DateTimeFormatOptions & {
3264
3680
  readonly locale?: string | undefined;
@@ -3268,7 +3684,8 @@ export declare const formatUtc: {
3268
3684
  *
3269
3685
  * This forces the time zone to be UTC.
3270
3686
  *
3271
- * @example
3687
+ * **Example** (Formatting DateTime values in UTC)
3688
+ *
3272
3689
  * ```ts
3273
3690
  * import { DateTime } from "effect"
3274
3691
  *
@@ -3289,8 +3706,8 @@ export declare const formatUtc: {
3289
3706
  * console.log(utcFormatted) // "06/15/2024, 02:30 PM UTC"
3290
3707
  * ```
3291
3708
  *
3292
- * @since 3.6.0
3293
3709
  * @category formatting
3710
+ * @since 3.6.0
3294
3711
  */
3295
3712
  (self: DateTime, options?: Intl.DateTimeFormatOptions & {
3296
3713
  readonly locale?: string | undefined;
@@ -3299,7 +3716,8 @@ export declare const formatUtc: {
3299
3716
  /**
3300
3717
  * Format a `DateTime` as a string using the `DateTimeFormat` API.
3301
3718
  *
3302
- * @example
3719
+ * **Example** (Formatting DateTime values with custom formatters)
3720
+ *
3303
3721
  * ```ts
3304
3722
  * import { DateTime } from "effect"
3305
3723
  *
@@ -3319,14 +3737,15 @@ export declare const formatUtc: {
3319
3737
  * console.log(formatted) // "15. Juni 2024, 16:30"
3320
3738
  * ```
3321
3739
  *
3322
- * @since 3.6.0
3323
3740
  * @category formatting
3741
+ * @since 3.6.0
3324
3742
  */
3325
3743
  export declare const formatIntl: {
3326
3744
  /**
3327
3745
  * Format a `DateTime` as a string using the `DateTimeFormat` API.
3328
3746
  *
3329
- * @example
3747
+ * **Example** (Formatting DateTime values with custom formatters)
3748
+ *
3330
3749
  * ```ts
3331
3750
  * import { DateTime } from "effect"
3332
3751
  *
@@ -3346,14 +3765,15 @@ export declare const formatIntl: {
3346
3765
  * console.log(formatted) // "15. Juni 2024, 16:30"
3347
3766
  * ```
3348
3767
  *
3349
- * @since 3.6.0
3350
3768
  * @category formatting
3769
+ * @since 3.6.0
3351
3770
  */
3352
3771
  (format: Intl.DateTimeFormat): (self: DateTime) => string;
3353
3772
  /**
3354
3773
  * Format a `DateTime` as a string using the `DateTimeFormat` API.
3355
3774
  *
3356
- * @example
3775
+ * **Example** (Formatting DateTime values with custom formatters)
3776
+ *
3357
3777
  * ```ts
3358
3778
  * import { DateTime } from "effect"
3359
3779
  *
@@ -3373,8 +3793,8 @@ export declare const formatIntl: {
3373
3793
  * console.log(formatted) // "15. Juni 2024, 16:30"
3374
3794
  * ```
3375
3795
  *
3376
- * @since 3.6.0
3377
3796
  * @category formatting
3797
+ * @since 3.6.0
3378
3798
  */
3379
3799
  (self: DateTime, format: Intl.DateTimeFormat): string;
3380
3800
  };
@@ -3383,7 +3803,8 @@ export declare const formatIntl: {
3383
3803
  *
3384
3804
  * Always returns the UTC representation in ISO 8601 format, ignoring any time zone.
3385
3805
  *
3386
- * @example
3806
+ * **Example** (Formatting DateTime values as ISO strings)
3807
+ *
3387
3808
  * ```ts
3388
3809
  * import { DateTime } from "effect"
3389
3810
  *
@@ -3405,7 +3826,8 @@ export declare const formatIso: (self: DateTime) => string;
3405
3826
  *
3406
3827
  * Returns only the date part (YYYY-MM-DD) after applying time zone adjustments.
3407
3828
  *
3408
- * @example
3829
+ * **Example** (Formatting DateTime values as ISO dates)
3830
+ *
3409
3831
  * ```ts
3410
3832
  * import { DateTime } from "effect"
3411
3833
  *
@@ -3427,7 +3849,8 @@ export declare const formatIsoDate: (self: DateTime) => string;
3427
3849
  *
3428
3850
  * Returns only the date part (YYYY-MM-DD) in UTC, ignoring any time zone.
3429
3851
  *
3430
- * @example
3852
+ * **Example** (Formatting DateTime values as UTC ISO dates)
3853
+ *
3431
3854
  * ```ts
3432
3855
  * import { DateTime } from "effect"
3433
3856
  *
@@ -3450,7 +3873,8 @@ export declare const formatIsoDateUtc: (self: DateTime) => string;
3450
3873
  * For `DateTime.Utc`, returns the same as `formatIso`. For `DateTime.Zoned`,
3451
3874
  * includes the time zone offset in the format.
3452
3875
  *
3453
- * @example
3876
+ * **Example** (Formatting DateTime values with offsets)
3877
+ *
3454
3878
  * ```ts
3455
3879
  * import { DateTime } from "effect"
3456
3880
  *
@@ -3472,7 +3896,8 @@ export declare const formatIsoOffset: (self: DateTime) => string;
3472
3896
  *
3473
3897
  * It uses the format: `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]`.
3474
3898
  *
3475
- * @example
3899
+ * **Example** (Formatting zoned DateTime values)
3900
+ *
3476
3901
  * ```ts
3477
3902
  * import { DateTime } from "effect"
3478
3903
  *
@@ -3491,8 +3916,8 @@ export declare const formatIsoOffset: (self: DateTime) => string;
3491
3916
  * console.log(offsetFormatted) // "2024-06-15T17:30:45.123+03:00"
3492
3917
  * ```
3493
3918
  *
3494
- * @since 3.6.0
3495
3919
  * @category formatting
3920
+ * @since 3.6.0
3496
3921
  */
3497
3922
  export declare const formatIsoZoned: (self: Zoned) => string;
3498
3923
  /**
@@ -3500,7 +3925,8 @@ export declare const formatIsoZoned: (self: Zoned) => string;
3500
3925
  *
3501
3926
  * This layer provides the `CurrentTimeZone` service with the specified time zone.
3502
3927
  *
3503
- * @example
3928
+ * **Example** (Providing current time zone layers)
3929
+ *
3504
3930
  * ```ts
3505
3931
  * import { DateTime, Effect } from "effect"
3506
3932
  *
@@ -3525,7 +3951,8 @@ export declare const layerCurrentZone: (resource: NoInfer<TimeZone>) => Layer.La
3525
3951
  *
3526
3952
  * This layer provides the `CurrentTimeZone` service with a fixed offset time zone.
3527
3953
  *
3528
- * @example
3954
+ * **Example** (Providing fixed-offset time zone layers)
3955
+ *
3529
3956
  * ```ts
3530
3957
  * import { DateTime, Effect } from "effect"
3531
3958
  *
@@ -3550,7 +3977,8 @@ export declare const layerCurrentZoneOffset: (offset: number) => Layer.Layer<Cur
3550
3977
  * This layer provides the `CurrentTimeZone` service with a named time zone.
3551
3978
  * If the time zone identifier is invalid, the layer will fail.
3552
3979
  *
3553
- * @example
3980
+ * **Example** (Providing named time zone layers)
3981
+ *
3554
3982
  * ```ts
3555
3983
  * import { DateTime, Effect } from "effect"
3556
3984
  *
@@ -3574,7 +4002,8 @@ export declare const layerCurrentZoneNamed: (zoneId: string) => Layer.Layer<Curr
3574
4002
  * This layer provides the `CurrentTimeZone` service using the system's
3575
4003
  * configured local time zone.
3576
4004
  *
3577
- * @example
4005
+ * **Example** (Providing local time zone layers)
4006
+ *
3578
4007
  * ```ts
3579
4008
  * import { DateTime, Effect } from "effect"
3580
4009
  *