effect 4.0.0-beta.65 → 4.0.0-beta.67

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 (1657) hide show
  1. package/dist/Array.d.ts +113 -67
  2. package/dist/Array.d.ts.map +1 -1
  3. package/dist/Array.js +28 -18
  4. package/dist/Array.js.map +1 -1
  5. package/dist/BigDecimal.d.ts +404 -337
  6. package/dist/BigDecimal.d.ts.map +1 -1
  7. package/dist/BigDecimal.js +190 -146
  8. package/dist/BigDecimal.js.map +1 -1
  9. package/dist/BigInt.d.ts +167 -97
  10. package/dist/BigInt.d.ts.map +1 -1
  11. package/dist/BigInt.js +87 -47
  12. package/dist/BigInt.js.map +1 -1
  13. package/dist/Boolean.d.ts +62 -31
  14. package/dist/Boolean.d.ts.map +1 -1
  15. package/dist/Boolean.js +30 -15
  16. package/dist/Boolean.js.map +1 -1
  17. package/dist/Brand.d.ts +20 -1
  18. package/dist/Brand.d.ts.map +1 -1
  19. package/dist/Brand.js +16 -0
  20. package/dist/Brand.js.map +1 -1
  21. package/dist/Cache.d.ts +236 -132
  22. package/dist/Cache.d.ts.map +1 -1
  23. package/dist/Cache.js +133 -57
  24. package/dist/Cache.js.map +1 -1
  25. package/dist/Cause.d.ts +77 -65
  26. package/dist/Cause.d.ts.map +1 -1
  27. package/dist/Cause.js +43 -36
  28. package/dist/Cause.js.map +1 -1
  29. package/dist/Channel.d.ts +1518 -575
  30. package/dist/Channel.d.ts.map +1 -1
  31. package/dist/Channel.js +661 -287
  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 +548 -379
  38. package/dist/Chunk.d.ts.map +1 -1
  39. package/dist/Chunk.js +238 -170
  40. package/dist/Chunk.js.map +1 -1
  41. package/dist/Clock.d.ts +15 -8
  42. package/dist/Clock.d.ts.map +1 -1
  43. package/dist/Clock.js +8 -4
  44. package/dist/Clock.js.map +1 -1
  45. package/dist/Combiner.d.ts +2 -4
  46. package/dist/Combiner.d.ts.map +1 -1
  47. package/dist/Combiner.js +2 -4
  48. package/dist/Combiner.js.map +1 -1
  49. package/dist/Config.d.ts +5 -4
  50. package/dist/Config.d.ts.map +1 -1
  51. package/dist/Config.js +9 -8
  52. package/dist/Config.js.map +1 -1
  53. package/dist/ConfigProvider.d.ts +1 -1
  54. package/dist/ConfigProvider.js +1 -1
  55. package/dist/Console.d.ts +76 -50
  56. package/dist/Console.d.ts.map +1 -1
  57. package/dist/Console.js +69 -46
  58. package/dist/Console.js.map +1 -1
  59. package/dist/Context.d.ts +386 -138
  60. package/dist/Context.d.ts.map +1 -1
  61. package/dist/Context.js +144 -62
  62. package/dist/Context.js.map +1 -1
  63. package/dist/Cron.d.ts +69 -48
  64. package/dist/Cron.d.ts.map +1 -1
  65. package/dist/Cron.js +96 -36
  66. package/dist/Cron.js.map +1 -1
  67. package/dist/Data.d.ts +3 -2
  68. package/dist/Data.d.ts.map +1 -1
  69. package/dist/Data.js.map +1 -1
  70. package/dist/DateTime.d.ts +875 -444
  71. package/dist/DateTime.d.ts.map +1 -1
  72. package/dist/DateTime.js +376 -217
  73. package/dist/DateTime.js.map +1 -1
  74. package/dist/Deferred.d.ts +367 -174
  75. package/dist/Deferred.d.ts.map +1 -1
  76. package/dist/Deferred.js +145 -71
  77. package/dist/Deferred.js.map +1 -1
  78. package/dist/Differ.d.ts +42 -0
  79. package/dist/Differ.d.ts.map +1 -1
  80. package/dist/Differ.js +36 -0
  81. package/dist/Duration.d.ts +329 -185
  82. package/dist/Duration.d.ts.map +1 -1
  83. package/dist/Duration.js +174 -106
  84. package/dist/Duration.js.map +1 -1
  85. package/dist/Effect.d.ts +2445 -2356
  86. package/dist/Effect.d.ts.map +1 -1
  87. package/dist/Effect.js +906 -758
  88. package/dist/Effect.js.map +1 -1
  89. package/dist/Effectable.d.ts +38 -3
  90. package/dist/Effectable.d.ts.map +1 -1
  91. package/dist/Effectable.js +3 -3
  92. package/dist/Effectable.js.map +1 -1
  93. package/dist/Encoding.d.ts +78 -28
  94. package/dist/Encoding.d.ts.map +1 -1
  95. package/dist/Encoding.js +75 -27
  96. package/dist/Encoding.js.map +1 -1
  97. package/dist/Equivalence.d.ts +14 -19
  98. package/dist/Equivalence.d.ts.map +1 -1
  99. package/dist/Equivalence.js +14 -19
  100. package/dist/Equivalence.js.map +1 -1
  101. package/dist/ErrorReporter.d.ts +66 -82
  102. package/dist/ErrorReporter.d.ts.map +1 -1
  103. package/dist/ErrorReporter.js +38 -29
  104. package/dist/ErrorReporter.js.map +1 -1
  105. package/dist/ExecutionPlan.d.ts +96 -12
  106. package/dist/ExecutionPlan.d.ts.map +1 -1
  107. package/dist/ExecutionPlan.js +21 -6
  108. package/dist/ExecutionPlan.js.map +1 -1
  109. package/dist/Exit.d.ts +7 -5
  110. package/dist/Exit.d.ts.map +1 -1
  111. package/dist/Exit.js.map +1 -1
  112. package/dist/Fiber.d.ts +72 -40
  113. package/dist/Fiber.d.ts.map +1 -1
  114. package/dist/Fiber.js +39 -21
  115. package/dist/Fiber.js.map +1 -1
  116. package/dist/FiberHandle.d.ts +119 -58
  117. package/dist/FiberHandle.d.ts.map +1 -1
  118. package/dist/FiberHandle.js +122 -40
  119. package/dist/FiberHandle.js.map +1 -1
  120. package/dist/FiberMap.d.ts +288 -160
  121. package/dist/FiberMap.d.ts.map +1 -1
  122. package/dist/FiberMap.js +176 -74
  123. package/dist/FiberMap.js.map +1 -1
  124. package/dist/FiberSet.d.ts +93 -52
  125. package/dist/FiberSet.d.ts.map +1 -1
  126. package/dist/FiberSet.js +97 -34
  127. package/dist/FiberSet.js.map +1 -1
  128. package/dist/FileSystem.d.ts +104 -73
  129. package/dist/FileSystem.d.ts.map +1 -1
  130. package/dist/FileSystem.js +53 -39
  131. package/dist/FileSystem.js.map +1 -1
  132. package/dist/Filter.d.ts +166 -88
  133. package/dist/Filter.d.ts.map +1 -1
  134. package/dist/Filter.js +68 -42
  135. package/dist/Filter.js.map +1 -1
  136. package/dist/Function.d.ts +154 -86
  137. package/dist/Function.d.ts.map +1 -1
  138. package/dist/Function.js +53 -37
  139. package/dist/Function.js.map +1 -1
  140. package/dist/Graph.d.ts +682 -365
  141. package/dist/Graph.d.ts.map +1 -1
  142. package/dist/Graph.js +308 -157
  143. package/dist/Graph.js.map +1 -1
  144. package/dist/HKT.d.ts +29 -13
  145. package/dist/HKT.d.ts.map +1 -1
  146. package/dist/Hash.d.ts +31 -18
  147. package/dist/Hash.d.ts.map +1 -1
  148. package/dist/Hash.js +25 -15
  149. package/dist/Hash.js.map +1 -1
  150. package/dist/HashMap.d.ts +444 -256
  151. package/dist/HashMap.d.ts.map +1 -1
  152. package/dist/HashMap.js +223 -105
  153. package/dist/HashMap.js.map +1 -1
  154. package/dist/HashRing.d.ts +36 -17
  155. package/dist/HashRing.d.ts.map +1 -1
  156. package/dist/HashRing.js +75 -8
  157. package/dist/HashRing.js.map +1 -1
  158. package/dist/HashSet.d.ts +194 -104
  159. package/dist/HashSet.d.ts.map +1 -1
  160. package/dist/HashSet.js +93 -38
  161. package/dist/HashSet.js.map +1 -1
  162. package/dist/Inspectable.d.ts +20 -9
  163. package/dist/Inspectable.d.ts.map +1 -1
  164. package/dist/Inspectable.js +16 -6
  165. package/dist/Inspectable.js.map +1 -1
  166. package/dist/Iterable.d.ts +309 -149
  167. package/dist/Iterable.d.ts.map +1 -1
  168. package/dist/Iterable.js +129 -65
  169. package/dist/Iterable.js.map +1 -1
  170. package/dist/JsonPatch.d.ts +4 -3
  171. package/dist/JsonPatch.d.ts.map +1 -1
  172. package/dist/JsonPatch.js +4 -3
  173. package/dist/JsonPatch.js.map +1 -1
  174. package/dist/Latch.d.ts +98 -15
  175. package/dist/Latch.d.ts.map +1 -1
  176. package/dist/Latch.js +41 -10
  177. package/dist/Latch.js.map +1 -1
  178. package/dist/Layer.d.ts +412 -309
  179. package/dist/Layer.d.ts.map +1 -1
  180. package/dist/Layer.js +262 -181
  181. package/dist/Layer.js.map +1 -1
  182. package/dist/LayerMap.d.ts +95 -21
  183. package/dist/LayerMap.d.ts.map +1 -1
  184. package/dist/LayerMap.js +58 -14
  185. package/dist/LayerMap.js.map +1 -1
  186. package/dist/LogLevel.d.ts +92 -131
  187. package/dist/LogLevel.d.ts.map +1 -1
  188. package/dist/LogLevel.js +25 -15
  189. package/dist/LogLevel.js.map +1 -1
  190. package/dist/Logger.d.ts +155 -99
  191. package/dist/Logger.d.ts.map +1 -1
  192. package/dist/Logger.js +211 -184
  193. package/dist/Logger.js.map +1 -1
  194. package/dist/ManagedRuntime.d.ts +75 -17
  195. package/dist/ManagedRuntime.d.ts.map +1 -1
  196. package/dist/ManagedRuntime.js +22 -16
  197. package/dist/ManagedRuntime.js.map +1 -1
  198. package/dist/Match.d.ts +133 -157
  199. package/dist/Match.d.ts.map +1 -1
  200. package/dist/Match.js +85 -76
  201. package/dist/Match.js.map +1 -1
  202. package/dist/Metric.d.ts +325 -284
  203. package/dist/Metric.d.ts.map +1 -1
  204. package/dist/Metric.js +217 -212
  205. package/dist/Metric.js.map +1 -1
  206. package/dist/MutableHashMap.d.ts +117 -58
  207. package/dist/MutableHashMap.d.ts.map +1 -1
  208. package/dist/MutableHashMap.js +52 -29
  209. package/dist/MutableHashMap.js.map +1 -1
  210. package/dist/MutableHashSet.d.ts +52 -30
  211. package/dist/MutableHashSet.d.ts.map +1 -1
  212. package/dist/MutableHashSet.js +94 -38
  213. package/dist/MutableHashSet.js.map +1 -1
  214. package/dist/MutableList.d.ts +92 -49
  215. package/dist/MutableList.d.ts.map +1 -1
  216. package/dist/MutableList.js +123 -71
  217. package/dist/MutableList.js.map +1 -1
  218. package/dist/MutableRef.d.ts +99 -62
  219. package/dist/MutableRef.d.ts.map +1 -1
  220. package/dist/MutableRef.js +79 -60
  221. package/dist/MutableRef.js.map +1 -1
  222. package/dist/Newtype.d.ts +3 -0
  223. package/dist/Newtype.d.ts.map +1 -1
  224. package/dist/Newtype.js.map +1 -1
  225. package/dist/NonEmptyIterable.d.ts +36 -39
  226. package/dist/NonEmptyIterable.d.ts.map +1 -1
  227. package/dist/NonEmptyIterable.js +34 -20
  228. package/dist/NonEmptyIterable.js.map +1 -1
  229. package/dist/Number.d.ts +116 -64
  230. package/dist/Number.d.ts.map +1 -1
  231. package/dist/Number.js +54 -30
  232. package/dist/Number.js.map +1 -1
  233. package/dist/Optic.d.ts +1 -2
  234. package/dist/Optic.d.ts.map +1 -1
  235. package/dist/Optic.js +0 -1
  236. package/dist/Optic.js.map +1 -1
  237. package/dist/Option.d.ts +38 -53
  238. package/dist/Option.d.ts.map +1 -1
  239. package/dist/Option.js +87 -11
  240. package/dist/Option.js.map +1 -1
  241. package/dist/Ordering.d.ts +43 -28
  242. package/dist/Ordering.d.ts.map +1 -1
  243. package/dist/Ordering.js +4 -2
  244. package/dist/Ordering.js.map +1 -1
  245. package/dist/PartitionedSemaphore.d.ts +225 -40
  246. package/dist/PartitionedSemaphore.d.ts.map +1 -1
  247. package/dist/PartitionedSemaphore.js +113 -17
  248. package/dist/PartitionedSemaphore.js.map +1 -1
  249. package/dist/Path.d.ts +77 -13
  250. package/dist/Path.d.ts.map +1 -1
  251. package/dist/Path.js +48 -4
  252. package/dist/Path.js.map +1 -1
  253. package/dist/Pipeable.d.ts +71 -15
  254. package/dist/Pipeable.d.ts.map +1 -1
  255. package/dist/Pipeable.js +59 -12
  256. package/dist/Pipeable.js.map +1 -1
  257. package/dist/PlatformError.d.ts +74 -6
  258. package/dist/PlatformError.d.ts.map +1 -1
  259. package/dist/PlatformError.js +68 -5
  260. package/dist/PlatformError.js.map +1 -1
  261. package/dist/Pool.d.ts +66 -31
  262. package/dist/Pool.d.ts.map +1 -1
  263. package/dist/Pool.js +26 -24
  264. package/dist/Pool.js.map +1 -1
  265. package/dist/Predicate.d.ts +16 -21
  266. package/dist/Predicate.d.ts.map +1 -1
  267. package/dist/Predicate.js +9 -14
  268. package/dist/Predicate.js.map +1 -1
  269. package/dist/PrimaryKey.d.ts +9 -2
  270. package/dist/PrimaryKey.d.ts.map +1 -1
  271. package/dist/PrimaryKey.js +7 -1
  272. package/dist/PrimaryKey.js.map +1 -1
  273. package/dist/PubSub.d.ts +364 -262
  274. package/dist/PubSub.d.ts.map +1 -1
  275. package/dist/PubSub.js +245 -174
  276. package/dist/PubSub.js.map +1 -1
  277. package/dist/Pull.d.ts +94 -25
  278. package/dist/Pull.d.ts.map +1 -1
  279. package/dist/Pull.js +61 -13
  280. package/dist/Pull.js.map +1 -1
  281. package/dist/Queue.d.ts +284 -150
  282. package/dist/Queue.d.ts.map +1 -1
  283. package/dist/Queue.js +216 -113
  284. package/dist/Queue.js.map +1 -1
  285. package/dist/Random.d.ts +54 -35
  286. package/dist/Random.d.ts.map +1 -1
  287. package/dist/Random.js +36 -24
  288. package/dist/Random.js.map +1 -1
  289. package/dist/RcMap.d.ts +151 -141
  290. package/dist/RcMap.d.ts.map +1 -1
  291. package/dist/RcMap.js +66 -20
  292. package/dist/RcMap.js.map +1 -1
  293. package/dist/RcRef.d.ts +69 -32
  294. package/dist/RcRef.d.ts.map +1 -1
  295. package/dist/RcRef.js +33 -16
  296. package/dist/RcRef.js.map +1 -1
  297. package/dist/Record.d.ts +273 -129
  298. package/dist/Record.d.ts.map +1 -1
  299. package/dist/Record.js +117 -57
  300. package/dist/Record.js.map +1 -1
  301. package/dist/Redactable.d.ts +3 -3
  302. package/dist/Redactable.js +2 -2
  303. package/dist/Redacted.d.ts +63 -33
  304. package/dist/Redacted.d.ts.map +1 -1
  305. package/dist/Redacted.js +30 -14
  306. package/dist/Redacted.js.map +1 -1
  307. package/dist/Ref.d.ts +81 -52
  308. package/dist/Ref.d.ts.map +1 -1
  309. package/dist/Ref.js +54 -35
  310. package/dist/Ref.js.map +1 -1
  311. package/dist/References.d.ts +73 -31
  312. package/dist/References.d.ts.map +1 -1
  313. package/dist/References.js +66 -30
  314. package/dist/References.js.map +1 -1
  315. package/dist/RegExp.d.ts +11 -5
  316. package/dist/RegExp.d.ts.map +1 -1
  317. package/dist/RegExp.js +11 -5
  318. package/dist/RegExp.js.map +1 -1
  319. package/dist/Request.d.ts +158 -34
  320. package/dist/Request.d.ts.map +1 -1
  321. package/dist/Request.js +67 -12
  322. package/dist/Request.js.map +1 -1
  323. package/dist/RequestResolver.d.ts +261 -116
  324. package/dist/RequestResolver.d.ts.map +1 -1
  325. package/dist/RequestResolver.js +77 -41
  326. package/dist/RequestResolver.js.map +1 -1
  327. package/dist/Resource.d.ts +13 -7
  328. package/dist/Resource.d.ts.map +1 -1
  329. package/dist/Resource.js +44 -6
  330. package/dist/Resource.js.map +1 -1
  331. package/dist/Result.d.ts +26 -16
  332. package/dist/Result.d.ts.map +1 -1
  333. package/dist/Result.js +6 -6
  334. package/dist/Result.js.map +1 -1
  335. package/dist/Runtime.d.ts +43 -18
  336. package/dist/Runtime.d.ts.map +1 -1
  337. package/dist/Runtime.js +35 -16
  338. package/dist/Runtime.js.map +1 -1
  339. package/dist/Schedule.d.ts +545 -576
  340. package/dist/Schedule.d.ts.map +1 -1
  341. package/dist/Schedule.js +261 -247
  342. package/dist/Schedule.js.map +1 -1
  343. package/dist/Scheduler.d.ts +43 -6
  344. package/dist/Scheduler.d.ts.map +1 -1
  345. package/dist/Scheduler.js +33 -4
  346. package/dist/Scheduler.js.map +1 -1
  347. package/dist/Schema.d.ts +815 -294
  348. package/dist/Schema.d.ts.map +1 -1
  349. package/dist/Schema.js +287 -193
  350. package/dist/Schema.js.map +1 -1
  351. package/dist/SchemaAST.d.ts +24 -15
  352. package/dist/SchemaAST.d.ts.map +1 -1
  353. package/dist/SchemaAST.js +13 -9
  354. package/dist/SchemaAST.js.map +1 -1
  355. package/dist/SchemaGetter.d.ts +26 -13
  356. package/dist/SchemaGetter.d.ts.map +1 -1
  357. package/dist/SchemaGetter.js +24 -11
  358. package/dist/SchemaGetter.js.map +1 -1
  359. package/dist/SchemaIssue.d.ts +1 -8
  360. package/dist/SchemaIssue.d.ts.map +1 -1
  361. package/dist/SchemaIssue.js.map +1 -1
  362. package/dist/SchemaParser.d.ts +194 -25
  363. package/dist/SchemaParser.d.ts.map +1 -1
  364. package/dist/SchemaParser.js +220 -26
  365. package/dist/SchemaParser.js.map +1 -1
  366. package/dist/SchemaRepresentation.d.ts +2 -2
  367. package/dist/SchemaTransformation.d.ts +61 -41
  368. package/dist/SchemaTransformation.d.ts.map +1 -1
  369. package/dist/SchemaTransformation.js +56 -33
  370. package/dist/SchemaTransformation.js.map +1 -1
  371. package/dist/SchemaUtils.d.ts +7 -0
  372. package/dist/SchemaUtils.d.ts.map +1 -1
  373. package/dist/SchemaUtils.js +23 -0
  374. package/dist/SchemaUtils.js.map +1 -1
  375. package/dist/Scope.d.ts +102 -43
  376. package/dist/Scope.d.ts.map +1 -1
  377. package/dist/Scope.js +57 -23
  378. package/dist/Scope.js.map +1 -1
  379. package/dist/ScopedCache.d.ts +138 -46
  380. package/dist/ScopedCache.d.ts.map +1 -1
  381. package/dist/ScopedCache.js +80 -19
  382. package/dist/ScopedCache.js.map +1 -1
  383. package/dist/ScopedRef.d.ts +28 -8
  384. package/dist/ScopedRef.d.ts.map +1 -1
  385. package/dist/ScopedRef.js +25 -5
  386. package/dist/ScopedRef.js.map +1 -1
  387. package/dist/Semaphore.d.ts +64 -28
  388. package/dist/Semaphore.d.ts.map +1 -1
  389. package/dist/Semaphore.js +22 -13
  390. package/dist/Semaphore.js.map +1 -1
  391. package/dist/Sink.d.ts +458 -200
  392. package/dist/Sink.d.ts.map +1 -1
  393. package/dist/Sink.js +240 -89
  394. package/dist/Sink.js.map +1 -1
  395. package/dist/Stdio.d.ts +43 -6
  396. package/dist/Stdio.d.ts.map +1 -1
  397. package/dist/Stdio.js +33 -4
  398. package/dist/Stdio.js.map +1 -1
  399. package/dist/Stream.d.ts +1899 -1186
  400. package/dist/Stream.d.ts.map +1 -1
  401. package/dist/Stream.js +868 -525
  402. package/dist/Stream.js.map +1 -1
  403. package/dist/String.d.ts +171 -95
  404. package/dist/String.d.ts.map +1 -1
  405. package/dist/String.js +125 -67
  406. package/dist/String.js.map +1 -1
  407. package/dist/SubscriptionRef.d.ts +308 -203
  408. package/dist/SubscriptionRef.d.ts.map +1 -1
  409. package/dist/SubscriptionRef.js +125 -76
  410. package/dist/SubscriptionRef.js.map +1 -1
  411. package/dist/Symbol.d.ts +13 -5
  412. package/dist/Symbol.d.ts.map +1 -1
  413. package/dist/Symbol.js +13 -5
  414. package/dist/Symbol.js.map +1 -1
  415. package/dist/SynchronizedRef.d.ts +278 -62
  416. package/dist/SynchronizedRef.d.ts.map +1 -1
  417. package/dist/SynchronizedRef.js +116 -23
  418. package/dist/SynchronizedRef.js.map +1 -1
  419. package/dist/Take.d.ts +26 -2
  420. package/dist/Take.d.ts.map +1 -1
  421. package/dist/Take.js +4 -1
  422. package/dist/Take.js.map +1 -1
  423. package/dist/Terminal.d.ts +39 -7
  424. package/dist/Terminal.d.ts.map +1 -1
  425. package/dist/Terminal.js +10 -4
  426. package/dist/Terminal.js.map +1 -1
  427. package/dist/Tracer.d.ts +229 -55
  428. package/dist/Tracer.d.ts.map +1 -1
  429. package/dist/Tracer.js +94 -18
  430. package/dist/Tracer.js.map +1 -1
  431. package/dist/Trie.d.ts +213 -142
  432. package/dist/Trie.d.ts.map +1 -1
  433. package/dist/Trie.js +88 -60
  434. package/dist/Trie.js.map +1 -1
  435. package/dist/TxChunk.d.ts +182 -146
  436. package/dist/TxChunk.d.ts.map +1 -1
  437. package/dist/TxChunk.js +73 -56
  438. package/dist/TxChunk.js.map +1 -1
  439. package/dist/TxDeferred.d.ts +43 -29
  440. package/dist/TxDeferred.d.ts.map +1 -1
  441. package/dist/TxDeferred.js +22 -15
  442. package/dist/TxDeferred.js.map +1 -1
  443. package/dist/TxHashMap.d.ts +362 -222
  444. package/dist/TxHashMap.d.ts.map +1 -1
  445. package/dist/TxHashMap.js +171 -98
  446. package/dist/TxHashMap.js.map +1 -1
  447. package/dist/TxHashSet.d.ts +178 -104
  448. package/dist/TxHashSet.d.ts.map +1 -1
  449. package/dist/TxHashSet.js +84 -43
  450. package/dist/TxHashSet.js.map +1 -1
  451. package/dist/TxPriorityQueue.d.ts +93 -62
  452. package/dist/TxPriorityQueue.d.ts.map +1 -1
  453. package/dist/TxPriorityQueue.js +54 -36
  454. package/dist/TxPriorityQueue.js.map +1 -1
  455. package/dist/TxPubSub.d.ts +77 -49
  456. package/dist/TxPubSub.d.ts.map +1 -1
  457. package/dist/TxPubSub.js +60 -37
  458. package/dist/TxPubSub.js.map +1 -1
  459. package/dist/TxQueue.d.ts +279 -241
  460. package/dist/TxQueue.d.ts.map +1 -1
  461. package/dist/TxQueue.js +147 -101
  462. package/dist/TxQueue.js.map +1 -1
  463. package/dist/TxReentrantLock.d.ts +69 -46
  464. package/dist/TxReentrantLock.d.ts.map +1 -1
  465. package/dist/TxReentrantLock.js +48 -32
  466. package/dist/TxReentrantLock.js.map +1 -1
  467. package/dist/TxRef.d.ts +69 -40
  468. package/dist/TxRef.d.ts.map +1 -1
  469. package/dist/TxRef.js +35 -20
  470. package/dist/TxRef.js.map +1 -1
  471. package/dist/TxSemaphore.d.ts +101 -54
  472. package/dist/TxSemaphore.d.ts.map +1 -1
  473. package/dist/TxSemaphore.js +76 -34
  474. package/dist/TxSemaphore.js.map +1 -1
  475. package/dist/TxSubscriptionRef.d.ts +72 -48
  476. package/dist/TxSubscriptionRef.d.ts.map +1 -1
  477. package/dist/TxSubscriptionRef.js +33 -22
  478. package/dist/TxSubscriptionRef.js.map +1 -1
  479. package/dist/Types.d.ts +34 -34
  480. package/dist/UndefinedOr.d.ts +48 -25
  481. package/dist/UndefinedOr.d.ts.map +1 -1
  482. package/dist/UndefinedOr.js +28 -25
  483. package/dist/UndefinedOr.js.map +1 -1
  484. package/dist/Unify.d.ts +71 -116
  485. package/dist/Unify.d.ts.map +1 -1
  486. package/dist/Unify.js +20 -6
  487. package/dist/Unify.js.map +1 -1
  488. package/dist/Utils.d.ts +4 -0
  489. package/dist/Utils.d.ts.map +1 -1
  490. package/dist/Utils.js +4 -0
  491. package/dist/Utils.js.map +1 -1
  492. package/dist/index.d.ts +81 -32
  493. package/dist/index.d.ts.map +1 -1
  494. package/dist/index.js +81 -32
  495. package/dist/index.js.map +1 -1
  496. package/dist/internal/concurrency.js +2 -2
  497. package/dist/internal/concurrency.js.map +1 -1
  498. package/dist/internal/core.js +8 -20
  499. package/dist/internal/core.js.map +1 -1
  500. package/dist/internal/effect.js +20 -19
  501. package/dist/internal/effect.js.map +1 -1
  502. package/dist/internal/executionPlan.js +2 -2
  503. package/dist/internal/executionPlan.js.map +1 -1
  504. package/dist/internal/option.js +5 -8
  505. package/dist/internal/option.js.map +1 -1
  506. package/dist/internal/result.js +5 -8
  507. package/dist/internal/result.js.map +1 -1
  508. package/dist/internal/schema/schema.js +1 -1
  509. package/dist/internal/schema/schema.js.map +1 -1
  510. package/dist/testing/FastCheck.d.ts +6 -3
  511. package/dist/testing/FastCheck.d.ts.map +1 -1
  512. package/dist/testing/FastCheck.js +6 -3
  513. package/dist/testing/FastCheck.js.map +1 -1
  514. package/dist/testing/TestClock.d.ts +39 -34
  515. package/dist/testing/TestClock.d.ts.map +1 -1
  516. package/dist/testing/TestClock.js +42 -12
  517. package/dist/testing/TestClock.js.map +1 -1
  518. package/dist/testing/TestConsole.d.ts +39 -30
  519. package/dist/testing/TestConsole.d.ts.map +1 -1
  520. package/dist/testing/TestConsole.js +25 -10
  521. package/dist/testing/TestConsole.js.map +1 -1
  522. package/dist/testing/TestSchema.js +7 -7
  523. package/dist/testing/TestSchema.js.map +1 -1
  524. package/dist/unstable/ai/AiError.d.ts +197 -130
  525. package/dist/unstable/ai/AiError.d.ts.map +1 -1
  526. package/dist/unstable/ai/AiError.js +166 -102
  527. package/dist/unstable/ai/AiError.js.map +1 -1
  528. package/dist/unstable/ai/AnthropicStructuredOutput.d.ts +1 -1
  529. package/dist/unstable/ai/AnthropicStructuredOutput.js +2 -2
  530. package/dist/unstable/ai/Chat.d.ts +65 -41
  531. package/dist/unstable/ai/Chat.d.ts.map +1 -1
  532. package/dist/unstable/ai/Chat.js +51 -33
  533. package/dist/unstable/ai/Chat.js.map +1 -1
  534. package/dist/unstable/ai/EmbeddingModel.d.ts +12 -11
  535. package/dist/unstable/ai/EmbeddingModel.d.ts.map +1 -1
  536. package/dist/unstable/ai/EmbeddingModel.js +9 -8
  537. package/dist/unstable/ai/EmbeddingModel.js.map +1 -1
  538. package/dist/unstable/ai/IdGenerator.d.ts +28 -18
  539. package/dist/unstable/ai/IdGenerator.d.ts.map +1 -1
  540. package/dist/unstable/ai/IdGenerator.js +18 -11
  541. package/dist/unstable/ai/IdGenerator.js.map +1 -1
  542. package/dist/unstable/ai/LanguageModel.d.ts +36 -30
  543. package/dist/unstable/ai/LanguageModel.d.ts.map +1 -1
  544. package/dist/unstable/ai/LanguageModel.js +21 -15
  545. package/dist/unstable/ai/LanguageModel.js.map +1 -1
  546. package/dist/unstable/ai/McpSchema.d.ts +339 -119
  547. package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
  548. package/dist/unstable/ai/McpSchema.js +264 -98
  549. package/dist/unstable/ai/McpSchema.js.map +1 -1
  550. package/dist/unstable/ai/McpServer.d.ts +53 -19
  551. package/dist/unstable/ai/McpServer.d.ts.map +1 -1
  552. package/dist/unstable/ai/McpServer.js +65 -17
  553. package/dist/unstable/ai/McpServer.js.map +1 -1
  554. package/dist/unstable/ai/Model.d.ts +13 -7
  555. package/dist/unstable/ai/Model.d.ts.map +1 -1
  556. package/dist/unstable/ai/Model.js +11 -9
  557. package/dist/unstable/ai/Model.js.map +1 -1
  558. package/dist/unstable/ai/OpenAiStructuredOutput.d.ts +1 -1
  559. package/dist/unstable/ai/OpenAiStructuredOutput.js +2 -2
  560. package/dist/unstable/ai/Prompt.d.ts +194 -168
  561. package/dist/unstable/ai/Prompt.d.ts.map +1 -1
  562. package/dist/unstable/ai/Prompt.js +75 -66
  563. package/dist/unstable/ai/Prompt.js.map +1 -1
  564. package/dist/unstable/ai/Response.d.ts +153 -140
  565. package/dist/unstable/ai/Response.d.ts.map +1 -1
  566. package/dist/unstable/ai/Response.js +43 -48
  567. package/dist/unstable/ai/Response.js.map +1 -1
  568. package/dist/unstable/ai/ResponseIdTracker.d.ts +43 -4
  569. package/dist/unstable/ai/ResponseIdTracker.d.ts.map +1 -1
  570. package/dist/unstable/ai/ResponseIdTracker.js +27 -2
  571. package/dist/unstable/ai/ResponseIdTracker.js.map +1 -1
  572. package/dist/unstable/ai/Telemetry.d.ts +42 -32
  573. package/dist/unstable/ai/Telemetry.d.ts.map +1 -1
  574. package/dist/unstable/ai/Telemetry.js +14 -10
  575. package/dist/unstable/ai/Telemetry.js.map +1 -1
  576. package/dist/unstable/ai/Tokenizer.d.ts +13 -8
  577. package/dist/unstable/ai/Tokenizer.d.ts.map +1 -1
  578. package/dist/unstable/ai/Tokenizer.js +10 -6
  579. package/dist/unstable/ai/Tokenizer.js.map +1 -1
  580. package/dist/unstable/ai/Tool.d.ts +153 -84
  581. package/dist/unstable/ai/Tool.d.ts.map +1 -1
  582. package/dist/unstable/ai/Tool.js +97 -44
  583. package/dist/unstable/ai/Tool.js.map +1 -1
  584. package/dist/unstable/ai/Toolkit.d.ts +33 -42
  585. package/dist/unstable/ai/Toolkit.d.ts.map +1 -1
  586. package/dist/unstable/ai/Toolkit.js +35 -36
  587. package/dist/unstable/ai/Toolkit.js.map +1 -1
  588. package/dist/unstable/ai/index.d.ts +42 -24
  589. package/dist/unstable/ai/index.d.ts.map +1 -1
  590. package/dist/unstable/ai/index.js +42 -24
  591. package/dist/unstable/ai/index.js.map +1 -1
  592. package/dist/unstable/cli/Argument.d.ts +226 -134
  593. package/dist/unstable/cli/Argument.d.ts.map +1 -1
  594. package/dist/unstable/cli/Argument.js +101 -65
  595. package/dist/unstable/cli/Argument.js.map +1 -1
  596. package/dist/unstable/cli/CliError.d.ts +72 -26
  597. package/dist/unstable/cli/CliError.d.ts.map +1 -1
  598. package/dist/unstable/cli/CliError.js +86 -23
  599. package/dist/unstable/cli/CliError.js.map +1 -1
  600. package/dist/unstable/cli/CliOutput.d.ts +43 -13
  601. package/dist/unstable/cli/CliOutput.d.ts.map +1 -1
  602. package/dist/unstable/cli/CliOutput.js +30 -6
  603. package/dist/unstable/cli/CliOutput.js.map +1 -1
  604. package/dist/unstable/cli/Command.d.ts +218 -117
  605. package/dist/unstable/cli/Command.d.ts.map +1 -1
  606. package/dist/unstable/cli/Command.js +45 -31
  607. package/dist/unstable/cli/Command.js.map +1 -1
  608. package/dist/unstable/cli/Completions.d.ts +7 -7
  609. package/dist/unstable/cli/Completions.js +1 -1
  610. package/dist/unstable/cli/Flag.d.ts +235 -142
  611. package/dist/unstable/cli/Flag.d.ts.map +1 -1
  612. package/dist/unstable/cli/Flag.js +111 -71
  613. package/dist/unstable/cli/Flag.js.map +1 -1
  614. package/dist/unstable/cli/GlobalFlag.d.ts +42 -14
  615. package/dist/unstable/cli/GlobalFlag.d.ts.map +1 -1
  616. package/dist/unstable/cli/GlobalFlag.js +30 -7
  617. package/dist/unstable/cli/GlobalFlag.js.map +1 -1
  618. package/dist/unstable/cli/HelpDoc.d.ts +35 -10
  619. package/dist/unstable/cli/HelpDoc.d.ts.map +1 -1
  620. package/dist/unstable/cli/HelpDoc.js +21 -0
  621. package/dist/unstable/cli/Param.d.ts +79 -31
  622. package/dist/unstable/cli/Param.d.ts.map +1 -1
  623. package/dist/unstable/cli/Param.js +161 -99
  624. package/dist/unstable/cli/Param.js.map +1 -1
  625. package/dist/unstable/cli/Primitive.d.ts +79 -42
  626. package/dist/unstable/cli/Primitive.d.ts.map +1 -1
  627. package/dist/unstable/cli/Primitive.js +66 -35
  628. package/dist/unstable/cli/Primitive.js.map +1 -1
  629. package/dist/unstable/cli/Prompt.d.ts +178 -47
  630. package/dist/unstable/cli/Prompt.d.ts.map +1 -1
  631. package/dist/unstable/cli/Prompt.js +111 -31
  632. package/dist/unstable/cli/Prompt.js.map +1 -1
  633. package/dist/unstable/cli/internal/ansi.d.ts.map +1 -1
  634. package/dist/unstable/cli/internal/ansi.js +13 -0
  635. package/dist/unstable/cli/internal/ansi.js.map +1 -1
  636. package/dist/unstable/cli/internal/command.d.ts +7 -7
  637. package/dist/unstable/cli/internal/command.d.ts.map +1 -1
  638. package/dist/unstable/cli/internal/command.js +12 -10
  639. package/dist/unstable/cli/internal/command.js.map +1 -1
  640. package/dist/unstable/cli/internal/config.d.ts +3 -0
  641. package/dist/unstable/cli/internal/config.d.ts.map +1 -1
  642. package/dist/unstable/cli/internal/config.js.map +1 -1
  643. package/dist/unstable/cli/internal/lexer.js.map +1 -1
  644. package/dist/unstable/cluster/ClusterCron.d.ts +35 -1
  645. package/dist/unstable/cluster/ClusterCron.d.ts.map +1 -1
  646. package/dist/unstable/cluster/ClusterCron.js +35 -1
  647. package/dist/unstable/cluster/ClusterCron.js.map +1 -1
  648. package/dist/unstable/cluster/ClusterError.d.ts +56 -7
  649. package/dist/unstable/cluster/ClusterError.d.ts.map +1 -1
  650. package/dist/unstable/cluster/ClusterError.js +56 -7
  651. package/dist/unstable/cluster/ClusterError.js.map +1 -1
  652. package/dist/unstable/cluster/ClusterMetrics.d.ts +39 -5
  653. package/dist/unstable/cluster/ClusterMetrics.d.ts.map +1 -1
  654. package/dist/unstable/cluster/ClusterMetrics.js +39 -5
  655. package/dist/unstable/cluster/ClusterMetrics.js.map +1 -1
  656. package/dist/unstable/cluster/ClusterSchema.d.ts +61 -8
  657. package/dist/unstable/cluster/ClusterSchema.d.ts.map +1 -1
  658. package/dist/unstable/cluster/ClusterSchema.js +61 -8
  659. package/dist/unstable/cluster/ClusterSchema.js.map +1 -1
  660. package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts +14 -2
  661. package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts.map +1 -1
  662. package/dist/unstable/cluster/ClusterWorkflowEngine.js +36 -3
  663. package/dist/unstable/cluster/ClusterWorkflowEngine.js.map +1 -1
  664. package/dist/unstable/cluster/DeliverAt.d.ts +39 -4
  665. package/dist/unstable/cluster/DeliverAt.d.ts.map +1 -1
  666. package/dist/unstable/cluster/DeliverAt.js +11 -3
  667. package/dist/unstable/cluster/DeliverAt.js.map +1 -1
  668. package/dist/unstable/cluster/Entity.d.ts +75 -16
  669. package/dist/unstable/cluster/Entity.d.ts.map +1 -1
  670. package/dist/unstable/cluster/Entity.js +78 -13
  671. package/dist/unstable/cluster/Entity.js.map +1 -1
  672. package/dist/unstable/cluster/EntityAddress.d.ts +30 -2
  673. package/dist/unstable/cluster/EntityAddress.d.ts.map +1 -1
  674. package/dist/unstable/cluster/EntityAddress.js +30 -2
  675. package/dist/unstable/cluster/EntityAddress.js.map +1 -1
  676. package/dist/unstable/cluster/EntityId.d.ts +18 -3
  677. package/dist/unstable/cluster/EntityId.d.ts.map +1 -1
  678. package/dist/unstable/cluster/EntityId.js +15 -2
  679. package/dist/unstable/cluster/EntityId.js.map +1 -1
  680. package/dist/unstable/cluster/EntityProxy.d.ts +34 -2
  681. package/dist/unstable/cluster/EntityProxy.d.ts.map +1 -1
  682. package/dist/unstable/cluster/EntityProxy.js +24 -2
  683. package/dist/unstable/cluster/EntityProxy.js.map +1 -1
  684. package/dist/unstable/cluster/EntityProxyServer.d.ts +17 -2
  685. package/dist/unstable/cluster/EntityProxyServer.d.ts.map +1 -1
  686. package/dist/unstable/cluster/EntityProxyServer.js +40 -8
  687. package/dist/unstable/cluster/EntityProxyServer.js.map +1 -1
  688. package/dist/unstable/cluster/EntityResource.d.ts +43 -6
  689. package/dist/unstable/cluster/EntityResource.d.ts.map +1 -1
  690. package/dist/unstable/cluster/EntityResource.js +11 -4
  691. package/dist/unstable/cluster/EntityResource.js.map +1 -1
  692. package/dist/unstable/cluster/EntityType.d.ts +27 -3
  693. package/dist/unstable/cluster/EntityType.d.ts.map +1 -1
  694. package/dist/unstable/cluster/EntityType.js +24 -2
  695. package/dist/unstable/cluster/EntityType.js.map +1 -1
  696. package/dist/unstable/cluster/Envelope.d.ts +105 -23
  697. package/dist/unstable/cluster/Envelope.d.ts.map +1 -1
  698. package/dist/unstable/cluster/Envelope.js +88 -14
  699. package/dist/unstable/cluster/Envelope.js.map +1 -1
  700. package/dist/unstable/cluster/HttpRunner.d.ts +88 -13
  701. package/dist/unstable/cluster/HttpRunner.d.ts.map +1 -1
  702. package/dist/unstable/cluster/HttpRunner.js +88 -13
  703. package/dist/unstable/cluster/HttpRunner.js.map +1 -1
  704. package/dist/unstable/cluster/K8sHttpClient.d.ts +49 -6
  705. package/dist/unstable/cluster/K8sHttpClient.d.ts.map +1 -1
  706. package/dist/unstable/cluster/K8sHttpClient.js +31 -6
  707. package/dist/unstable/cluster/K8sHttpClient.js.map +1 -1
  708. package/dist/unstable/cluster/MachineId.d.ts +24 -3
  709. package/dist/unstable/cluster/MachineId.d.ts.map +1 -1
  710. package/dist/unstable/cluster/MachineId.js +21 -2
  711. package/dist/unstable/cluster/MachineId.js.map +1 -1
  712. package/dist/unstable/cluster/Message.d.ts +102 -13
  713. package/dist/unstable/cluster/Message.d.ts.map +1 -1
  714. package/dist/unstable/cluster/Message.js +86 -10
  715. package/dist/unstable/cluster/Message.js.map +1 -1
  716. package/dist/unstable/cluster/MessageStorage.d.ts +127 -21
  717. package/dist/unstable/cluster/MessageStorage.d.ts.map +1 -1
  718. package/dist/unstable/cluster/MessageStorage.js +71 -11
  719. package/dist/unstable/cluster/MessageStorage.js.map +1 -1
  720. package/dist/unstable/cluster/Reply.d.ts +101 -12
  721. package/dist/unstable/cluster/Reply.d.ts.map +1 -1
  722. package/dist/unstable/cluster/Reply.js +64 -8
  723. package/dist/unstable/cluster/Reply.js.map +1 -1
  724. package/dist/unstable/cluster/Runner.d.ts +47 -17
  725. package/dist/unstable/cluster/Runner.d.ts.map +1 -1
  726. package/dist/unstable/cluster/Runner.js +47 -17
  727. package/dist/unstable/cluster/Runner.js.map +1 -1
  728. package/dist/unstable/cluster/RunnerAddress.d.ts +34 -2
  729. package/dist/unstable/cluster/RunnerAddress.d.ts.map +1 -1
  730. package/dist/unstable/cluster/RunnerAddress.js +34 -2
  731. package/dist/unstable/cluster/RunnerAddress.js.map +1 -1
  732. package/dist/unstable/cluster/RunnerHealth.d.ts +40 -12
  733. package/dist/unstable/cluster/RunnerHealth.d.ts.map +1 -1
  734. package/dist/unstable/cluster/RunnerHealth.js +40 -12
  735. package/dist/unstable/cluster/RunnerHealth.js.map +1 -1
  736. package/dist/unstable/cluster/RunnerServer.d.ts +7 -4
  737. package/dist/unstable/cluster/RunnerServer.d.ts.map +1 -1
  738. package/dist/unstable/cluster/RunnerServer.js +31 -4
  739. package/dist/unstable/cluster/RunnerServer.js.map +1 -1
  740. package/dist/unstable/cluster/RunnerStorage.d.ts +42 -5
  741. package/dist/unstable/cluster/RunnerStorage.d.ts.map +1 -1
  742. package/dist/unstable/cluster/RunnerStorage.js +38 -4
  743. package/dist/unstable/cluster/RunnerStorage.js.map +1 -1
  744. package/dist/unstable/cluster/Runners.d.ts +73 -10
  745. package/dist/unstable/cluster/Runners.d.ts.map +1 -1
  746. package/dist/unstable/cluster/Runners.js +70 -9
  747. package/dist/unstable/cluster/Runners.js.map +1 -1
  748. package/dist/unstable/cluster/ShardId.d.ts +51 -5
  749. package/dist/unstable/cluster/ShardId.d.ts.map +1 -1
  750. package/dist/unstable/cluster/ShardId.js +47 -4
  751. package/dist/unstable/cluster/ShardId.js.map +1 -1
  752. package/dist/unstable/cluster/Sharding.d.ts +10 -2
  753. package/dist/unstable/cluster/Sharding.d.ts.map +1 -1
  754. package/dist/unstable/cluster/Sharding.js +35 -4
  755. package/dist/unstable/cluster/Sharding.js.map +1 -1
  756. package/dist/unstable/cluster/ShardingConfig.d.ts +65 -9
  757. package/dist/unstable/cluster/ShardingConfig.d.ts.map +1 -1
  758. package/dist/unstable/cluster/ShardingConfig.js +67 -10
  759. package/dist/unstable/cluster/ShardingConfig.js.map +1 -1
  760. package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts +27 -6
  761. package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts.map +1 -1
  762. package/dist/unstable/cluster/ShardingRegistrationEvent.js +28 -4
  763. package/dist/unstable/cluster/ShardingRegistrationEvent.js.map +1 -1
  764. package/dist/unstable/cluster/SingleRunner.d.ts +23 -1
  765. package/dist/unstable/cluster/SingleRunner.d.ts.map +1 -1
  766. package/dist/unstable/cluster/SingleRunner.js +23 -1
  767. package/dist/unstable/cluster/SingleRunner.js.map +1 -1
  768. package/dist/unstable/cluster/Singleton.d.ts +15 -1
  769. package/dist/unstable/cluster/Singleton.d.ts.map +1 -1
  770. package/dist/unstable/cluster/Singleton.js +15 -1
  771. package/dist/unstable/cluster/Singleton.js.map +1 -1
  772. package/dist/unstable/cluster/SingletonAddress.d.ts +21 -1
  773. package/dist/unstable/cluster/SingletonAddress.d.ts.map +1 -1
  774. package/dist/unstable/cluster/SingletonAddress.js +21 -1
  775. package/dist/unstable/cluster/SingletonAddress.js.map +1 -1
  776. package/dist/unstable/cluster/Snowflake.d.ts +89 -19
  777. package/dist/unstable/cluster/Snowflake.d.ts.map +1 -1
  778. package/dist/unstable/cluster/Snowflake.js +48 -13
  779. package/dist/unstable/cluster/Snowflake.js.map +1 -1
  780. package/dist/unstable/cluster/SocketRunner.d.ts +8 -2
  781. package/dist/unstable/cluster/SocketRunner.d.ts.map +1 -1
  782. package/dist/unstable/cluster/SocketRunner.js +29 -2
  783. package/dist/unstable/cluster/SocketRunner.js.map +1 -1
  784. package/dist/unstable/cluster/SqlMessageStorage.d.ts +11 -3
  785. package/dist/unstable/cluster/SqlMessageStorage.d.ts.map +1 -1
  786. package/dist/unstable/cluster/SqlMessageStorage.js +27 -3
  787. package/dist/unstable/cluster/SqlMessageStorage.js.map +1 -1
  788. package/dist/unstable/cluster/SqlRunnerStorage.d.ts +11 -3
  789. package/dist/unstable/cluster/SqlRunnerStorage.d.ts.map +1 -1
  790. package/dist/unstable/cluster/SqlRunnerStorage.js +46 -7
  791. package/dist/unstable/cluster/SqlRunnerStorage.js.map +1 -1
  792. package/dist/unstable/cluster/TestRunner.d.ts +18 -1
  793. package/dist/unstable/cluster/TestRunner.d.ts.map +1 -1
  794. package/dist/unstable/cluster/TestRunner.js +18 -1
  795. package/dist/unstable/cluster/TestRunner.js.map +1 -1
  796. package/dist/unstable/cluster/internal/hash.js +12 -0
  797. package/dist/unstable/cluster/internal/hash.js.map +1 -1
  798. package/dist/unstable/devtools/DevTools.d.ts +26 -3
  799. package/dist/unstable/devtools/DevTools.d.ts.map +1 -1
  800. package/dist/unstable/devtools/DevTools.js +26 -3
  801. package/dist/unstable/devtools/DevTools.js.map +1 -1
  802. package/dist/unstable/devtools/DevToolsClient.d.ts +20 -5
  803. package/dist/unstable/devtools/DevToolsClient.d.ts.map +1 -1
  804. package/dist/unstable/devtools/DevToolsClient.js +32 -5
  805. package/dist/unstable/devtools/DevToolsClient.js.map +1 -1
  806. package/dist/unstable/devtools/DevToolsSchema.d.ts +184 -44
  807. package/dist/unstable/devtools/DevToolsSchema.d.ts.map +1 -1
  808. package/dist/unstable/devtools/DevToolsSchema.js +102 -20
  809. package/dist/unstable/devtools/DevToolsSchema.js.map +1 -1
  810. package/dist/unstable/devtools/DevToolsServer.d.ts +27 -2
  811. package/dist/unstable/devtools/DevToolsServer.d.ts.map +1 -1
  812. package/dist/unstable/devtools/DevToolsServer.js +21 -1
  813. package/dist/unstable/devtools/DevToolsServer.js.map +1 -1
  814. package/dist/unstable/encoding/Msgpack.d.ts +81 -12
  815. package/dist/unstable/encoding/Msgpack.d.ts.map +1 -1
  816. package/dist/unstable/encoding/Msgpack.js +75 -9
  817. package/dist/unstable/encoding/Msgpack.js.map +1 -1
  818. package/dist/unstable/encoding/Ndjson.d.ts +149 -21
  819. package/dist/unstable/encoding/Ndjson.d.ts.map +1 -1
  820. package/dist/unstable/encoding/Ndjson.js +97 -13
  821. package/dist/unstable/encoding/Ndjson.js.map +1 -1
  822. package/dist/unstable/encoding/Sse.d.ts +109 -18
  823. package/dist/unstable/encoding/Sse.d.ts.map +1 -1
  824. package/dist/unstable/encoding/Sse.js +69 -13
  825. package/dist/unstable/encoding/Sse.js.map +1 -1
  826. package/dist/unstable/eventlog/Event.d.ts +115 -30
  827. package/dist/unstable/eventlog/Event.d.ts.map +1 -1
  828. package/dist/unstable/eventlog/Event.js +22 -2
  829. package/dist/unstable/eventlog/Event.js.map +1 -1
  830. package/dist/unstable/eventlog/EventGroup.d.ts +50 -17
  831. package/dist/unstable/eventlog/EventGroup.d.ts.map +1 -1
  832. package/dist/unstable/eventlog/EventGroup.js +24 -6
  833. package/dist/unstable/eventlog/EventGroup.js.map +1 -1
  834. package/dist/unstable/eventlog/EventJournal.d.ts +104 -20
  835. package/dist/unstable/eventlog/EventJournal.d.ts.map +1 -1
  836. package/dist/unstable/eventlog/EventJournal.js +108 -16
  837. package/dist/unstable/eventlog/EventJournal.js.map +1 -1
  838. package/dist/unstable/eventlog/EventLog.d.ts +151 -31
  839. package/dist/unstable/eventlog/EventLog.d.ts.map +1 -1
  840. package/dist/unstable/eventlog/EventLog.js +111 -20
  841. package/dist/unstable/eventlog/EventLog.js.map +1 -1
  842. package/dist/unstable/eventlog/EventLogEncryption.d.ts +42 -6
  843. package/dist/unstable/eventlog/EventLogEncryption.d.ts.map +1 -1
  844. package/dist/unstable/eventlog/EventLogEncryption.js +38 -5
  845. package/dist/unstable/eventlog/EventLogEncryption.js.map +1 -1
  846. package/dist/unstable/eventlog/EventLogMessage.d.ts +96 -22
  847. package/dist/unstable/eventlog/EventLogMessage.d.ts.map +1 -1
  848. package/dist/unstable/eventlog/EventLogMessage.js +72 -16
  849. package/dist/unstable/eventlog/EventLogMessage.js.map +1 -1
  850. package/dist/unstable/eventlog/EventLogRemote.d.ts +35 -8
  851. package/dist/unstable/eventlog/EventLogRemote.d.ts.map +1 -1
  852. package/dist/unstable/eventlog/EventLogRemote.js +54 -8
  853. package/dist/unstable/eventlog/EventLogRemote.js.map +1 -1
  854. package/dist/unstable/eventlog/EventLogServer.d.ts +17 -3
  855. package/dist/unstable/eventlog/EventLogServer.d.ts.map +1 -1
  856. package/dist/unstable/eventlog/EventLogServer.js +17 -3
  857. package/dist/unstable/eventlog/EventLogServer.js.map +1 -1
  858. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts +32 -6
  859. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts.map +1 -1
  860. package/dist/unstable/eventlog/EventLogServerEncrypted.js +52 -6
  861. package/dist/unstable/eventlog/EventLogServerEncrypted.js.map +1 -1
  862. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +74 -16
  863. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts.map +1 -1
  864. package/dist/unstable/eventlog/EventLogServerUnencrypted.js +90 -16
  865. package/dist/unstable/eventlog/EventLogServerUnencrypted.js.map +1 -1
  866. package/dist/unstable/eventlog/EventLogSessionAuth.d.ts +59 -15
  867. package/dist/unstable/eventlog/EventLogSessionAuth.d.ts.map +1 -1
  868. package/dist/unstable/eventlog/EventLogSessionAuth.js +73 -14
  869. package/dist/unstable/eventlog/EventLogSessionAuth.js.map +1 -1
  870. package/dist/unstable/eventlog/SqlEventJournal.d.ts +10 -2
  871. package/dist/unstable/eventlog/SqlEventJournal.d.ts.map +1 -1
  872. package/dist/unstable/eventlog/SqlEventJournal.js +28 -2
  873. package/dist/unstable/eventlog/SqlEventJournal.js.map +1 -1
  874. package/dist/unstable/eventlog/SqlEventLogServerEncrypted.d.ts +32 -3
  875. package/dist/unstable/eventlog/SqlEventLogServerEncrypted.d.ts.map +1 -1
  876. package/dist/unstable/eventlog/SqlEventLogServerEncrypted.js +32 -3
  877. package/dist/unstable/eventlog/SqlEventLogServerEncrypted.js.map +1 -1
  878. package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.d.ts +10 -2
  879. package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.d.ts.map +1 -1
  880. package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.js +28 -2
  881. package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.js.map +1 -1
  882. package/dist/unstable/http/Cookies.d.ts +156 -77
  883. package/dist/unstable/http/Cookies.d.ts.map +1 -1
  884. package/dist/unstable/http/Cookies.js +93 -39
  885. package/dist/unstable/http/Cookies.js.map +1 -1
  886. package/dist/unstable/http/Etag.d.ts +40 -7
  887. package/dist/unstable/http/Etag.d.ts.map +1 -1
  888. package/dist/unstable/http/Etag.js +27 -4
  889. package/dist/unstable/http/Etag.js.map +1 -1
  890. package/dist/unstable/http/FetchHttpClient.d.ts +29 -3
  891. package/dist/unstable/http/FetchHttpClient.d.ts.map +1 -1
  892. package/dist/unstable/http/FetchHttpClient.js +33 -4
  893. package/dist/unstable/http/FetchHttpClient.js.map +1 -1
  894. package/dist/unstable/http/FindMyWay.d.ts +1 -1
  895. package/dist/unstable/http/FindMyWay.js +1 -1
  896. package/dist/unstable/http/Headers.d.ts +182 -36
  897. package/dist/unstable/http/Headers.d.ts.map +1 -1
  898. package/dist/unstable/http/Headers.js +86 -16
  899. package/dist/unstable/http/Headers.js.map +1 -1
  900. package/dist/unstable/http/HttpBody.d.ts +114 -26
  901. package/dist/unstable/http/HttpBody.d.ts.map +1 -1
  902. package/dist/unstable/http/HttpBody.js +100 -22
  903. package/dist/unstable/http/HttpBody.js.map +1 -1
  904. package/dist/unstable/http/HttpClient.d.ts +205 -96
  905. package/dist/unstable/http/HttpClient.d.ts.map +1 -1
  906. package/dist/unstable/http/HttpClient.js +85 -39
  907. package/dist/unstable/http/HttpClient.js.map +1 -1
  908. package/dist/unstable/http/HttpClientError.d.ts +68 -12
  909. package/dist/unstable/http/HttpClientError.d.ts.map +1 -1
  910. package/dist/unstable/http/HttpClientError.js +71 -9
  911. package/dist/unstable/http/HttpClientError.js.map +1 -1
  912. package/dist/unstable/http/HttpClientRequest.d.ts +318 -100
  913. package/dist/unstable/http/HttpClientRequest.d.ts.map +1 -1
  914. package/dist/unstable/http/HttpClientRequest.js +153 -47
  915. package/dist/unstable/http/HttpClientRequest.js.map +1 -1
  916. package/dist/unstable/http/HttpClientResponse.d.ts +59 -16
  917. package/dist/unstable/http/HttpClientResponse.d.ts.map +1 -1
  918. package/dist/unstable/http/HttpClientResponse.js +44 -11
  919. package/dist/unstable/http/HttpClientResponse.js.map +1 -1
  920. package/dist/unstable/http/HttpEffect.d.ts +42 -16
  921. package/dist/unstable/http/HttpEffect.d.ts.map +1 -1
  922. package/dist/unstable/http/HttpEffect.js +33 -13
  923. package/dist/unstable/http/HttpEffect.js.map +1 -1
  924. package/dist/unstable/http/HttpIncomingMessage.d.ts +47 -7
  925. package/dist/unstable/http/HttpIncomingMessage.d.ts.map +1 -1
  926. package/dist/unstable/http/HttpIncomingMessage.js +44 -6
  927. package/dist/unstable/http/HttpIncomingMessage.js.map +1 -1
  928. package/dist/unstable/http/HttpMethod.d.ts +35 -5
  929. package/dist/unstable/http/HttpMethod.d.ts.map +1 -1
  930. package/dist/unstable/http/HttpMethod.js +23 -1
  931. package/dist/unstable/http/HttpMethod.js.map +1 -1
  932. package/dist/unstable/http/HttpMiddleware.d.ts +37 -11
  933. package/dist/unstable/http/HttpMiddleware.d.ts.map +1 -1
  934. package/dist/unstable/http/HttpMiddleware.js +70 -31
  935. package/dist/unstable/http/HttpMiddleware.js.map +1 -1
  936. package/dist/unstable/http/HttpPlatform.d.ts +34 -3
  937. package/dist/unstable/http/HttpPlatform.d.ts.map +1 -1
  938. package/dist/unstable/http/HttpPlatform.js +35 -4
  939. package/dist/unstable/http/HttpPlatform.js.map +1 -1
  940. package/dist/unstable/http/HttpRouter.d.ts +194 -45
  941. package/dist/unstable/http/HttpRouter.d.ts.map +1 -1
  942. package/dist/unstable/http/HttpRouter.js +122 -28
  943. package/dist/unstable/http/HttpRouter.js.map +1 -1
  944. package/dist/unstable/http/HttpServer.d.ts +151 -22
  945. package/dist/unstable/http/HttpServer.d.ts.map +1 -1
  946. package/dist/unstable/http/HttpServer.js +77 -12
  947. package/dist/unstable/http/HttpServer.js.map +1 -1
  948. package/dist/unstable/http/HttpServerError.d.ts +90 -10
  949. package/dist/unstable/http/HttpServerError.d.ts.map +1 -1
  950. package/dist/unstable/http/HttpServerError.js +82 -8
  951. package/dist/unstable/http/HttpServerError.js.map +1 -1
  952. package/dist/unstable/http/HttpServerRequest.d.ts +125 -21
  953. package/dist/unstable/http/HttpServerRequest.d.ts.map +1 -1
  954. package/dist/unstable/http/HttpServerRequest.js +112 -31
  955. package/dist/unstable/http/HttpServerRequest.js.map +1 -1
  956. package/dist/unstable/http/HttpServerRespondable.d.ts +32 -6
  957. package/dist/unstable/http/HttpServerRespondable.d.ts.map +1 -1
  958. package/dist/unstable/http/HttpServerRespondable.js +43 -5
  959. package/dist/unstable/http/HttpServerRespondable.js.map +1 -1
  960. package/dist/unstable/http/HttpServerResponse.d.ts +390 -67
  961. package/dist/unstable/http/HttpServerResponse.d.ts.map +1 -1
  962. package/dist/unstable/http/HttpServerResponse.js +209 -38
  963. package/dist/unstable/http/HttpServerResponse.js.map +1 -1
  964. package/dist/unstable/http/HttpStaticServer.d.ts +22 -4
  965. package/dist/unstable/http/HttpStaticServer.d.ts.map +1 -1
  966. package/dist/unstable/http/HttpStaticServer.js +22 -4
  967. package/dist/unstable/http/HttpStaticServer.js.map +1 -1
  968. package/dist/unstable/http/HttpTraceContext.d.ts +53 -6
  969. package/dist/unstable/http/HttpTraceContext.d.ts.map +1 -1
  970. package/dist/unstable/http/HttpTraceContext.js +47 -5
  971. package/dist/unstable/http/HttpTraceContext.js.map +1 -1
  972. package/dist/unstable/http/Multipart.d.ts +178 -28
  973. package/dist/unstable/http/Multipart.d.ts.map +1 -1
  974. package/dist/unstable/http/Multipart.js +130 -20
  975. package/dist/unstable/http/Multipart.js.map +1 -1
  976. package/dist/unstable/http/Multipasta/HeadersParser.d.ts +1 -1
  977. package/dist/unstable/http/Multipasta/HeadersParser.js +1 -1
  978. package/dist/unstable/http/Multipasta/Node.d.ts +1 -1
  979. package/dist/unstable/http/Multipasta/Node.js +1 -1
  980. package/dist/unstable/http/Multipasta/Search.d.ts +1 -1
  981. package/dist/unstable/http/Multipasta/Search.js +1 -1
  982. package/dist/unstable/http/Multipasta/Web.d.ts +1 -1
  983. package/dist/unstable/http/Multipasta/Web.js +1 -1
  984. package/dist/unstable/http/Multipasta.d.ts +1 -1
  985. package/dist/unstable/http/Multipasta.js +1 -1
  986. package/dist/unstable/http/Template.d.ts +53 -0
  987. package/dist/unstable/http/Template.d.ts.map +1 -1
  988. package/dist/unstable/http/Template.js +26 -0
  989. package/dist/unstable/http/Template.js.map +1 -1
  990. package/dist/unstable/http/Url.d.ts +56 -42
  991. package/dist/unstable/http/Url.d.ts.map +1 -1
  992. package/dist/unstable/http/Url.js +29 -15
  993. package/dist/unstable/http/Url.js.map +1 -1
  994. package/dist/unstable/http/UrlParams.d.ts +233 -49
  995. package/dist/unstable/http/UrlParams.d.ts.map +1 -1
  996. package/dist/unstable/http/UrlParams.js +116 -23
  997. package/dist/unstable/http/UrlParams.js.map +1 -1
  998. package/dist/unstable/httpapi/HttpApi.d.ts +49 -14
  999. package/dist/unstable/httpapi/HttpApi.d.ts.map +1 -1
  1000. package/dist/unstable/httpapi/HttpApi.js +14 -8
  1001. package/dist/unstable/httpapi/HttpApi.js.map +1 -1
  1002. package/dist/unstable/httpapi/HttpApiBuilder.d.ts +55 -16
  1003. package/dist/unstable/httpapi/HttpApiBuilder.d.ts.map +1 -1
  1004. package/dist/unstable/httpapi/HttpApiBuilder.js +47 -9
  1005. package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
  1006. package/dist/unstable/httpapi/HttpApiClient.d.ts +58 -15
  1007. package/dist/unstable/httpapi/HttpApiClient.d.ts.map +1 -1
  1008. package/dist/unstable/httpapi/HttpApiClient.js +43 -7
  1009. package/dist/unstable/httpapi/HttpApiClient.js.map +1 -1
  1010. package/dist/unstable/httpapi/HttpApiEndpoint.d.ts +214 -59
  1011. package/dist/unstable/httpapi/HttpApiEndpoint.d.ts.map +1 -1
  1012. package/dist/unstable/httpapi/HttpApiEndpoint.js +53 -9
  1013. package/dist/unstable/httpapi/HttpApiEndpoint.js.map +1 -1
  1014. package/dist/unstable/httpapi/HttpApiError.d.ts +81 -1
  1015. package/dist/unstable/httpapi/HttpApiError.d.ts.map +1 -1
  1016. package/dist/unstable/httpapi/HttpApiError.js +98 -1
  1017. package/dist/unstable/httpapi/HttpApiError.js.map +1 -1
  1018. package/dist/unstable/httpapi/HttpApiGroup.d.ts +87 -20
  1019. package/dist/unstable/httpapi/HttpApiGroup.d.ts.map +1 -1
  1020. package/dist/unstable/httpapi/HttpApiGroup.js +5 -2
  1021. package/dist/unstable/httpapi/HttpApiGroup.js.map +1 -1
  1022. package/dist/unstable/httpapi/HttpApiMiddleware.d.ts +113 -22
  1023. package/dist/unstable/httpapi/HttpApiMiddleware.d.ts.map +1 -1
  1024. package/dist/unstable/httpapi/HttpApiMiddleware.js +49 -6
  1025. package/dist/unstable/httpapi/HttpApiMiddleware.js.map +1 -1
  1026. package/dist/unstable/httpapi/HttpApiScalar.d.ts +19 -4
  1027. package/dist/unstable/httpapi/HttpApiScalar.d.ts.map +1 -1
  1028. package/dist/unstable/httpapi/HttpApiScalar.js +32 -2
  1029. package/dist/unstable/httpapi/HttpApiScalar.js.map +1 -1
  1030. package/dist/unstable/httpapi/HttpApiSchema.d.ts +67 -30
  1031. package/dist/unstable/httpapi/HttpApiSchema.d.ts.map +1 -1
  1032. package/dist/unstable/httpapi/HttpApiSchema.js +48 -27
  1033. package/dist/unstable/httpapi/HttpApiSchema.js.map +1 -1
  1034. package/dist/unstable/httpapi/HttpApiSecurity.d.ts +74 -17
  1035. package/dist/unstable/httpapi/HttpApiSecurity.d.ts.map +1 -1
  1036. package/dist/unstable/httpapi/HttpApiSecurity.js +38 -5
  1037. package/dist/unstable/httpapi/HttpApiSecurity.js.map +1 -1
  1038. package/dist/unstable/httpapi/HttpApiSwagger.d.ts +5 -2
  1039. package/dist/unstable/httpapi/HttpApiSwagger.d.ts.map +1 -1
  1040. package/dist/unstable/httpapi/HttpApiSwagger.js +24 -2
  1041. package/dist/unstable/httpapi/HttpApiSwagger.js.map +1 -1
  1042. package/dist/unstable/httpapi/HttpApiTest.d.ts +9 -2
  1043. package/dist/unstable/httpapi/HttpApiTest.d.ts.map +1 -1
  1044. package/dist/unstable/httpapi/HttpApiTest.js +28 -3
  1045. package/dist/unstable/httpapi/HttpApiTest.js.map +1 -1
  1046. package/dist/unstable/httpapi/OpenApi.d.ts +86 -15
  1047. package/dist/unstable/httpapi/OpenApi.d.ts.map +1 -1
  1048. package/dist/unstable/httpapi/OpenApi.js +73 -15
  1049. package/dist/unstable/httpapi/OpenApi.js.map +1 -1
  1050. package/dist/unstable/observability/Otlp.d.ts +33 -3
  1051. package/dist/unstable/observability/Otlp.d.ts.map +1 -1
  1052. package/dist/unstable/observability/Otlp.js +14 -3
  1053. package/dist/unstable/observability/Otlp.js.map +1 -1
  1054. package/dist/unstable/observability/OtlpExporter.d.ts +8 -1
  1055. package/dist/unstable/observability/OtlpExporter.d.ts.map +1 -1
  1056. package/dist/unstable/observability/OtlpExporter.js +32 -1
  1057. package/dist/unstable/observability/OtlpExporter.js.map +1 -1
  1058. package/dist/unstable/observability/OtlpLogger.d.ts +14 -2
  1059. package/dist/unstable/observability/OtlpLogger.d.ts.map +1 -1
  1060. package/dist/unstable/observability/OtlpLogger.js +29 -2
  1061. package/dist/unstable/observability/OtlpLogger.js.map +1 -1
  1062. package/dist/unstable/observability/OtlpMetrics.d.ts +15 -4
  1063. package/dist/unstable/observability/OtlpMetrics.d.ts.map +1 -1
  1064. package/dist/unstable/observability/OtlpMetrics.js +32 -2
  1065. package/dist/unstable/observability/OtlpMetrics.js.map +1 -1
  1066. package/dist/unstable/observability/OtlpResource.d.ts +49 -12
  1067. package/dist/unstable/observability/OtlpResource.d.ts.map +1 -1
  1068. package/dist/unstable/observability/OtlpResource.js +47 -5
  1069. package/dist/unstable/observability/OtlpResource.js.map +1 -1
  1070. package/dist/unstable/observability/OtlpSerialization.d.ts +28 -3
  1071. package/dist/unstable/observability/OtlpSerialization.d.ts.map +1 -1
  1072. package/dist/unstable/observability/OtlpSerialization.js +28 -3
  1073. package/dist/unstable/observability/OtlpSerialization.js.map +1 -1
  1074. package/dist/unstable/observability/OtlpTracer.d.ts +16 -2
  1075. package/dist/unstable/observability/OtlpTracer.d.ts.map +1 -1
  1076. package/dist/unstable/observability/OtlpTracer.js +32 -2
  1077. package/dist/unstable/observability/OtlpTracer.js.map +1 -1
  1078. package/dist/unstable/observability/PrometheusMetrics.d.ts +32 -12
  1079. package/dist/unstable/observability/PrometheusMetrics.d.ts.map +1 -1
  1080. package/dist/unstable/observability/PrometheusMetrics.js +7 -5
  1081. package/dist/unstable/observability/PrometheusMetrics.js.map +1 -1
  1082. package/dist/unstable/observability/index.d.ts +2 -1
  1083. package/dist/unstable/observability/index.d.ts.map +1 -1
  1084. package/dist/unstable/observability/index.js +2 -1
  1085. package/dist/unstable/observability/index.js.map +1 -1
  1086. package/dist/unstable/persistence/KeyValueStore.d.ts +93 -18
  1087. package/dist/unstable/persistence/KeyValueStore.d.ts.map +1 -1
  1088. package/dist/unstable/persistence/KeyValueStore.js +81 -21
  1089. package/dist/unstable/persistence/KeyValueStore.js.map +1 -1
  1090. package/dist/unstable/persistence/Persistable.d.ts +76 -15
  1091. package/dist/unstable/persistence/Persistable.d.ts.map +1 -1
  1092. package/dist/unstable/persistence/Persistable.js +22 -5
  1093. package/dist/unstable/persistence/Persistable.js.map +1 -1
  1094. package/dist/unstable/persistence/PersistedCache.d.ts +27 -2
  1095. package/dist/unstable/persistence/PersistedCache.d.ts.map +1 -1
  1096. package/dist/unstable/persistence/PersistedCache.js +24 -1
  1097. package/dist/unstable/persistence/PersistedCache.js.map +1 -1
  1098. package/dist/unstable/persistence/PersistedQueue.d.ts +73 -16
  1099. package/dist/unstable/persistence/PersistedQueue.d.ts.map +1 -1
  1100. package/dist/unstable/persistence/PersistedQueue.js +60 -13
  1101. package/dist/unstable/persistence/PersistedQueue.js.map +1 -1
  1102. package/dist/unstable/persistence/Persistence.d.ts +97 -16
  1103. package/dist/unstable/persistence/Persistence.d.ts.map +1 -1
  1104. package/dist/unstable/persistence/Persistence.js +90 -14
  1105. package/dist/unstable/persistence/Persistence.js.map +1 -1
  1106. package/dist/unstable/persistence/RateLimiter.d.ts +97 -21
  1107. package/dist/unstable/persistence/RateLimiter.d.ts.map +1 -1
  1108. package/dist/unstable/persistence/RateLimiter.js +82 -17
  1109. package/dist/unstable/persistence/RateLimiter.js.map +1 -1
  1110. package/dist/unstable/persistence/Redis.d.ts +26 -5
  1111. package/dist/unstable/persistence/Redis.d.ts.map +1 -1
  1112. package/dist/unstable/persistence/Redis.js +36 -4
  1113. package/dist/unstable/persistence/Redis.js.map +1 -1
  1114. package/dist/unstable/process/ChildProcess.d.ts +89 -109
  1115. package/dist/unstable/process/ChildProcess.d.ts.map +1 -1
  1116. package/dist/unstable/process/ChildProcess.js +74 -23
  1117. package/dist/unstable/process/ChildProcess.js.map +1 -1
  1118. package/dist/unstable/process/ChildProcessSpawner.d.ts +22 -11
  1119. package/dist/unstable/process/ChildProcessSpawner.d.ts.map +1 -1
  1120. package/dist/unstable/process/ChildProcessSpawner.js +11 -6
  1121. package/dist/unstable/process/ChildProcessSpawner.js.map +1 -1
  1122. package/dist/unstable/process/index.d.ts +2 -1
  1123. package/dist/unstable/process/index.d.ts.map +1 -1
  1124. package/dist/unstable/process/index.js +2 -1
  1125. package/dist/unstable/process/index.js.map +1 -1
  1126. package/dist/unstable/reactivity/AsyncResult.d.ts +196 -59
  1127. package/dist/unstable/reactivity/AsyncResult.d.ts.map +1 -1
  1128. package/dist/unstable/reactivity/AsyncResult.js +121 -36
  1129. package/dist/unstable/reactivity/AsyncResult.js.map +1 -1
  1130. package/dist/unstable/reactivity/Atom.d.ts +539 -130
  1131. package/dist/unstable/reactivity/Atom.d.ts.map +1 -1
  1132. package/dist/unstable/reactivity/Atom.js +256 -62
  1133. package/dist/unstable/reactivity/Atom.js.map +1 -1
  1134. package/dist/unstable/reactivity/AtomHttpApi.d.ts +41 -2
  1135. package/dist/unstable/reactivity/AtomHttpApi.d.ts.map +1 -1
  1136. package/dist/unstable/reactivity/AtomHttpApi.js +35 -1
  1137. package/dist/unstable/reactivity/AtomHttpApi.js.map +1 -1
  1138. package/dist/unstable/reactivity/AtomRef.d.ts +51 -7
  1139. package/dist/unstable/reactivity/AtomRef.d.ts.map +1 -1
  1140. package/dist/unstable/reactivity/AtomRef.js +29 -3
  1141. package/dist/unstable/reactivity/AtomRef.js.map +1 -1
  1142. package/dist/unstable/reactivity/AtomRegistry.d.ts +135 -21
  1143. package/dist/unstable/reactivity/AtomRegistry.d.ts.map +1 -1
  1144. package/dist/unstable/reactivity/AtomRegistry.js +69 -10
  1145. package/dist/unstable/reactivity/AtomRegistry.js.map +1 -1
  1146. package/dist/unstable/reactivity/AtomRpc.d.ts +36 -2
  1147. package/dist/unstable/reactivity/AtomRpc.d.ts.map +1 -1
  1148. package/dist/unstable/reactivity/AtomRpc.js +29 -1
  1149. package/dist/unstable/reactivity/AtomRpc.js.map +1 -1
  1150. package/dist/unstable/reactivity/Hydration.d.ts +28 -5
  1151. package/dist/unstable/reactivity/Hydration.d.ts.map +1 -1
  1152. package/dist/unstable/reactivity/Hydration.js +35 -3
  1153. package/dist/unstable/reactivity/Hydration.js.map +1 -1
  1154. package/dist/unstable/reactivity/Reactivity.d.ts +95 -13
  1155. package/dist/unstable/reactivity/Reactivity.d.ts.map +1 -1
  1156. package/dist/unstable/reactivity/Reactivity.js +61 -7
  1157. package/dist/unstable/reactivity/Reactivity.js.map +1 -1
  1158. package/dist/unstable/rpc/Rpc.d.ts +255 -56
  1159. package/dist/unstable/rpc/Rpc.d.ts.map +1 -1
  1160. package/dist/unstable/rpc/Rpc.js +44 -11
  1161. package/dist/unstable/rpc/Rpc.js.map +1 -1
  1162. package/dist/unstable/rpc/RpcClient.d.ts +81 -19
  1163. package/dist/unstable/rpc/RpcClient.d.ts.map +1 -1
  1164. package/dist/unstable/rpc/RpcClient.js +53 -13
  1165. package/dist/unstable/rpc/RpcClient.js.map +1 -1
  1166. package/dist/unstable/rpc/RpcClientError.d.ts +26 -2
  1167. package/dist/unstable/rpc/RpcClientError.d.ts.map +1 -1
  1168. package/dist/unstable/rpc/RpcClientError.js +26 -2
  1169. package/dist/unstable/rpc/RpcClientError.js.map +1 -1
  1170. package/dist/unstable/rpc/RpcGroup.d.ts +51 -8
  1171. package/dist/unstable/rpc/RpcGroup.d.ts.map +1 -1
  1172. package/dist/unstable/rpc/RpcGroup.js +3 -1
  1173. package/dist/unstable/rpc/RpcGroup.js.map +1 -1
  1174. package/dist/unstable/rpc/RpcMessage.d.ts +128 -32
  1175. package/dist/unstable/rpc/RpcMessage.d.ts.map +1 -1
  1176. package/dist/unstable/rpc/RpcMessage.js +23 -7
  1177. package/dist/unstable/rpc/RpcMessage.js.map +1 -1
  1178. package/dist/unstable/rpc/RpcMiddleware.d.ts +100 -20
  1179. package/dist/unstable/rpc/RpcMiddleware.d.ts.map +1 -1
  1180. package/dist/unstable/rpc/RpcMiddleware.js +39 -3
  1181. package/dist/unstable/rpc/RpcMiddleware.js.map +1 -1
  1182. package/dist/unstable/rpc/RpcSchema.d.ts +38 -4
  1183. package/dist/unstable/rpc/RpcSchema.d.ts.map +1 -1
  1184. package/dist/unstable/rpc/RpcSchema.js +34 -3
  1185. package/dist/unstable/rpc/RpcSchema.js.map +1 -1
  1186. package/dist/unstable/rpc/RpcSerialization.d.ts +60 -13
  1187. package/dist/unstable/rpc/RpcSerialization.d.ts.map +1 -1
  1188. package/dist/unstable/rpc/RpcSerialization.js +56 -12
  1189. package/dist/unstable/rpc/RpcSerialization.js.map +1 -1
  1190. package/dist/unstable/rpc/RpcServer.d.ts +73 -23
  1191. package/dist/unstable/rpc/RpcServer.d.ts.map +1 -1
  1192. package/dist/unstable/rpc/RpcServer.js +70 -23
  1193. package/dist/unstable/rpc/RpcServer.js.map +1 -1
  1194. package/dist/unstable/rpc/RpcTest.d.ts +20 -1
  1195. package/dist/unstable/rpc/RpcTest.d.ts.map +1 -1
  1196. package/dist/unstable/rpc/RpcTest.js +20 -1
  1197. package/dist/unstable/rpc/RpcTest.js.map +1 -1
  1198. package/dist/unstable/rpc/RpcWorker.d.ts +40 -6
  1199. package/dist/unstable/rpc/RpcWorker.d.ts.map +1 -1
  1200. package/dist/unstable/rpc/RpcWorker.js +17 -5
  1201. package/dist/unstable/rpc/RpcWorker.js.map +1 -1
  1202. package/dist/unstable/rpc/Utils.d.ts +8 -0
  1203. package/dist/unstable/rpc/Utils.d.ts.map +1 -1
  1204. package/dist/unstable/rpc/Utils.js +8 -0
  1205. package/dist/unstable/rpc/Utils.js.map +1 -1
  1206. package/dist/unstable/schema/Model.d.ts +130 -52
  1207. package/dist/unstable/schema/Model.d.ts.map +1 -1
  1208. package/dist/unstable/schema/Model.js +79 -34
  1209. package/dist/unstable/schema/Model.js.map +1 -1
  1210. package/dist/unstable/schema/VariantSchema.d.ts +104 -24
  1211. package/dist/unstable/schema/VariantSchema.d.ts.map +1 -1
  1212. package/dist/unstable/schema/VariantSchema.js +22 -6
  1213. package/dist/unstable/schema/VariantSchema.js.map +1 -1
  1214. package/dist/unstable/socket/Socket.d.ts +167 -34
  1215. package/dist/unstable/socket/Socket.d.ts.map +1 -1
  1216. package/dist/unstable/socket/Socket.js +124 -29
  1217. package/dist/unstable/socket/Socket.js.map +1 -1
  1218. package/dist/unstable/socket/SocketServer.d.ts +58 -10
  1219. package/dist/unstable/socket/SocketServer.d.ts.map +1 -1
  1220. package/dist/unstable/socket/SocketServer.js +43 -5
  1221. package/dist/unstable/socket/SocketServer.js.map +1 -1
  1222. package/dist/unstable/sql/Migrator.d.ts +35 -4
  1223. package/dist/unstable/sql/Migrator.d.ts.map +1 -1
  1224. package/dist/unstable/sql/Migrator.js +45 -5
  1225. package/dist/unstable/sql/Migrator.js.map +1 -1
  1226. package/dist/unstable/sql/SqlClient.d.ts +34 -2
  1227. package/dist/unstable/sql/SqlClient.d.ts.map +1 -1
  1228. package/dist/unstable/sql/SqlClient.js +38 -1
  1229. package/dist/unstable/sql/SqlClient.js.map +1 -1
  1230. package/dist/unstable/sql/SqlConnection.d.ts +31 -0
  1231. package/dist/unstable/sql/SqlConnection.d.ts.map +1 -1
  1232. package/dist/unstable/sql/SqlConnection.js +22 -0
  1233. package/dist/unstable/sql/SqlConnection.js.map +1 -1
  1234. package/dist/unstable/sql/SqlError.d.ts +99 -0
  1235. package/dist/unstable/sql/SqlError.d.ts.map +1 -1
  1236. package/dist/unstable/sql/SqlError.js +114 -0
  1237. package/dist/unstable/sql/SqlError.js.map +1 -1
  1238. package/dist/unstable/sql/SqlModel.d.ts +26 -5
  1239. package/dist/unstable/sql/SqlModel.d.ts.map +1 -1
  1240. package/dist/unstable/sql/SqlModel.js +8 -4
  1241. package/dist/unstable/sql/SqlModel.js.map +1 -1
  1242. package/dist/unstable/sql/SqlResolver.d.ts +56 -13
  1243. package/dist/unstable/sql/SqlResolver.d.ts.map +1 -1
  1244. package/dist/unstable/sql/SqlResolver.js +44 -10
  1245. package/dist/unstable/sql/SqlResolver.js.map +1 -1
  1246. package/dist/unstable/sql/SqlSchema.d.ts +29 -8
  1247. package/dist/unstable/sql/SqlSchema.d.ts.map +1 -1
  1248. package/dist/unstable/sql/SqlSchema.js +29 -8
  1249. package/dist/unstable/sql/SqlSchema.js.map +1 -1
  1250. package/dist/unstable/sql/SqlStream.d.ts +3 -0
  1251. package/dist/unstable/sql/SqlStream.d.ts.map +1 -1
  1252. package/dist/unstable/sql/SqlStream.js +23 -0
  1253. package/dist/unstable/sql/SqlStream.js.map +1 -1
  1254. package/dist/unstable/sql/Statement.d.ts +124 -0
  1255. package/dist/unstable/sql/Statement.d.ts.map +1 -1
  1256. package/dist/unstable/sql/Statement.js +82 -0
  1257. package/dist/unstable/sql/Statement.js.map +1 -1
  1258. package/dist/unstable/sql/index.d.ts +1 -1
  1259. package/dist/unstable/sql/index.js +1 -1
  1260. package/dist/unstable/workers/Transferable.d.ts +65 -13
  1261. package/dist/unstable/workers/Transferable.d.ts.map +1 -1
  1262. package/dist/unstable/workers/Transferable.js +53 -10
  1263. package/dist/unstable/workers/Transferable.js.map +1 -1
  1264. package/dist/unstable/workers/Worker.d.ts +60 -8
  1265. package/dist/unstable/workers/Worker.d.ts.map +1 -1
  1266. package/dist/unstable/workers/Worker.js +43 -4
  1267. package/dist/unstable/workers/Worker.js.map +1 -1
  1268. package/dist/unstable/workers/WorkerError.d.ts +31 -9
  1269. package/dist/unstable/workers/WorkerError.d.ts.map +1 -1
  1270. package/dist/unstable/workers/WorkerError.js +44 -7
  1271. package/dist/unstable/workers/WorkerError.js.map +1 -1
  1272. package/dist/unstable/workers/WorkerRunner.d.ts +32 -3
  1273. package/dist/unstable/workers/WorkerRunner.d.ts.map +1 -1
  1274. package/dist/unstable/workers/WorkerRunner.js +24 -1
  1275. package/dist/unstable/workers/WorkerRunner.js.map +1 -1
  1276. package/dist/unstable/workers/index.d.ts +1 -1
  1277. package/dist/unstable/workers/index.js +1 -1
  1278. package/dist/unstable/workflow/Activity.d.ts +61 -10
  1279. package/dist/unstable/workflow/Activity.d.ts.map +1 -1
  1280. package/dist/unstable/workflow/Activity.js +21 -6
  1281. package/dist/unstable/workflow/Activity.js.map +1 -1
  1282. package/dist/unstable/workflow/DurableClock.d.ts +12 -3
  1283. package/dist/unstable/workflow/DurableClock.d.ts.map +1 -1
  1284. package/dist/unstable/workflow/DurableClock.js +22 -2
  1285. package/dist/unstable/workflow/DurableClock.js.map +1 -1
  1286. package/dist/unstable/workflow/DurableDeferred.d.ts +126 -31
  1287. package/dist/unstable/workflow/DurableDeferred.d.ts.map +1 -1
  1288. package/dist/unstable/workflow/DurableDeferred.js +76 -13
  1289. package/dist/unstable/workflow/DurableDeferred.js.map +1 -1
  1290. package/dist/unstable/workflow/DurableQueue.d.ts +145 -0
  1291. package/dist/unstable/workflow/DurableQueue.d.ts.map +1 -0
  1292. package/dist/unstable/workflow/DurableQueue.js +200 -0
  1293. package/dist/unstable/workflow/DurableQueue.js.map +1 -0
  1294. package/dist/unstable/workflow/Workflow.d.ts +100 -31
  1295. package/dist/unstable/workflow/Workflow.d.ts.map +1 -1
  1296. package/dist/unstable/workflow/Workflow.js +76 -20
  1297. package/dist/unstable/workflow/Workflow.js.map +1 -1
  1298. package/dist/unstable/workflow/WorkflowEngine.d.ts +40 -5
  1299. package/dist/unstable/workflow/WorkflowEngine.d.ts.map +1 -1
  1300. package/dist/unstable/workflow/WorkflowEngine.js +16 -4
  1301. package/dist/unstable/workflow/WorkflowEngine.js.map +1 -1
  1302. package/dist/unstable/workflow/WorkflowProxy.d.ts +32 -2
  1303. package/dist/unstable/workflow/WorkflowProxy.d.ts.map +1 -1
  1304. package/dist/unstable/workflow/WorkflowProxy.js +2 -2
  1305. package/dist/unstable/workflow/WorkflowProxy.js.map +1 -1
  1306. package/dist/unstable/workflow/WorkflowProxyServer.d.ts +36 -2
  1307. package/dist/unstable/workflow/WorkflowProxyServer.d.ts.map +1 -1
  1308. package/dist/unstable/workflow/WorkflowProxyServer.js +12 -6
  1309. package/dist/unstable/workflow/WorkflowProxyServer.js.map +1 -1
  1310. package/dist/unstable/workflow/index.d.ts +4 -0
  1311. package/dist/unstable/workflow/index.d.ts.map +1 -1
  1312. package/dist/unstable/workflow/index.js +4 -0
  1313. package/dist/unstable/workflow/index.js.map +1 -1
  1314. package/package.json +11 -11
  1315. package/src/Array.ts +113 -67
  1316. package/src/BigDecimal.ts +404 -337
  1317. package/src/BigInt.ts +167 -97
  1318. package/src/Boolean.ts +62 -31
  1319. package/src/Brand.ts +20 -1
  1320. package/src/Cache.ts +331 -164
  1321. package/src/Cause.ts +77 -65
  1322. package/src/Channel.ts +1585 -607
  1323. package/src/ChannelSchema.ts +137 -12
  1324. package/src/Chunk.ts +549 -380
  1325. package/src/Clock.ts +15 -8
  1326. package/src/Combiner.ts +2 -4
  1327. package/src/Config.ts +12 -10
  1328. package/src/ConfigProvider.ts +1 -1
  1329. package/src/Console.ts +88 -58
  1330. package/src/Context.ts +397 -149
  1331. package/src/Cron.ts +111 -48
  1332. package/src/Data.ts +3 -2
  1333. package/src/DateTime.ts +876 -445
  1334. package/src/Deferred.ts +367 -174
  1335. package/src/Differ.ts +42 -0
  1336. package/src/Duration.ts +329 -185
  1337. package/src/Effect.ts +2474 -2395
  1338. package/src/Effectable.ts +39 -4
  1339. package/src/Encoding.ts +78 -28
  1340. package/src/Equivalence.ts +14 -19
  1341. package/src/ErrorReporter.ts +66 -82
  1342. package/src/ExecutionPlan.ts +97 -13
  1343. package/src/Exit.ts +7 -5
  1344. package/src/Fiber.ts +72 -40
  1345. package/src/FiberHandle.ts +158 -58
  1346. package/src/FiberMap.ts +329 -164
  1347. package/src/FiberSet.ts +130 -52
  1348. package/src/FileSystem.ts +106 -74
  1349. package/src/Filter.ts +166 -88
  1350. package/src/Function.ts +154 -86
  1351. package/src/Graph.ts +682 -365
  1352. package/src/HKT.ts +29 -13
  1353. package/src/Hash.ts +31 -18
  1354. package/src/HashMap.ts +444 -256
  1355. package/src/HashRing.ts +94 -17
  1356. package/src/HashSet.ts +194 -104
  1357. package/src/Inspectable.ts +22 -10
  1358. package/src/Iterable.ts +309 -149
  1359. package/src/JsonPatch.ts +4 -3
  1360. package/src/Latch.ts +98 -15
  1361. package/src/Layer.ts +488 -345
  1362. package/src/LayerMap.ts +98 -25
  1363. package/src/LogLevel.ts +92 -131
  1364. package/src/Logger.ts +357 -288
  1365. package/src/ManagedRuntime.ts +75 -17
  1366. package/src/Match.ts +133 -157
  1367. package/src/Metric.ts +355 -304
  1368. package/src/MutableHashMap.ts +161 -84
  1369. package/src/MutableHashSet.ts +122 -52
  1370. package/src/MutableList.ts +141 -81
  1371. package/src/MutableRef.ts +130 -90
  1372. package/src/Newtype.ts +3 -0
  1373. package/src/NonEmptyIterable.ts +36 -39
  1374. package/src/Number.ts +116 -64
  1375. package/src/Optic.ts +1 -2
  1376. package/src/Option.ts +41 -53
  1377. package/src/Ordering.ts +43 -28
  1378. package/src/PartitionedSemaphore.ts +225 -40
  1379. package/src/Path.ts +77 -13
  1380. package/src/Pipeable.ts +76 -21
  1381. package/src/PlatformError.ts +74 -6
  1382. package/src/Pool.ts +94 -31
  1383. package/src/Predicate.ts +16 -21
  1384. package/src/PrimaryKey.ts +9 -2
  1385. package/src/PubSub.ts +364 -262
  1386. package/src/Pull.ts +94 -25
  1387. package/src/Queue.ts +284 -150
  1388. package/src/Random.ts +54 -35
  1389. package/src/RcMap.ts +151 -141
  1390. package/src/RcRef.ts +69 -32
  1391. package/src/Record.ts +273 -129
  1392. package/src/Redactable.ts +3 -3
  1393. package/src/Redacted.ts +63 -33
  1394. package/src/Ref.ts +161 -104
  1395. package/src/References.ts +73 -31
  1396. package/src/RegExp.ts +11 -5
  1397. package/src/Request.ts +158 -34
  1398. package/src/RequestResolver.ts +277 -119
  1399. package/src/Resource.ts +45 -7
  1400. package/src/Result.ts +31 -18
  1401. package/src/Runtime.ts +45 -19
  1402. package/src/Schedule.ts +575 -600
  1403. package/src/Scheduler.ts +43 -6
  1404. package/src/Schema.ts +845 -319
  1405. package/src/SchemaAST.ts +25 -16
  1406. package/src/SchemaGetter.ts +32 -17
  1407. package/src/SchemaIssue.ts +1 -8
  1408. package/src/SchemaParser.ts +262 -38
  1409. package/src/SchemaTransformation.ts +61 -41
  1410. package/src/SchemaUtils.ts +23 -0
  1411. package/src/Scope.ts +102 -43
  1412. package/src/ScopedCache.ts +192 -56
  1413. package/src/ScopedRef.ts +28 -8
  1414. package/src/Semaphore.ts +64 -28
  1415. package/src/Sink.ts +458 -200
  1416. package/src/Stdio.ts +43 -6
  1417. package/src/Stream.ts +2043 -1256
  1418. package/src/String.ts +171 -95
  1419. package/src/SubscriptionRef.ts +308 -203
  1420. package/src/Symbol.ts +13 -5
  1421. package/src/SynchronizedRef.ts +278 -62
  1422. package/src/Take.ts +26 -2
  1423. package/src/Terminal.ts +40 -7
  1424. package/src/Tracer.ts +229 -55
  1425. package/src/Trie.ts +213 -142
  1426. package/src/TxChunk.ts +182 -146
  1427. package/src/TxDeferred.ts +43 -29
  1428. package/src/TxHashMap.ts +370 -230
  1429. package/src/TxHashSet.ts +250 -152
  1430. package/src/TxPriorityQueue.ts +96 -64
  1431. package/src/TxPubSub.ts +77 -49
  1432. package/src/TxQueue.ts +279 -241
  1433. package/src/TxReentrantLock.ts +70 -47
  1434. package/src/TxRef.ts +70 -41
  1435. package/src/TxSemaphore.ts +101 -54
  1436. package/src/TxSubscriptionRef.ts +72 -48
  1437. package/src/Types.ts +34 -34
  1438. package/src/UndefinedOr.ts +48 -25
  1439. package/src/Unify.ts +71 -116
  1440. package/src/Utils.ts +4 -0
  1441. package/src/index.ts +81 -32
  1442. package/src/internal/concurrency.ts +2 -2
  1443. package/src/internal/core.ts +12 -23
  1444. package/src/internal/effect.ts +25 -29
  1445. package/src/internal/executionPlan.ts +2 -2
  1446. package/src/internal/option.ts +5 -8
  1447. package/src/internal/result.ts +5 -8
  1448. package/src/internal/schema/schema.ts +1 -1
  1449. package/src/testing/FastCheck.ts +6 -3
  1450. package/src/testing/TestClock.ts +63 -34
  1451. package/src/testing/TestConsole.ts +49 -30
  1452. package/src/testing/TestSchema.ts +8 -8
  1453. package/src/unstable/ai/AiError.ts +187 -120
  1454. package/src/unstable/ai/AnthropicStructuredOutput.ts +2 -2
  1455. package/src/unstable/ai/Chat.ts +69 -43
  1456. package/src/unstable/ai/EmbeddingModel.ts +12 -11
  1457. package/src/unstable/ai/IdGenerator.ts +28 -18
  1458. package/src/unstable/ai/LanguageModel.ts +47 -46
  1459. package/src/unstable/ai/McpSchema.ts +339 -119
  1460. package/src/unstable/ai/McpServer.ts +78 -21
  1461. package/src/unstable/ai/Model.ts +23 -18
  1462. package/src/unstable/ai/OpenAiStructuredOutput.ts +2 -2
  1463. package/src/unstable/ai/Prompt.ts +210 -184
  1464. package/src/unstable/ai/Response.ts +159 -147
  1465. package/src/unstable/ai/ResponseIdTracker.ts +43 -4
  1466. package/src/unstable/ai/Telemetry.ts +42 -32
  1467. package/src/unstable/ai/Tokenizer.ts +13 -8
  1468. package/src/unstable/ai/Tool.ts +154 -85
  1469. package/src/unstable/ai/Toolkit.ts +81 -84
  1470. package/src/unstable/ai/index.ts +42 -24
  1471. package/src/unstable/cli/Argument.ts +226 -134
  1472. package/src/unstable/cli/CliError.ts +96 -26
  1473. package/src/unstable/cli/CliOutput.ts +43 -13
  1474. package/src/unstable/cli/Command.ts +225 -125
  1475. package/src/unstable/cli/Completions.ts +7 -7
  1476. package/src/unstable/cli/Flag.ts +235 -142
  1477. package/src/unstable/cli/GlobalFlag.ts +42 -14
  1478. package/src/unstable/cli/HelpDoc.ts +35 -10
  1479. package/src/unstable/cli/Param.ts +328 -190
  1480. package/src/unstable/cli/Primitive.ts +79 -42
  1481. package/src/unstable/cli/Prompt.ts +210 -58
  1482. package/src/unstable/cli/internal/ansi.ts +13 -0
  1483. package/src/unstable/cli/internal/command.ts +17 -15
  1484. package/src/unstable/cli/internal/config.ts +3 -0
  1485. package/src/unstable/cli/internal/lexer.ts +11 -0
  1486. package/src/unstable/cluster/ClusterCron.ts +35 -1
  1487. package/src/unstable/cluster/ClusterError.ts +56 -7
  1488. package/src/unstable/cluster/ClusterMetrics.ts +39 -5
  1489. package/src/unstable/cluster/ClusterSchema.ts +61 -8
  1490. package/src/unstable/cluster/ClusterWorkflowEngine.ts +36 -3
  1491. package/src/unstable/cluster/DeliverAt.ts +39 -4
  1492. package/src/unstable/cluster/Entity.ts +110 -19
  1493. package/src/unstable/cluster/EntityAddress.ts +30 -2
  1494. package/src/unstable/cluster/EntityId.ts +18 -3
  1495. package/src/unstable/cluster/EntityProxy.ts +34 -2
  1496. package/src/unstable/cluster/EntityProxyServer.ts +44 -8
  1497. package/src/unstable/cluster/EntityResource.ts +43 -6
  1498. package/src/unstable/cluster/EntityType.ts +27 -3
  1499. package/src/unstable/cluster/Envelope.ts +128 -23
  1500. package/src/unstable/cluster/HttpRunner.ts +88 -13
  1501. package/src/unstable/cluster/K8sHttpClient.ts +49 -6
  1502. package/src/unstable/cluster/MachineId.ts +24 -3
  1503. package/src/unstable/cluster/Message.ts +102 -13
  1504. package/src/unstable/cluster/MessageStorage.ts +128 -22
  1505. package/src/unstable/cluster/Reply.ts +101 -12
  1506. package/src/unstable/cluster/Runner.ts +47 -17
  1507. package/src/unstable/cluster/RunnerAddress.ts +34 -2
  1508. package/src/unstable/cluster/RunnerHealth.ts +40 -12
  1509. package/src/unstable/cluster/RunnerServer.ts +31 -4
  1510. package/src/unstable/cluster/RunnerStorage.ts +42 -5
  1511. package/src/unstable/cluster/Runners.ts +73 -10
  1512. package/src/unstable/cluster/ShardId.ts +51 -5
  1513. package/src/unstable/cluster/Sharding.ts +35 -4
  1514. package/src/unstable/cluster/ShardingConfig.ts +76 -11
  1515. package/src/unstable/cluster/ShardingRegistrationEvent.ts +31 -7
  1516. package/src/unstable/cluster/SingleRunner.ts +23 -1
  1517. package/src/unstable/cluster/Singleton.ts +15 -1
  1518. package/src/unstable/cluster/SingletonAddress.ts +21 -1
  1519. package/src/unstable/cluster/Snowflake.ts +89 -19
  1520. package/src/unstable/cluster/SocketRunner.ts +29 -2
  1521. package/src/unstable/cluster/SqlMessageStorage.ts +27 -3
  1522. package/src/unstable/cluster/SqlRunnerStorage.ts +46 -7
  1523. package/src/unstable/cluster/TestRunner.ts +18 -1
  1524. package/src/unstable/cluster/internal/hash.ts +12 -0
  1525. package/src/unstable/devtools/DevTools.ts +26 -3
  1526. package/src/unstable/devtools/DevToolsClient.ts +32 -5
  1527. package/src/unstable/devtools/DevToolsSchema.ts +201 -44
  1528. package/src/unstable/devtools/DevToolsServer.ts +27 -2
  1529. package/src/unstable/encoding/Msgpack.ts +97 -12
  1530. package/src/unstable/encoding/Ndjson.ts +149 -21
  1531. package/src/unstable/encoding/Sse.ts +109 -18
  1532. package/src/unstable/eventlog/Event.ts +131 -30
  1533. package/src/unstable/eventlog/EventGroup.ts +50 -17
  1534. package/src/unstable/eventlog/EventJournal.ts +120 -20
  1535. package/src/unstable/eventlog/EventLog.ts +151 -31
  1536. package/src/unstable/eventlog/EventLogEncryption.ts +42 -6
  1537. package/src/unstable/eventlog/EventLogMessage.ts +92 -18
  1538. package/src/unstable/eventlog/EventLogRemote.ts +54 -8
  1539. package/src/unstable/eventlog/EventLogServer.ts +33 -3
  1540. package/src/unstable/eventlog/EventLogServerEncrypted.ts +52 -6
  1541. package/src/unstable/eventlog/EventLogServerUnencrypted.ts +90 -16
  1542. package/src/unstable/eventlog/EventLogSessionAuth.ts +77 -15
  1543. package/src/unstable/eventlog/SqlEventJournal.ts +28 -2
  1544. package/src/unstable/eventlog/SqlEventLogServerEncrypted.ts +32 -3
  1545. package/src/unstable/eventlog/SqlEventLogServerUnencrypted.ts +28 -2
  1546. package/src/unstable/http/Cookies.ts +156 -77
  1547. package/src/unstable/http/Etag.ts +40 -7
  1548. package/src/unstable/http/FetchHttpClient.ts +33 -4
  1549. package/src/unstable/http/FindMyWay.ts +1 -1
  1550. package/src/unstable/http/Headers.ts +252 -50
  1551. package/src/unstable/http/HttpBody.ts +130 -28
  1552. package/src/unstable/http/HttpClient.ts +206 -97
  1553. package/src/unstable/http/HttpClientError.ts +80 -12
  1554. package/src/unstable/http/HttpClientRequest.ts +320 -102
  1555. package/src/unstable/http/HttpClientResponse.ts +59 -16
  1556. package/src/unstable/http/HttpEffect.ts +66 -18
  1557. package/src/unstable/http/HttpIncomingMessage.ts +47 -7
  1558. package/src/unstable/http/HttpMethod.ts +35 -5
  1559. package/src/unstable/http/HttpMiddleware.ts +63 -16
  1560. package/src/unstable/http/HttpPlatform.ts +35 -4
  1561. package/src/unstable/http/HttpRouter.ts +221 -57
  1562. package/src/unstable/http/HttpServer.ts +152 -23
  1563. package/src/unstable/http/HttpServerError.ts +90 -10
  1564. package/src/unstable/http/HttpServerRequest.ts +136 -32
  1565. package/src/unstable/http/HttpServerRespondable.ts +49 -6
  1566. package/src/unstable/http/HttpServerResponse.ts +395 -72
  1567. package/src/unstable/http/HttpStaticServer.ts +22 -4
  1568. package/src/unstable/http/HttpTraceContext.ts +53 -6
  1569. package/src/unstable/http/Multipart.ts +179 -29
  1570. package/src/unstable/http/Multipasta/HeadersParser.ts +1 -1
  1571. package/src/unstable/http/Multipasta/Node.ts +1 -1
  1572. package/src/unstable/http/Multipasta/Search.ts +1 -1
  1573. package/src/unstable/http/Multipasta/Web.ts +1 -1
  1574. package/src/unstable/http/Multipasta.ts +1 -1
  1575. package/src/unstable/http/Template.ts +53 -0
  1576. package/src/unstable/http/Url.ts +56 -42
  1577. package/src/unstable/http/UrlParams.ts +233 -49
  1578. package/src/unstable/httpapi/HttpApi.ts +49 -14
  1579. package/src/unstable/httpapi/HttpApiBuilder.ts +86 -20
  1580. package/src/unstable/httpapi/HttpApiClient.ts +80 -16
  1581. package/src/unstable/httpapi/HttpApiEndpoint.ts +238 -59
  1582. package/src/unstable/httpapi/HttpApiError.ts +100 -1
  1583. package/src/unstable/httpapi/HttpApiGroup.ts +87 -20
  1584. package/src/unstable/httpapi/HttpApiMiddleware.ts +113 -23
  1585. package/src/unstable/httpapi/HttpApiScalar.ts +38 -4
  1586. package/src/unstable/httpapi/HttpApiSchema.ts +67 -30
  1587. package/src/unstable/httpapi/HttpApiSecurity.ts +74 -17
  1588. package/src/unstable/httpapi/HttpApiSwagger.ts +24 -2
  1589. package/src/unstable/httpapi/HttpApiTest.ts +31 -3
  1590. package/src/unstable/httpapi/OpenApi.ts +115 -15
  1591. package/src/unstable/observability/Otlp.ts +33 -3
  1592. package/src/unstable/observability/OtlpExporter.ts +32 -1
  1593. package/src/unstable/observability/OtlpLogger.ts +31 -2
  1594. package/src/unstable/observability/OtlpMetrics.ts +37 -4
  1595. package/src/unstable/observability/OtlpResource.ts +68 -12
  1596. package/src/unstable/observability/OtlpSerialization.ts +28 -3
  1597. package/src/unstable/observability/OtlpTracer.ts +38 -2
  1598. package/src/unstable/observability/PrometheusMetrics.ts +32 -12
  1599. package/src/unstable/observability/index.ts +2 -1
  1600. package/src/unstable/persistence/KeyValueStore.ts +108 -28
  1601. package/src/unstable/persistence/Persistable.ts +76 -15
  1602. package/src/unstable/persistence/PersistedCache.ts +27 -2
  1603. package/src/unstable/persistence/PersistedQueue.ts +98 -16
  1604. package/src/unstable/persistence/Persistence.ts +97 -16
  1605. package/src/unstable/persistence/RateLimiter.ts +98 -22
  1606. package/src/unstable/persistence/Redis.ts +42 -5
  1607. package/src/unstable/process/ChildProcess.ts +100 -79
  1608. package/src/unstable/process/ChildProcessSpawner.ts +22 -11
  1609. package/src/unstable/process/index.ts +2 -1
  1610. package/src/unstable/reactivity/AsyncResult.ts +202 -61
  1611. package/src/unstable/reactivity/Atom.ts +597 -143
  1612. package/src/unstable/reactivity/AtomHttpApi.ts +41 -2
  1613. package/src/unstable/reactivity/AtomRef.ts +51 -7
  1614. package/src/unstable/reactivity/AtomRegistry.ts +141 -22
  1615. package/src/unstable/reactivity/AtomRpc.ts +36 -2
  1616. package/src/unstable/reactivity/Hydration.ts +45 -5
  1617. package/src/unstable/reactivity/Reactivity.ts +95 -13
  1618. package/src/unstable/rpc/Rpc.ts +255 -56
  1619. package/src/unstable/rpc/RpcClient.ts +108 -20
  1620. package/src/unstable/rpc/RpcClientError.ts +26 -2
  1621. package/src/unstable/rpc/RpcGroup.ts +51 -8
  1622. package/src/unstable/rpc/RpcMessage.ts +128 -32
  1623. package/src/unstable/rpc/RpcMiddleware.ts +100 -20
  1624. package/src/unstable/rpc/RpcSchema.ts +38 -4
  1625. package/src/unstable/rpc/RpcSerialization.ts +60 -13
  1626. package/src/unstable/rpc/RpcServer.ts +108 -25
  1627. package/src/unstable/rpc/RpcTest.ts +20 -1
  1628. package/src/unstable/rpc/RpcWorker.ts +42 -8
  1629. package/src/unstable/rpc/Utils.ts +31 -0
  1630. package/src/unstable/schema/Model.ts +148 -52
  1631. package/src/unstable/schema/VariantSchema.ts +104 -24
  1632. package/src/unstable/socket/Socket.ts +168 -35
  1633. package/src/unstable/socket/SocketServer.ts +58 -10
  1634. package/src/unstable/sql/Migrator.ts +57 -5
  1635. package/src/unstable/sql/SqlClient.ts +55 -2
  1636. package/src/unstable/sql/SqlConnection.ts +31 -0
  1637. package/src/unstable/sql/SqlError.ts +117 -0
  1638. package/src/unstable/sql/SqlModel.ts +26 -5
  1639. package/src/unstable/sql/SqlResolver.ts +56 -13
  1640. package/src/unstable/sql/SqlSchema.ts +29 -8
  1641. package/src/unstable/sql/SqlStream.ts +23 -0
  1642. package/src/unstable/sql/Statement.ts +141 -0
  1643. package/src/unstable/sql/index.ts +1 -1
  1644. package/src/unstable/workers/Transferable.ts +65 -13
  1645. package/src/unstable/workers/Worker.ts +60 -8
  1646. package/src/unstable/workers/WorkerError.ts +50 -9
  1647. package/src/unstable/workers/WorkerRunner.ts +32 -3
  1648. package/src/unstable/workers/index.ts +1 -1
  1649. package/src/unstable/workflow/Activity.ts +62 -11
  1650. package/src/unstable/workflow/DurableClock.ts +26 -3
  1651. package/src/unstable/workflow/DurableDeferred.ts +146 -31
  1652. package/src/unstable/workflow/DurableQueue.ts +366 -0
  1653. package/src/unstable/workflow/Workflow.ts +122 -32
  1654. package/src/unstable/workflow/WorkflowEngine.ts +40 -5
  1655. package/src/unstable/workflow/WorkflowProxy.ts +32 -2
  1656. package/src/unstable/workflow/WorkflowProxyServer.ts +40 -6
  1657. package/src/unstable/workflow/index.ts +5 -0
package/src/Schema.ts CHANGED
@@ -251,6 +251,8 @@ export interface Bottom<
251
251
  check(...checks: readonly [AST.Check<this["Type"]>, ...Array<AST.Check<this["Type"]>>]): this["Rebuild"]
252
252
  rebuild(ast: this["ast"]): this["Rebuild"]
253
253
  /**
254
+ * Constructs a value from the make input representation.
255
+ *
254
256
  * @throws {Error} The issue is contained in the error cause.
255
257
  */
256
258
  make(input: this["~type.make.in"], options?: MakeOptions): this["Type"]
@@ -1137,12 +1139,14 @@ export const asserts = Parser.asserts
1137
1139
  * succeeds with the decoded value or fails with a {@link SchemaError}. Use this
1138
1140
  * when the input type is not statically known. Prefer {@link decodeEffect} when
1139
1141
  * the input is already typed as the schema's `Encoded` type.
1142
+ * Options may be provided either when creating the decoder or when applying it;
1143
+ * application options override creation options.
1140
1144
  *
1141
1145
  * @category Decoding
1142
1146
  * @since 4.0.0
1143
1147
  */
1144
- export function decodeUnknownEffect<S extends Top>(schema: S) {
1145
- const parser = Parser.decodeUnknownEffect(schema)
1148
+ export function decodeUnknownEffect<S extends Top>(schema: S, options?: AST.ParseOptions) {
1149
+ const parser = Parser.decodeUnknownEffect(schema, options)
1146
1150
  return (input: unknown, options?: AST.ParseOptions): Effect.Effect<S["Type"], SchemaError, S["DecodingServices"]> => {
1147
1151
  return Effect.mapErrorEager(parser(input, options), (issue) => new SchemaError(issue))
1148
1152
  }
@@ -1153,12 +1157,15 @@ export function decodeUnknownEffect<S extends Top>(schema: S) {
1153
1157
  * returning an `Effect` that succeeds with the decoded value or fails with a
1154
1158
  * {@link SchemaError}. Use this when the input is already typed; for `unknown`
1155
1159
  * input use {@link decodeUnknownEffect}.
1160
+ * Options may be provided either when creating the decoder or when applying it;
1161
+ * application options override creation options.
1156
1162
  *
1157
1163
  * @category Decoding
1158
1164
  * @since 4.0.0
1159
1165
  */
1160
1166
  export const decodeEffect: <S extends Top>(
1161
- schema: S
1167
+ schema: S,
1168
+ options?: AST.ParseOptions
1162
1169
  ) => (input: S["Encoded"], options?: AST.ParseOptions) => Effect.Effect<S["Type"], SchemaError, S["DecodingServices"]> =
1163
1170
  decodeUnknownEffect
1164
1171
 
@@ -1168,12 +1175,14 @@ export const decodeEffect: <S extends Top>(
1168
1175
  * a {@link SchemaError}. Only usable with schemas that have no
1169
1176
  * `DecodingServices` requirement. Prefer {@link decodeExit} when the input is
1170
1177
  * already typed as the schema's `Encoded` type.
1178
+ * Options may be provided either when creating the decoder or when applying it;
1179
+ * application options override creation options.
1171
1180
  *
1172
1181
  * @category Decoding
1173
1182
  * @since 4.0.0
1174
1183
  */
1175
- export function decodeUnknownExit<S extends Decoder<unknown>>(schema: S) {
1176
- const parser = Parser.decodeUnknownExit(schema)
1184
+ export function decodeUnknownExit<S extends Decoder<unknown>>(schema: S, options?: AST.ParseOptions) {
1185
+ const parser = Parser.decodeUnknownExit(schema, options)
1177
1186
  return (input: unknown, options?: AST.ParseOptions): Exit_.Exit<S["Type"], SchemaError> => {
1178
1187
  return Exit_.mapError(parser(input, options), (issue) => new SchemaError(issue))
1179
1188
  }
@@ -1185,12 +1194,15 @@ export function decodeUnknownExit<S extends Decoder<unknown>>(schema: S) {
1185
1194
  * decoded value or a `Failure` with a {@link SchemaError}. Only usable with
1186
1195
  * schemas that have no `DecodingServices` requirement. For `unknown` input use
1187
1196
  * {@link decodeUnknownExit}.
1197
+ * Options may be provided either when creating the decoder or when applying it;
1198
+ * application options override creation options.
1188
1199
  *
1189
1200
  * @category Decoding
1190
1201
  * @since 4.0.0
1191
1202
  */
1192
1203
  export const decodeExit: <S extends Decoder<unknown>>(
1193
- schema: S
1204
+ schema: S,
1205
+ options?: AST.ParseOptions
1194
1206
  ) => (input: S["Encoded"], options?: AST.ParseOptions) => Exit_.Exit<S["Type"], SchemaError> = decodeUnknownExit
1195
1207
 
1196
1208
  /**
@@ -1199,6 +1211,8 @@ export const decodeExit: <S extends Decoder<unknown>>(
1199
1211
  * over {@link decodeUnknownExit} or {@link decodeUnknownEffect} when you only
1200
1212
  * need to know whether decoding succeeded and don't need error details. For
1201
1213
  * typed input use {@link decodeOption}.
1214
+ * Options may be provided either when creating the decoder or when applying it;
1215
+ * application options override creation options.
1202
1216
  *
1203
1217
  * @category Decoding
1204
1218
  * @since 4.0.0
@@ -1209,6 +1223,8 @@ export const decodeUnknownOption = Parser.decodeUnknownOption
1209
1223
  * Decodes a typed input (the schema's `Encoded` type) against a schema,
1210
1224
  * returning an `Option` that is `Some` with the decoded value on success or
1211
1225
  * `None` on failure. For `unknown` input use {@link decodeUnknownOption}.
1226
+ * Options may be provided either when creating the decoder or when applying it;
1227
+ * application options override creation options.
1212
1228
  *
1213
1229
  * @category Decoding
1214
1230
  * @since 4.0.0
@@ -1216,10 +1232,11 @@ export const decodeUnknownOption = Parser.decodeUnknownOption
1216
1232
  export const decodeOption = Parser.decodeOption
1217
1233
 
1218
1234
  /**
1219
- * Decodes an `unknown` input against a schema, returning a `Promise` that
1220
- * resolves with the decoded value or rejects with a {@link SchemaError}. Useful
1221
- * for integrating with Promise-based APIs. For typed input use
1222
- * {@link decodePromise}.
1235
+ * Decodes an `unknown` input against a schema, returning a `Result` that
1236
+ * succeeds with the decoded value or fails with a schema issue. For typed input
1237
+ * use {@link decodeResult}.
1238
+ * Options may be provided either when creating the decoder or when applying it;
1239
+ * application options override creation options.
1223
1240
  *
1224
1241
  * @category Decoding
1225
1242
  * @since 4.0.0
@@ -1227,12 +1244,25 @@ export const decodeOption = Parser.decodeOption
1227
1244
  export const decodeUnknownResult = Parser.decodeUnknownResult
1228
1245
 
1229
1246
  /**
1247
+ * Decodes a typed input (the schema's `Encoded` type) against a schema,
1248
+ * returning a `Result` that succeeds with the decoded value or fails with a
1249
+ * schema issue. For `unknown` input use {@link decodeUnknownResult}.
1250
+ * Options may be provided either when creating the decoder or when applying it;
1251
+ * application options override creation options.
1252
+ *
1230
1253
  * @category Decoding
1231
1254
  * @since 4.0.0
1232
1255
  */
1233
1256
  export const decodeResult = Parser.decodeResult
1234
1257
 
1235
1258
  /**
1259
+ * Decodes an `unknown` input against a schema, returning a `Promise` that
1260
+ * resolves with the decoded value or rejects with a schema issue. Useful for
1261
+ * integrating with Promise-based APIs. For typed input use
1262
+ * {@link decodePromise}.
1263
+ * Options may be provided either when creating the decoder or when applying it;
1264
+ * application options override creation options.
1265
+ *
1236
1266
  * @category Decoding
1237
1267
  * @since 4.0.0
1238
1268
  */
@@ -1241,7 +1271,11 @@ export const decodeUnknownPromise = Parser.decodeUnknownPromise
1241
1271
  /**
1242
1272
  * Decodes a typed input (the schema's `Encoded` type) against a schema,
1243
1273
  * returning a `Promise` that resolves with the decoded value or rejects with a
1244
- * {@link SchemaError}. For `unknown` input use {@link decodeUnknownPromise}.
1274
+ * schema issue. For `unknown` input use `decodeUnknownPromise`.
1275
+ *
1276
+ * **Details**
1277
+ * Options may be provided either when creating the decoder or when applying it;
1278
+ * application options override creation options.
1245
1279
  *
1246
1280
  * @category Decoding
1247
1281
  * @since 4.0.0
@@ -1249,12 +1283,16 @@ export const decodeUnknownPromise = Parser.decodeUnknownPromise
1249
1283
  export const decodePromise = Parser.decodePromise
1250
1284
 
1251
1285
  /**
1252
- * Decodes an `unknown` input against a schema synchronously, throwing a
1253
- * {@link SchemaError} on failure. Use this when you want to validate data at a
1254
- * boundary and treat a schema mismatch as an unrecoverable error. For
1255
- * non-throwing alternatives see {@link decodeUnknownOption},
1256
- * {@link decodeUnknownExit}, or {@link decodeUnknownEffect}. For typed input
1257
- * use {@link decodeSync}.
1286
+ * Decodes an `unknown` input against a schema synchronously, returning the
1287
+ * decoded value or throwing an `Error` whose cause contains the schema issue.
1288
+ * Use this when you want to validate data at a boundary and treat a schema
1289
+ * mismatch as an exception. For typed input use `decodeSync`.
1290
+ *
1291
+ * **Details**
1292
+ * Only service-free schemas can be decoded synchronously. For non-throwing
1293
+ * alternatives see `decodeUnknownOption`, `decodeUnknownExit`, or
1294
+ * `decodeUnknownEffect`. Options may be provided either when creating the
1295
+ * decoder or when applying it; application options override creation options.
1258
1296
  *
1259
1297
  * **Example** (Decoding with a transformation schema)
1260
1298
  *
@@ -1280,8 +1318,13 @@ export const decodeUnknownSync = Parser.decodeUnknownSync
1280
1318
 
1281
1319
  /**
1282
1320
  * Decodes a typed input (the schema's `Encoded` type) against a schema
1283
- * synchronously, throwing a {@link SchemaError} on failure. For `unknown` input
1284
- * use {@link decodeUnknownSync}.
1321
+ * synchronously, returning the decoded value or throwing an `Error` whose cause
1322
+ * contains the schema issue. For `unknown` input use `decodeUnknownSync`.
1323
+ *
1324
+ * **Details**
1325
+ * Only service-free schemas can be decoded synchronously. Options may be
1326
+ * provided either when creating the decoder or when applying it; application
1327
+ * options override creation options.
1285
1328
  *
1286
1329
  * @category Decoding
1287
1330
  * @since 4.0.0
@@ -1293,6 +1336,8 @@ export const decodeSync = Parser.decodeSync
1293
1336
  * succeeds with the encoded value or fails with a {@link SchemaError}. Use this
1294
1337
  * when the input type is not statically known. Prefer {@link encodeEffect} when
1295
1338
  * the input is already typed as the schema's `Type`.
1339
+ * Options may be provided either when creating the encoder or when applying it;
1340
+ * application options override creation options.
1296
1341
  *
1297
1342
  * **Example** (Encoding a value to a string)
1298
1343
  *
@@ -1308,8 +1353,8 @@ export const decodeSync = Parser.decodeSync
1308
1353
  * @category Encoding
1309
1354
  * @since 4.0.0
1310
1355
  */
1311
- export function encodeUnknownEffect<S extends Top>(schema: S) {
1312
- const parser = Parser.encodeUnknownEffect(schema)
1356
+ export function encodeUnknownEffect<S extends Top>(schema: S, options?: AST.ParseOptions) {
1357
+ const parser = Parser.encodeUnknownEffect(schema, options)
1313
1358
  return (
1314
1359
  input: unknown,
1315
1360
  options?: AST.ParseOptions
@@ -1323,12 +1368,15 @@ export function encodeUnknownEffect<S extends Top>(schema: S) {
1323
1368
  * `Effect` that succeeds with the encoded value or fails with a
1324
1369
  * {@link SchemaError}. Use this when the input is already typed; for `unknown`
1325
1370
  * input use {@link encodeUnknownEffect}.
1371
+ * Options may be provided either when creating the encoder or when applying it;
1372
+ * application options override creation options.
1326
1373
  *
1327
1374
  * @category Encoding
1328
1375
  * @since 4.0.0
1329
1376
  */
1330
1377
  export const encodeEffect: <S extends Top>(
1331
- schema: S
1378
+ schema: S,
1379
+ options?: AST.ParseOptions
1332
1380
  ) => (input: S["Type"], options?: AST.ParseOptions) => Effect.Effect<S["Encoded"], SchemaError, S["EncodingServices"]> =
1333
1381
  encodeUnknownEffect
1334
1382
 
@@ -1338,12 +1386,14 @@ export const encodeEffect: <S extends Top>(
1338
1386
  * a {@link SchemaError}. Only usable with schemas that have no
1339
1387
  * `EncodingServices` requirement. Prefer {@link encodeExit} when the input is
1340
1388
  * already typed as the schema's `Type`.
1389
+ * Options may be provided either when creating the encoder or when applying it;
1390
+ * application options override creation options.
1341
1391
  *
1342
1392
  * @category Encoding
1343
1393
  * @since 4.0.0
1344
1394
  */
1345
- export function encodeUnknownExit<S extends Encoder<unknown>>(schema: S) {
1346
- const parser = Parser.encodeUnknownExit(schema)
1395
+ export function encodeUnknownExit<S extends Encoder<unknown>>(schema: S, options?: AST.ParseOptions) {
1396
+ const parser = Parser.encodeUnknownExit(schema, options)
1347
1397
  return (input: unknown, options?: AST.ParseOptions): Exit_.Exit<S["Encoded"], SchemaError> => {
1348
1398
  return Exit_.mapError(parser(input, options), (issue) => new SchemaError(issue))
1349
1399
  }
@@ -1355,12 +1405,15 @@ export function encodeUnknownExit<S extends Encoder<unknown>>(schema: S) {
1355
1405
  * `Failure` with a {@link SchemaError}. Only usable with schemas that have no
1356
1406
  * `EncodingServices` requirement. For `unknown` input use
1357
1407
  * {@link encodeUnknownExit}.
1408
+ * Options may be provided either when creating the encoder or when applying it;
1409
+ * application options override creation options.
1358
1410
  *
1359
1411
  * @category Encoding
1360
1412
  * @since 4.0.0
1361
1413
  */
1362
1414
  export const encodeExit: <S extends Encoder<unknown>>(
1363
- schema: S
1415
+ schema: S,
1416
+ options?: AST.ParseOptions
1364
1417
  ) => (input: S["Type"], options?: AST.ParseOptions) => Exit_.Exit<S["Encoded"], SchemaError> = encodeUnknownExit
1365
1418
 
1366
1419
  /**
@@ -1369,6 +1422,8 @@ export const encodeExit: <S extends Encoder<unknown>>(
1369
1422
  * over {@link encodeUnknownExit} or {@link encodeUnknownEffect} when you only
1370
1423
  * need to know whether encoding succeeded and don't need error details. For
1371
1424
  * typed input use {@link encodeOption}.
1425
+ * Options may be provided either when creating the encoder or when applying it;
1426
+ * application options override creation options.
1372
1427
  *
1373
1428
  * @category Encoding
1374
1429
  * @since 4.0.0
@@ -1379,6 +1434,8 @@ export const encodeUnknownOption = Parser.encodeUnknownOption
1379
1434
  * Encodes a typed input (the schema's `Type`) against a schema, returning an
1380
1435
  * `Option` that is `Some` with the encoded value on success or `None` on
1381
1436
  * failure. For `unknown` input use {@link encodeUnknownOption}.
1437
+ * Options may be provided either when creating the encoder or when applying it;
1438
+ * application options override creation options.
1382
1439
  *
1383
1440
  * @category Encoding
1384
1441
  * @since 4.0.0
@@ -1386,10 +1443,11 @@ export const encodeUnknownOption = Parser.encodeUnknownOption
1386
1443
  export const encodeOption = Parser.encodeOption
1387
1444
 
1388
1445
  /**
1389
- * Encodes an `unknown` input against a schema, returning a `Promise` that
1390
- * resolves with the encoded value or rejects with a {@link SchemaError}. Useful
1391
- * for integrating with Promise-based APIs. For typed input use
1392
- * {@link encodePromise}.
1446
+ * Encodes an `unknown` input against a schema, returning a `Result` that
1447
+ * succeeds with the encoded value or fails with a schema issue. For typed input
1448
+ * use {@link encodeResult}.
1449
+ * Options may be provided either when creating the encoder or when applying it;
1450
+ * application options override creation options.
1393
1451
  *
1394
1452
  * @category Encoding
1395
1453
  * @since 4.0.0
@@ -1397,12 +1455,25 @@ export const encodeOption = Parser.encodeOption
1397
1455
  export const encodeUnknownResult = Parser.encodeUnknownResult
1398
1456
 
1399
1457
  /**
1458
+ * Encodes a typed input (the schema's `Type`) against a schema, returning a
1459
+ * `Result` that succeeds with the encoded value or fails with a schema issue.
1460
+ * For `unknown` input use {@link encodeUnknownResult}.
1461
+ * Options may be provided either when creating the encoder or when applying it;
1462
+ * application options override creation options.
1463
+ *
1400
1464
  * @category Encoding
1401
1465
  * @since 4.0.0
1402
1466
  */
1403
1467
  export const encodeResult = Parser.encodeResult
1404
1468
 
1405
1469
  /**
1470
+ * Encodes an `unknown` input against a schema, returning a `Promise` that
1471
+ * resolves with the encoded value or rejects with a schema issue. Useful for
1472
+ * integrating with Promise-based APIs. For typed input use
1473
+ * {@link encodePromise}.
1474
+ * Options may be provided either when creating the encoder or when applying it;
1475
+ * application options override creation options.
1476
+ *
1406
1477
  * @category Encoding
1407
1478
  * @since 4.0.0
1408
1479
  */
@@ -1412,6 +1483,8 @@ export const encodeUnknownPromise = Parser.encodeUnknownPromise
1412
1483
  * Encodes a typed input (the schema's `Type`) against a schema, returning a
1413
1484
  * `Promise` that resolves with the encoded value or rejects with a
1414
1485
  * {@link SchemaError}. For `unknown` input use {@link encodeUnknownPromise}.
1486
+ * Options may be provided either when creating the encoder or when applying it;
1487
+ * application options override creation options.
1415
1488
  *
1416
1489
  * @category Encoding
1417
1490
  * @since 4.0.0
@@ -1425,6 +1498,8 @@ export const encodePromise = Parser.encodePromise
1425
1498
  * non-throwing alternatives see {@link encodeUnknownOption},
1426
1499
  * {@link encodeUnknownExit}, or {@link encodeUnknownEffect}. For typed input
1427
1500
  * use {@link encodeSync}.
1501
+ * Options may be provided either when creating the encoder or when applying it;
1502
+ * application options override creation options.
1428
1503
  *
1429
1504
  * @category Encoding
1430
1505
  * @since 4.0.0
@@ -1435,6 +1510,8 @@ export const encodeUnknownSync = Parser.encodeUnknownSync
1435
1510
  * Encodes a typed input (the schema's `Type`) against a schema synchronously,
1436
1511
  * throwing a {@link SchemaError} on failure. For `unknown` input use
1437
1512
  * {@link encodeUnknownSync}.
1513
+ * Options may be provided either when creating the encoder or when applying it;
1514
+ * application options override creation options.
1438
1515
  *
1439
1516
  * @category Encoding
1440
1517
  * @since 4.0.0
@@ -1860,6 +1937,12 @@ export function Literal<L extends AST.LiteralValue>(literal: L): Literal<L> {
1860
1937
  */
1861
1938
  export declare namespace TemplateLiteral {
1862
1939
  /**
1940
+ * Constraint for schema parts that can appear inside a `TemplateLiteral`.
1941
+ *
1942
+ * **Details**
1943
+ * The schema's encoded value must be a `string`, `number`, or `bigint` so it can
1944
+ * be converted into a template literal string segment.
1945
+ *
1863
1946
  * @since 4.0.0
1864
1947
  */
1865
1948
  export interface SchemaPart extends Top {
@@ -1867,16 +1950,23 @@ export declare namespace TemplateLiteral {
1867
1950
  }
1868
1951
 
1869
1952
  /**
1953
+ * Literal value that can be used directly as a part of a `TemplateLiteral`.
1954
+ *
1870
1955
  * @since 4.0.0
1871
1956
  */
1872
1957
  export type LiteralPart = string | number | bigint
1873
1958
 
1874
1959
  /**
1960
+ * A single part of a `TemplateLiteral`, either an interpolated schema part or a
1961
+ * literal `string`, `number`, or `bigint`.
1962
+ *
1875
1963
  * @since 4.0.0
1876
1964
  */
1877
1965
  export type Part = SchemaPart | LiteralPart
1878
1966
 
1879
1967
  /**
1968
+ * Ordered list of parts used to construct a `TemplateLiteral` schema.
1969
+ *
1880
1970
  * @since 4.0.0
1881
1971
  */
1882
1972
  export type Parts = ReadonlyArray<Part>
@@ -1889,6 +1979,9 @@ export declare namespace TemplateLiteral {
1889
1979
  : never
1890
1980
 
1891
1981
  /**
1982
+ * Computes the encoded string literal type produced by concatenating the encoded
1983
+ * forms of all template literal parts.
1984
+ *
1892
1985
  * @since 4.0.0
1893
1986
  */
1894
1987
  export type Encoded<Parts> = Parts extends readonly [...infer Init, infer Last] ? AppendType<Encoded<Init>, Last>
@@ -1945,6 +2038,12 @@ export function TemplateLiteral<const Parts extends TemplateLiteral.Parts>(parts
1945
2038
  */
1946
2039
  export declare namespace TemplateLiteralParser {
1947
2040
  /**
2041
+ * Computes the decoded tuple type produced by `TemplateLiteralParser`.
2042
+ *
2043
+ * **Details**
2044
+ * Literal parts contribute their literal value to the tuple. Schema parts
2045
+ * contribute their decoded `Type`.
2046
+ *
1948
2047
  * @since 4.0.0
1949
2048
  */
1950
2049
  export type Type<Parts> = Parts extends readonly [infer Head, ...infer Tail] ? readonly [
@@ -1998,8 +2097,8 @@ export function TemplateLiteralParser<const Parts extends TemplateLiteral.Parts>
1998
2097
  }
1999
2098
 
2000
2099
  /**
2001
- * Represents a schema derived from a TypeScript `const enum` or a plain enum object,
2002
- * accepting any of its values.
2100
+ * Represents a schema derived from a TypeScript enum object or an enum-like
2101
+ * `as const` object, accepting any of its values.
2003
2102
  *
2004
2103
  * @see {@link Enum} for the constructor function.
2005
2104
  * @since 4.0.0
@@ -2298,12 +2397,18 @@ export declare namespace Struct {
2298
2397
  O extends keyof F = TypeOptionalKeys<F>,
2299
2398
  M extends keyof F = TypeMutableKeys<F>
2300
2399
  > =
2301
- & { readonly [K in Exclude<keyof F, M | O>]: F[K]["Type"] }
2302
- & { readonly [K in Exclude<O, M>]?: F[K]["Type"] }
2303
- & { [K in Exclude<M, O>]: F[K]["Type"] }
2304
- & { [K in M & O]?: F[K]["Type"] }
2400
+ & { readonly [K in keyof F as K extends M | O ? never : K]: F[K]["Type"] }
2401
+ & { readonly [K in keyof F as K extends O ? K extends M ? never : K : never]?: F[K]["Type"] }
2402
+ & { -readonly [K in keyof F as K extends M ? K extends O ? never : K : never]: F[K]["Type"] }
2403
+ & { -readonly [K in keyof F as K extends M & O ? K : never]?: F[K]["Type"] }
2305
2404
 
2306
2405
  /**
2406
+ * Computes the decoded object type for a struct field map.
2407
+ *
2408
+ * **Details**
2409
+ * Field schemas contribute their decoded `Type`. `optionalKey` and `optional`
2410
+ * produce optional properties, while `mutableKey` produces writable properties.
2411
+ *
2307
2412
  * @since 4.0.0
2308
2413
  */
2309
2414
  export type Type<F extends Fields> = Simplify<Type_<F>>
@@ -2313,12 +2418,19 @@ export declare namespace Struct {
2313
2418
  O extends keyof F = TypeOptionalKeys<F>,
2314
2419
  M extends keyof F = TypeMutableKeys<F>
2315
2420
  > =
2316
- & { readonly [K in Exclude<keyof F, M | O>]: F[K]["Iso"] }
2317
- & { readonly [K in Exclude<O, M>]?: F[K]["Iso"] }
2318
- & { [K in Exclude<M, O>]: F[K]["Iso"] }
2319
- & { [K in M & O]?: F[K]["Iso"] }
2421
+ & { readonly [K in keyof F as K extends M | O ? never : K]: F[K]["Iso"] }
2422
+ & { readonly [K in keyof F as K extends O ? K extends M ? never : K : never]?: F[K]["Iso"] }
2423
+ & { -readonly [K in keyof F as K extends M ? K extends O ? never : K : never]: F[K]["Iso"] }
2424
+ & { -readonly [K in keyof F as K extends M & O ? K : never]?: F[K]["Iso"] }
2320
2425
 
2321
2426
  /**
2427
+ * Computes the iso object type for a struct field map from each field schema's
2428
+ * `Iso` type.
2429
+ *
2430
+ * **Details**
2431
+ * The resulting property optionality and mutability follow the same field
2432
+ * modifiers used by `Struct.Type`.
2433
+ *
2322
2434
  * @since 4.0.0
2323
2435
  */
2324
2436
  export type Iso<F extends Fields> = Simplify<Iso_<F>>
@@ -2338,22 +2450,35 @@ export declare namespace Struct {
2338
2450
  O extends keyof F = EncodedOptionalKeys<F>,
2339
2451
  M extends keyof F = EncodedMutableKeys<F>
2340
2452
  > =
2341
- & { readonly [K in Exclude<keyof F, M | O>]: F[K]["Encoded"] }
2342
- & { readonly [K in Exclude<O, M>]?: F[K]["Encoded"] }
2343
- & { [K in Exclude<M, O>]: F[K]["Encoded"] }
2344
- & { [K in M & O]?: F[K]["Encoded"] }
2453
+ & { readonly [K in keyof F as K extends M | O ? never : K]: F[K]["Encoded"] }
2454
+ & { readonly [K in keyof F as K extends O ? K extends M ? never : K : never]?: F[K]["Encoded"] }
2455
+ & { -readonly [K in keyof F as K extends M ? K extends O ? never : K : never]: F[K]["Encoded"] }
2456
+ & { -readonly [K in keyof F as K extends M & O ? K : never]?: F[K]["Encoded"] }
2345
2457
 
2346
2458
  /**
2459
+ * Computes the encoded object type for a struct field map.
2460
+ *
2461
+ * **Details**
2462
+ * Field schemas contribute their `Encoded` type. Encoded-side optionality and
2463
+ * mutability modifiers determine whether properties are optional or writable in
2464
+ * the encoded shape.
2465
+ *
2347
2466
  * @since 4.0.0
2348
2467
  */
2349
2468
  export type Encoded<F extends Fields> = Simplify<Encoded_<F>>
2350
2469
 
2351
2470
  /**
2471
+ * Union of all decoding service requirements needed by the schemas in a struct
2472
+ * field map.
2473
+ *
2352
2474
  * @since 4.0.0
2353
2475
  */
2354
2476
  export type DecodingServices<F extends Fields> = { readonly [K in keyof F]: F[K]["DecodingServices"] }[keyof F]
2355
2477
 
2356
2478
  /**
2479
+ * Union of all encoding service requirements needed by the schemas in a struct
2480
+ * field map.
2481
+ *
2357
2482
  * @since 4.0.0
2358
2483
  */
2359
2484
  export type EncodingServices<F extends Fields> = { readonly [K in keyof F]: F[K]["EncodingServices"] }[keyof F]
@@ -2371,12 +2496,25 @@ export declare namespace Struct {
2371
2496
  & { readonly [K in keyof F as K extends O ? K : never]?: F[K]["~type.make"] }
2372
2497
 
2373
2498
  /**
2499
+ * Computes the input object type accepted when constructing a struct value.
2500
+ *
2501
+ * **Details**
2502
+ * Required fields use each field schema's `~type.make` input. Fields marked
2503
+ * optional or with a constructor default may be omitted.
2504
+ *
2374
2505
  * @since 4.0.0
2375
2506
  */
2376
2507
  export type MakeIn<F extends Fields> = Simplify<MakeIn_<F>>
2377
2508
  }
2378
2509
 
2379
2510
  /**
2511
+ * Schema type returned by `Schema.Struct` for an object with a fixed set of
2512
+ * schema-defined fields.
2513
+ *
2514
+ * **Details**
2515
+ * The `fields` property exposes the original field map for reuse, and
2516
+ * `mapFields` creates a new struct schema by transforming that field map.
2517
+ *
2380
2518
  * @since 4.0.0
2381
2519
  */
2382
2520
  export interface Struct<Fields extends Struct.Fields> extends
@@ -2666,6 +2804,12 @@ export function extendTo<S extends Struct<Struct.Fields>, const Fields extends S
2666
2804
  */
2667
2805
  export declare namespace Record {
2668
2806
  /**
2807
+ * Constraint for schemas that can be used as record keys.
2808
+ *
2809
+ * **Details**
2810
+ * The key schema must decode and encode property keys (`string`, `number`, or
2811
+ * `symbol`) so it can describe object property names.
2812
+ *
2669
2813
  * @since 4.0.0
2670
2814
  */
2671
2815
  export interface Key extends Codec<PropertyKey, PropertyKey, unknown, unknown> {
@@ -2674,6 +2818,14 @@ export declare namespace Record {
2674
2818
  }
2675
2819
 
2676
2820
  /**
2821
+ * Computes the decoded object type for a record schema from its key and value
2822
+ * schemas.
2823
+ *
2824
+ * **Details**
2825
+ * The key schema supplies the property keys and the value schema supplies each
2826
+ * property's decoded `Type`. Optional and mutable value schemas affect the
2827
+ * resulting property optionality and writability.
2828
+ *
2677
2829
  * @since 4.0.0
2678
2830
  */
2679
2831
  export type Type<Key extends Record.Key, Value extends Top> = Value extends
@@ -2684,6 +2836,9 @@ export declare namespace Record {
2684
2836
  : { readonly [P in Key["Type"]]: Value["Type"] }
2685
2837
 
2686
2838
  /**
2839
+ * Computes the iso object type for a record schema from the key schema's `Iso`
2840
+ * keys and the value schema's `Iso` values.
2841
+ *
2687
2842
  * @since 4.0.0
2688
2843
  */
2689
2844
  export type Iso<Key extends Record.Key, Value extends Top> = Value extends
@@ -2694,6 +2849,13 @@ export declare namespace Record {
2694
2849
  : { readonly [P in Key["Iso"]]: Value["Iso"] }
2695
2850
 
2696
2851
  /**
2852
+ * Computes the encoded object type for a record schema from the key and value
2853
+ * schemas' encoded types.
2854
+ *
2855
+ * **Details**
2856
+ * Encoded-side optionality and mutability on the value schema determine whether
2857
+ * the encoded record properties are optional or writable.
2858
+ *
2697
2859
  * @since 4.0.0
2698
2860
  */
2699
2861
  export type Encoded<Key extends Record.Key, Value extends Top> = Value extends
@@ -2704,6 +2866,9 @@ export declare namespace Record {
2704
2866
  : { readonly [P in Key["Encoded"]]: Value["Encoded"] }
2705
2867
 
2706
2868
  /**
2869
+ * Union of the decoding service requirements of a record's key schema and value
2870
+ * schema.
2871
+ *
2707
2872
  * @since 4.0.0
2708
2873
  */
2709
2874
  export type DecodingServices<Key extends Record.Key, Value extends Top> =
@@ -2711,6 +2876,9 @@ export declare namespace Record {
2711
2876
  | Value["DecodingServices"]
2712
2877
 
2713
2878
  /**
2879
+ * Union of the encoding service requirements of a record's key schema and value
2880
+ * schema.
2881
+ *
2714
2882
  * @since 4.0.0
2715
2883
  */
2716
2884
  export type EncodingServices<Key extends Record.Key, Value extends Top> =
@@ -2718,6 +2886,13 @@ export declare namespace Record {
2718
2886
  | Value["EncodingServices"]
2719
2887
 
2720
2888
  /**
2889
+ * Computes the input object type accepted when constructing a record value.
2890
+ *
2891
+ * **Details**
2892
+ * Keys use the key schema's `~type.make` type and values use the value schema's
2893
+ * `~type.make` type. Value optionality and mutability determine whether
2894
+ * properties are optional or writable.
2895
+ *
2721
2896
  * @since 4.0.0
2722
2897
  */
2723
2898
  export type MakeIn<Key extends Record.Key, Value extends Top> = Value extends
@@ -2797,11 +2972,17 @@ export function Record<Key extends Record.Key, Value extends Top>(
2797
2972
  */
2798
2973
  export declare namespace StructWithRest {
2799
2974
  /**
2975
+ * Constraint for object-like schemas that can be used as the fixed portion of a
2976
+ * `StructWithRest` schema.
2977
+ *
2800
2978
  * @since 4.0.0
2801
2979
  */
2802
2980
  export type Objects = Top & { readonly ast: AST.Objects }
2803
2981
 
2804
2982
  /**
2983
+ * Readonly list of record schemas that provide the additional index signatures
2984
+ * for a `StructWithRest` schema.
2985
+ *
2805
2986
  * @since 4.0.0
2806
2987
  */
2807
2988
  export type Records = ReadonlyArray<$Record<Record.Key, Top>>
@@ -2811,6 +2992,9 @@ export declare namespace StructWithRest {
2811
2992
  : {}
2812
2993
 
2813
2994
  /**
2995
+ * Computes the decoded type for `StructWithRest` by intersecting the base object
2996
+ * schema's decoded `Type` with the decoded types of all rest record schemas.
2997
+ *
2814
2998
  * @since 4.0.0
2815
2999
  */
2816
3000
  export type Type<S extends Objects, Records extends StructWithRest.Records> =
@@ -2818,6 +3002,9 @@ export declare namespace StructWithRest {
2818
3002
  & MergeTuple<{ readonly [K in keyof Records]: Records[K]["Type"] }>
2819
3003
 
2820
3004
  /**
3005
+ * Computes the iso type for `StructWithRest` by intersecting the base object
3006
+ * schema's `Iso` type with the `Iso` types of all rest record schemas.
3007
+ *
2821
3008
  * @since 4.0.0
2822
3009
  */
2823
3010
  export type Iso<S extends Objects, Records extends StructWithRest.Records> =
@@ -2825,6 +3012,9 @@ export declare namespace StructWithRest {
2825
3012
  & MergeTuple<{ readonly [K in keyof Records]: Records[K]["Iso"] }>
2826
3013
 
2827
3014
  /**
3015
+ * Computes the encoded type for `StructWithRest` by intersecting the base object
3016
+ * schema's encoded type with the encoded types of all rest record schemas.
3017
+ *
2828
3018
  * @since 4.0.0
2829
3019
  */
2830
3020
  export type Encoded<S extends Objects, Records extends StructWithRest.Records> =
@@ -2832,6 +3022,9 @@ export declare namespace StructWithRest {
2832
3022
  & MergeTuple<{ readonly [K in keyof Records]: Records[K]["Encoded"] }>
2833
3023
 
2834
3024
  /**
3025
+ * Union of the decoding service requirements of the base object schema and all
3026
+ * rest record schemas.
3027
+ *
2835
3028
  * @since 4.0.0
2836
3029
  */
2837
3030
  export type DecodingServices<S extends Objects, Records extends StructWithRest.Records> =
@@ -2839,6 +3032,9 @@ export declare namespace StructWithRest {
2839
3032
  | { [K in keyof Records]: Records[K]["DecodingServices"] }[number]
2840
3033
 
2841
3034
  /**
3035
+ * Union of the encoding service requirements of the base object schema and all
3036
+ * rest record schemas.
3037
+ *
2842
3038
  * @since 4.0.0
2843
3039
  */
2844
3040
  export type EncodingServices<S extends Objects, Records extends StructWithRest.Records> =
@@ -2846,6 +3042,10 @@ export declare namespace StructWithRest {
2846
3042
  | { [K in keyof Records]: Records[K]["EncodingServices"] }[number]
2847
3043
 
2848
3044
  /**
3045
+ * Computes the input type accepted when constructing a `StructWithRest` value by
3046
+ * intersecting the base object's make input with the make inputs of all rest
3047
+ * record schemas.
3048
+ *
2849
3049
  * @since 4.0.0
2850
3050
  */
2851
3051
  export type MakeIn<S extends Objects, Records extends StructWithRest.Records> =
@@ -2921,6 +3121,9 @@ export function StructWithRest<
2921
3121
  */
2922
3122
  export declare namespace Tuple {
2923
3123
  /**
3124
+ * Constraint for the readonly array of element schemas used to define a
3125
+ * fixed-length `Tuple` schema.
3126
+ *
2924
3127
  * @since 4.0.0
2925
3128
  */
2926
3129
  export type Elements = ReadonlyArray<Top>
@@ -2936,6 +3139,12 @@ export declare namespace Tuple {
2936
3139
  : Out
2937
3140
 
2938
3141
  /**
3142
+ * Computes the decoded tuple type for a tuple element schema array.
3143
+ *
3144
+ * **Details**
3145
+ * Each element contributes its decoded `Type`; optional element schemas produce
3146
+ * optional tuple positions.
3147
+ *
2939
3148
  * @since 4.0.0
2940
3149
  */
2941
3150
  export type Type<E extends Elements> = Type_<E>
@@ -2951,6 +3160,9 @@ export declare namespace Tuple {
2951
3160
  : Out
2952
3161
 
2953
3162
  /**
3163
+ * Computes the iso tuple type for a tuple element schema array from each
3164
+ * element schema's `Iso` type.
3165
+ *
2954
3166
  * @since 4.0.0
2955
3167
  */
2956
3168
  export type Iso<E extends Elements> = Iso_<E>
@@ -2966,16 +3178,28 @@ export declare namespace Tuple {
2966
3178
  : Out
2967
3179
 
2968
3180
  /**
3181
+ * Computes the encoded tuple type for a tuple element schema array.
3182
+ *
3183
+ * **Details**
3184
+ * Each element contributes its `Encoded` type; encoded-side optional element
3185
+ * schemas produce optional tuple positions.
3186
+ *
2969
3187
  * @since 4.0.0
2970
3188
  */
2971
3189
  export type Encoded<E extends Elements> = Encoded_<E>
2972
3190
 
2973
3191
  /**
3192
+ * Union of all decoding service requirements needed by the tuple element
3193
+ * schemas.
3194
+ *
2974
3195
  * @since 4.0.0
2975
3196
  */
2976
3197
  export type DecodingServices<E extends Elements> = E[number]["DecodingServices"]
2977
3198
 
2978
3199
  /**
3200
+ * Union of all encoding service requirements needed by the tuple element
3201
+ * schemas.
3202
+ *
2979
3203
  * @since 4.0.0
2980
3204
  */
2981
3205
  export type EncodingServices<E extends Elements> = E[number]["EncodingServices"]
@@ -2993,6 +3217,12 @@ export declare namespace Tuple {
2993
3217
  Out
2994
3218
 
2995
3219
  /**
3220
+ * Computes the input tuple type accepted when constructing a tuple value.
3221
+ *
3222
+ * **Details**
3223
+ * Each element uses its `~type.make` input type. Optional elements and elements
3224
+ * with constructor defaults produce optional tuple positions.
3225
+ *
2996
3226
  * @since 4.0.0
2997
3227
  */
2998
3228
  export type MakeIn<E extends Elements> = MakeIn_<E>
@@ -3088,6 +3318,9 @@ export function Tuple<const Elements extends ReadonlyArray<Top>>(elements: Eleme
3088
3318
  */
3089
3319
  export declare namespace TupleWithRest {
3090
3320
  /**
3321
+ * Constraint for tuple-like schemas that can be used as the fixed leading
3322
+ * portion of a `TupleWithRest` schema.
3323
+ *
3091
3324
  * @since 4.0.0
3092
3325
  */
3093
3326
  export type TupleType = Top & {
@@ -3099,11 +3332,24 @@ export declare namespace TupleWithRest {
3099
3332
  }
3100
3333
 
3101
3334
  /**
3335
+ * Non-empty list of schemas used for the rest portion of a `TupleWithRest`.
3336
+ *
3337
+ * **Details**
3338
+ * The first schema describes the repeated rest element. Additional schemas, when
3339
+ * present, describe trailing tuple elements after the repeated rest segment.
3340
+ *
3102
3341
  * @since 4.0.0
3103
3342
  */
3104
3343
  export type Rest = readonly [Top, ...Array<Top>]
3105
3344
 
3106
3345
  /**
3346
+ * Computes the decoded tuple type for a `TupleWithRest`.
3347
+ *
3348
+ * **Details**
3349
+ * The output starts with the fixed tuple elements, continues with zero or more
3350
+ * values decoded by the first rest schema, and includes any trailing rest schemas
3351
+ * as fixed tuple positions.
3352
+ *
3107
3353
  * @since 4.0.0
3108
3354
  */
3109
3355
  export type Type<T extends ReadonlyArray<unknown>, Rest extends TupleWithRest.Rest> = Rest extends
@@ -3115,6 +3361,13 @@ export declare namespace TupleWithRest {
3115
3361
  T
3116
3362
 
3117
3363
  /**
3364
+ * Computes the iso tuple type for a `TupleWithRest`.
3365
+ *
3366
+ * **Details**
3367
+ * The output starts with the fixed tuple's `Iso` elements, continues with zero
3368
+ * or more values using the first rest schema's `Iso`, and includes any trailing
3369
+ * rest schemas as fixed tuple positions.
3370
+ *
3118
3371
  * @since 4.0.0
3119
3372
  */
3120
3373
  export type Iso<T extends ReadonlyArray<unknown>, Rest extends TupleWithRest.Rest> = Rest extends
@@ -3126,6 +3379,13 @@ export declare namespace TupleWithRest {
3126
3379
  T
3127
3380
 
3128
3381
  /**
3382
+ * Computes the encoded tuple type for `TupleWithRest`.
3383
+ *
3384
+ * **Details**
3385
+ * The leading tuple's encoded elements are kept first. The encoded type of the
3386
+ * first rest schema may repeat zero or more times, and the encoded types of any
3387
+ * additional rest schemas become required trailing tuple elements.
3388
+ *
3129
3389
  * @since 4.0.0
3130
3390
  */
3131
3391
  export type Encoded<E extends ReadonlyArray<unknown>, Rest extends TupleWithRest.Rest> = Rest extends
@@ -3137,6 +3397,13 @@ export declare namespace TupleWithRest {
3137
3397
  E
3138
3398
 
3139
3399
  /**
3400
+ * Computes the constructor input tuple type for `TupleWithRest`.
3401
+ *
3402
+ * **Details**
3403
+ * The leading tuple's make input elements are kept first. The make input type of
3404
+ * the first rest schema may repeat zero or more times, and the make input types
3405
+ * of any additional rest schemas become required trailing tuple elements.
3406
+ *
3140
3407
  * @since 4.0.0
3141
3408
  */
3142
3409
  export type MakeIn<M extends ReadonlyArray<unknown>, Rest extends TupleWithRest.Rest> = Rest extends
@@ -3174,9 +3441,14 @@ export interface TupleWithRest<
3174
3441
  }
3175
3442
 
3176
3443
  /**
3177
- * Extends a fixed-length tuple schema with rest elements, creating a variadic
3178
- * tuple that starts with the fixed elements and ends with zero or more rest
3179
- * elements.
3444
+ * Extends a fixed-length tuple schema with a variadic rest segment.
3445
+ *
3446
+ * **Details**
3447
+ * The resulting tuple starts with the fixed elements from `schema`. The first
3448
+ * schema in `rest` is the repeatable element schema, and any additional schemas
3449
+ * in `rest` are required trailing tuple elements after the variadic segment. For
3450
+ * example, `[Schema.Boolean, Schema.String]` represents zero or more booleans
3451
+ * followed by a final string.
3180
3452
  *
3181
3453
  * **Example** (Tuple with rest)
3182
3454
  *
@@ -3205,7 +3477,12 @@ export function TupleWithRest<S extends Tuple<Tuple.Elements>, const Rest extend
3205
3477
  }
3206
3478
 
3207
3479
  /**
3208
- * Companion type for a `ReadonlyArray`. Produced by {@link ArraySchema}.
3480
+ * Schema interface produced by `Schema.Array` for readonly arrays.
3481
+ *
3482
+ * **Details**
3483
+ * The decoded type is `ReadonlyArray<S["Type"]>`, the encoded type is
3484
+ * `ReadonlyArray<S["Encoded"]>`, and the element schema is available as
3485
+ * `schema`.
3209
3486
  *
3210
3487
  * @since 4.0.0
3211
3488
  */
@@ -3305,6 +3582,13 @@ export const NonEmptyArray = Struct_.lambda<NonEmptyArrayLambda>((schema) =>
3305
3582
  )
3306
3583
 
3307
3584
  /**
3585
+ * Schema interface returned by `ArrayEnsure`, which normalizes a single item or
3586
+ * an array of items into a readonly array.
3587
+ *
3588
+ * **Details**
3589
+ * The schema decodes from `S` or `Schema.Array(S)` and produces
3590
+ * `ReadonlyArray<S["Type"]>`.
3591
+ *
3308
3592
  * @category Arrays
3309
3593
  * @since 4.0.0
3310
3594
  */
@@ -3313,15 +3597,16 @@ export interface ArrayEnsure<S extends Top> extends decodeTo<$Array<toType<S>>,
3313
3597
  }
3314
3598
 
3315
3599
  /**
3316
- * Decodes a single value or an array of values into an array.
3600
+ * Creates a schema that accepts either a value decoded by `schema` or an array
3601
+ * decoded by `Schema.Array(schema)`, then returns an array.
3317
3602
  *
3318
- * Decoding:
3319
- * - a single value is decoded as a one-element array
3320
- * - an array is decoded as-is
3603
+ * **Details**
3604
+ * The single-value branch is tried before the array branch. If `schema` itself
3605
+ * accepts arrays, an array input can be treated as one value and wrapped in a
3606
+ * one-element array.
3321
3607
  *
3322
- * Encoding:
3323
- * - a one-element array is encoded as a single value
3324
- * - arrays with more than one element are encoded as arrays
3608
+ * During encoding, one-element arrays are encoded as the single element. Empty
3609
+ * arrays and arrays with two or more elements are encoded as arrays.
3325
3610
  *
3326
3611
  * @category Arrays
3327
3612
  * @since 4.0.0
@@ -3731,6 +4016,12 @@ export interface refine<T extends S["Type"], S extends Top> extends
3731
4016
  * Narrows the TypeScript type of a schema's output via a type guard predicate,
3732
4017
  * attaching the guard as a runtime filter check.
3733
4018
  *
4019
+ * The `annotations` parameter annotates the filter created by the refinement.
4020
+ * With the default formatter, failed refinements use `message` first,
4021
+ * `expected` second, and `<filter>` when neither is provided. `identifier`
4022
+ * names type-level failures before the refinement runs; it does not name the
4023
+ * failed refinement itself.
4024
+ *
3734
4025
  * @category Filtering
3735
4026
  * @since 4.0.0
3736
4027
  */
@@ -3997,10 +4288,13 @@ export function catchEncodingWithContext<S extends Top, R = never>(
3997
4288
  }
3998
4289
 
3999
4290
  /**
4000
- * The type produced by {@link decodeTo} when a custom transformation is provided.
4291
+ * Schema type produced by `decodeTo` when a custom transformation composes a
4292
+ * `From` schema with a `To` schema.
4001
4293
  *
4002
- * - `Type` is `To["Type"]`, `Encoded` is `From["Encoded"]`
4003
- * - Decoding services from both `from` and `to` are combined
4294
+ * **Details**
4295
+ * `Type` is `To["Type"]` and `Encoded` is `From["Encoded"]`. Decoding services
4296
+ * are `To["DecodingServices"] | From["DecodingServices"] | RD`; encoding
4297
+ * services are `To["EncodingServices"] | From["EncodingServices"] | RE`.
4004
4298
  *
4005
4299
  * @see {@link compose} for the passthrough (no transformation) variant
4006
4300
  * @since 4.0.0
@@ -4246,7 +4540,14 @@ export interface WithoutConstructorDefault {
4246
4540
  }
4247
4541
 
4248
4542
  /**
4249
- * The type produced by {@link withConstructorDefault} a schema with `"~type.constructor.default": "with-default"`.
4543
+ * Schema type returned by `withConstructorDefault` after attaching a default used
4544
+ * by constructor helpers.
4545
+ *
4546
+ * **Details**
4547
+ * The default affects `make` and related constructor helpers only; decoding and
4548
+ * encoding still use the original schema behavior. The schema is marked as
4549
+ * already having a constructor default so another constructor default cannot be
4550
+ * added.
4250
4551
  *
4251
4552
  * @see {@link withConstructorDefault} for the constructor
4252
4553
  * @since 4.0.0
@@ -4300,10 +4601,10 @@ export interface withConstructorDefault<S extends Top & WithoutConstructorDefaul
4300
4601
  export function withConstructorDefault<S extends Top & WithoutConstructorDefault>(
4301
4602
  // `S["~type.make.in"]` instead of `S["Type"]` is intentional here because
4302
4603
  // it makes easier to define the default value if there are nested defaults
4303
- defaultValue: Effect.Effect<S["~type.make.in"]>
4604
+ defaultValue: Effect.Effect<S["~type.make.in"], SchemaError>
4304
4605
  ) {
4305
4606
  return (schema: S): withConstructorDefault<S> =>
4306
- make(AST.withConstructorDefault(schema.ast, defaultValue), { schema })
4607
+ make(AST.withConstructorDefault(schema.ast, Effect.mapErrorEager(defaultValue, (e) => e.issue)), { schema })
4307
4608
  }
4308
4609
 
4309
4610
  /**
@@ -4313,8 +4614,8 @@ export function withConstructorDefault<S extends Top & WithoutConstructorDefault
4313
4614
  * @see {@link withDecodingDefaultKey} for the constructor
4314
4615
  * @since 4.0.0
4315
4616
  */
4316
- export interface withDecodingDefaultKey<S extends Top> extends decodeTo<S, optionalKey<toEncoded<S>>> {
4317
- readonly "Rebuild": withDecodingDefaultKey<S>
4617
+ export interface withDecodingDefaultKey<S extends Top, R = never> extends decodeTo<S, optionalKey<toEncoded<S>>, R> {
4618
+ readonly "Rebuild": withDecodingDefaultKey<S, R>
4318
4619
  }
4319
4620
 
4320
4621
  /**
@@ -4361,14 +4662,14 @@ export type DecodingDefaultOptions = {
4361
4662
  * @see {@link withDecodingDefaultTypeKey} for the variant where the default is a `Type` value
4362
4663
  * @since 4.0.0
4363
4664
  */
4364
- export function withDecodingDefaultKey<S extends Top>(
4365
- defaultValue: Effect.Effect<S["Encoded"]>,
4665
+ export function withDecodingDefaultKey<S extends Top, R = never>(
4666
+ defaultValue: Effect.Effect<S["Encoded"], SchemaError, R>,
4366
4667
  options?: DecodingDefaultOptions
4367
4668
  ) {
4368
4669
  const encode = options?.encodingStrategy === "omit" ? Getter.omit() : Getter.passthrough()
4369
- return (self: S): withDecodingDefaultKey<S> => {
4670
+ return (self: S): withDecodingDefaultKey<S, R> => {
4370
4671
  return optionalKey(toEncoded(self)).pipe(decodeTo(self, {
4371
- decode: Getter.withDefault(defaultValue),
4672
+ decode: Getter.withDefault(Effect.mapErrorEager(defaultValue, (e) => e.issue)),
4372
4673
  encode
4373
4674
  }))
4374
4675
  }
@@ -4382,10 +4683,10 @@ export function withDecodingDefaultKey<S extends Top>(
4382
4683
  * @see {@link withDecodingDefaultTypeKey} for the constructor
4383
4684
  * @since 4.0.0
4384
4685
  */
4385
- export interface withDecodingDefaultTypeKey<S extends Top>
4386
- extends decodeTo<withDecodingDefaultKey<toType<S>>, optionalKey<S>>
4686
+ export interface withDecodingDefaultTypeKey<S extends Top, R = never>
4687
+ extends decodeTo<withDecodingDefaultKey<toType<S>, R>, optionalKey<S>>
4387
4688
  {
4388
- readonly "Rebuild": withDecodingDefaultTypeKey<S>
4689
+ readonly "Rebuild": withDecodingDefaultTypeKey<S, R>
4389
4690
  }
4390
4691
 
4391
4692
  /**
@@ -4407,13 +4708,13 @@ export interface withDecodingDefaultTypeKey<S extends Top>
4407
4708
  * @see {@link withDecodingDefaultType} for the value-level variant
4408
4709
  * @since 4.0.0
4409
4710
  */
4410
- export function withDecodingDefaultTypeKey<S extends Top>(
4411
- defaultValue: Effect.Effect<S["Type"]>,
4711
+ export function withDecodingDefaultTypeKey<S extends Top, R = never>(
4712
+ defaultValue: Effect.Effect<S["Type"], SchemaError, R>,
4412
4713
  options?: DecodingDefaultOptions
4413
4714
  ) {
4414
- return (self: S): withDecodingDefaultTypeKey<S> => {
4715
+ return (self: S): withDecodingDefaultTypeKey<S, R> => {
4415
4716
  return toType(self).pipe(
4416
- withDecodingDefaultKey<toType<S>>(defaultValue, options),
4717
+ withDecodingDefaultKey<toType<S>, R>(defaultValue, options),
4417
4718
  encodeTo(optionalKey(self))
4418
4719
  )
4419
4720
  }
@@ -4426,8 +4727,8 @@ export function withDecodingDefaultTypeKey<S extends Top>(
4426
4727
  * @see {@link withDecodingDefault} for the constructor
4427
4728
  * @since 4.0.0
4428
4729
  */
4429
- export interface withDecodingDefault<S extends Top> extends decodeTo<S, optional<toEncoded<S>>> {
4430
- readonly "Rebuild": withDecodingDefault<S>
4730
+ export interface withDecodingDefault<S extends Top, R = never> extends decodeTo<S, optional<toEncoded<S>>, R> {
4731
+ readonly "Rebuild": withDecodingDefault<S, R>
4431
4732
  }
4432
4733
 
4433
4734
  /**
@@ -4461,14 +4762,14 @@ export interface withDecodingDefault<S extends Top> extends decodeTo<S, optional
4461
4762
  * @see {@link withDecodingDefaultType} for the variant where the default is a `Type` value
4462
4763
  * @since 4.0.0
4463
4764
  */
4464
- export function withDecodingDefault<S extends Top>(
4465
- defaultValue: Effect.Effect<S["Encoded"]>,
4765
+ export function withDecodingDefault<S extends Top, R = never>(
4766
+ defaultValue: Effect.Effect<S["Encoded"], SchemaError, R>,
4466
4767
  options?: DecodingDefaultOptions
4467
4768
  ) {
4468
4769
  const encode = options?.encodingStrategy === "omit" ? Getter.omit() : Getter.passthrough()
4469
- return (self: S): withDecodingDefault<S> => {
4770
+ return (self: S): withDecodingDefault<S, R> => {
4470
4771
  return optional(toEncoded(self)).pipe(decodeTo(self, {
4471
- decode: Getter.withDefault(defaultValue),
4772
+ decode: Getter.withDefault(Effect.mapErrorEager(defaultValue, (e) => e.issue)),
4472
4773
  encode
4473
4774
  }))
4474
4775
  }
@@ -4482,8 +4783,10 @@ export function withDecodingDefault<S extends Top>(
4482
4783
  * @see {@link withDecodingDefaultType} for the constructor
4483
4784
  * @since 4.0.0
4484
4785
  */
4485
- export interface withDecodingDefaultType<S extends Top> extends decodeTo<withDecodingDefault<toType<S>>, optional<S>> {
4486
- readonly "Rebuild": withDecodingDefaultType<S>
4786
+ export interface withDecodingDefaultType<S extends Top, R = never>
4787
+ extends decodeTo<withDecodingDefault<toType<S>, R>, optional<S>>
4788
+ {
4789
+ readonly "Rebuild": withDecodingDefaultType<S, R>
4487
4790
  }
4488
4791
 
4489
4792
  /**
@@ -4505,13 +4808,13 @@ export interface withDecodingDefaultType<S extends Top> extends decodeTo<withDec
4505
4808
  * @see {@link withDecodingDefaultTypeKey} for the key-level variant
4506
4809
  * @since 4.0.0
4507
4810
  */
4508
- export function withDecodingDefaultType<S extends Top>(
4509
- defaultValue: Effect.Effect<S["Type"]>,
4811
+ export function withDecodingDefaultType<S extends Top, R = never>(
4812
+ defaultValue: Effect.Effect<S["Type"], SchemaError, R>,
4510
4813
  options?: DecodingDefaultOptions
4511
4814
  ) {
4512
- return (self: S): withDecodingDefaultType<S> => {
4815
+ return (self: S): withDecodingDefaultType<S, R> => {
4513
4816
  return toType(self).pipe(
4514
- withDecodingDefault<toType<S>>(defaultValue, options),
4817
+ withDecodingDefault<toType<S>, R>(defaultValue, options),
4515
4818
  encodeTo(optional(self))
4516
4819
  )
4517
4820
  }
@@ -4953,9 +5256,17 @@ export function link<T>() {
4953
5256
  // -----------------------------------------------------------------------------
4954
5257
 
4955
5258
  /**
4956
- * Creates a custom filter check from a predicate function. The predicate
4957
- * receives the input value, the schema's AST, and parse options, and returns
4958
- * a value of type {@link FilterOutput}.
5259
+ * Creates a custom validation filter from a predicate function.
5260
+ *
5261
+ * **Details**
5262
+ * The predicate receives the decoded input value, the schema AST, and parse
5263
+ * options, and returns a `FilterOutput`. Non-success outputs are normalized into
5264
+ * schema issues. The `annotations` parameter annotates the filter itself; with
5265
+ * the default formatter, failures use `message` first, `expected` second, and
5266
+ * `<filter>` when neither is provided.
5267
+ *
5268
+ * When `abort` is `true`, parsing stops after this filter fails instead of
5269
+ * collecting later check failures.
4959
5270
  *
4960
5271
  * **Example** (Failure at a nested path)
4961
5272
  *
@@ -5143,17 +5454,17 @@ export const isPattern: (regExp: globalThis.RegExp, annotations?: Annotations.Fi
5143
5454
  export const isStringFinite: (annotations?: Annotations.Filter) => AST.Filter<string> = AST.isStringFinite
5144
5455
 
5145
5456
  /**
5146
- * Validates that a string represents a valid BigInt (can be parsed as a BigInt).
5457
+ * Validates that a string is a signed base-10 integer literal for Effect's
5458
+ * BigInt string encoding.
5147
5459
  *
5148
- * **JSON Schema**
5460
+ * **Details**
5461
+ * The check uses the pattern `^-?\d+$`. It does not accept leading `+`, decimal
5462
+ * points, exponent notation, separators, or non-decimal inputs such as
5463
+ * hexadecimal strings.
5149
5464
  *
5150
- * This check corresponds to a `pattern` constraint in JSON Schema that matches
5151
- * strings representing BigInt values.
5152
- *
5153
- * **Arbitrary**
5154
- *
5155
- * When generating test data with fast-check, this applies a `patterns`
5156
- * constraint to ensure generated strings match the BigInt string pattern.
5465
+ * **JSON Schema**
5466
+ * This check corresponds to a `pattern` constraint with the same signed
5467
+ * base-10 integer pattern.
5157
5468
  *
5158
5469
  * @category String checks
5159
5470
  * @since 4.0.0
@@ -5161,17 +5472,12 @@ export const isStringFinite: (annotations?: Annotations.Filter) => AST.Filter<st
5161
5472
  export const isStringBigInt: (annotations?: Annotations.Filter) => AST.Filter<string> = AST.isStringBigInt
5162
5473
 
5163
5474
  /**
5164
- * Validates that a string represents a valid Symbol (can be parsed as a Symbol).
5165
- *
5166
- * **JSON Schema**
5167
- *
5168
- * This check corresponds to a `pattern` constraint in JSON Schema that matches
5169
- * strings representing Symbol values.
5170
- *
5171
- * **Arbitrary**
5475
+ * Validates that a string has the `Symbol(description)` format used by Effect's
5476
+ * symbol string encoding.
5172
5477
  *
5173
- * When generating test data with fast-check, this applies a `patterns`
5174
- * constraint to ensure generated strings match the Symbol string pattern.
5478
+ * **Details**
5479
+ * The check uses the pattern `^Symbol\((.*)\)$`. It is not a general test for
5480
+ * whether a string can be passed to JavaScript's `Symbol()` function.
5175
5481
  *
5176
5482
  * @category String checks
5177
5483
  * @since 4.0.0
@@ -5321,17 +5627,12 @@ export function isBase64Url(annotations?: Annotations.Filter) {
5321
5627
  }
5322
5628
 
5323
5629
  /**
5324
- * Validates that a string starts with the specified prefix.
5630
+ * Validates at runtime that a string starts with the specified literal prefix.
5325
5631
  *
5326
- * **JSON Schema**
5327
- *
5328
- * This check corresponds to a `pattern` constraint in JSON Schema that matches
5329
- * strings starting with the specified prefix.
5330
- *
5331
- * **Arbitrary**
5332
- *
5333
- * When generating test data with fast-check, this applies a `patterns`
5334
- * constraint to ensure generated strings start with the required prefix.
5632
+ * **Notes**
5633
+ * The JSON Schema and arbitrary metadata are built from `^${startsWith}` without
5634
+ * escaping regexp metacharacters. If the prefix contains regexp syntax, generated
5635
+ * patterns may not be equivalent to the runtime `startsWith` check.
5335
5636
  *
5336
5637
  * @category String checks
5337
5638
  * @since 4.0.0
@@ -5358,17 +5659,12 @@ export function isStartsWith(startsWith: string, annotations?: Annotations.Filte
5358
5659
  }
5359
5660
 
5360
5661
  /**
5361
- * Validates that a string ends with the specified suffix.
5662
+ * Validates at runtime that a string ends with the specified literal suffix.
5362
5663
  *
5363
- * **JSON Schema**
5364
- *
5365
- * This check corresponds to a `pattern` constraint in JSON Schema that matches
5366
- * strings ending with the specified suffix.
5367
- *
5368
- * **Arbitrary**
5369
- *
5370
- * When generating test data with fast-check, this applies a `patterns`
5371
- * constraint to ensure generated strings end with the required suffix.
5664
+ * **Notes**
5665
+ * The JSON Schema and arbitrary metadata are built from `${endsWith}$` without
5666
+ * escaping regexp metacharacters. If the suffix contains regexp syntax, generated
5667
+ * patterns may not be equivalent to the runtime `endsWith` check.
5372
5668
  *
5373
5669
  * @category String checks
5374
5670
  * @since 4.0.0
@@ -5395,17 +5691,12 @@ export function isEndsWith(endsWith: string, annotations?: Annotations.Filter) {
5395
5691
  }
5396
5692
 
5397
5693
  /**
5398
- * Validates that a string contains the specified substring.
5399
- *
5400
- * **JSON Schema**
5401
- *
5402
- * This check corresponds to a `pattern` constraint in JSON Schema that matches
5403
- * strings containing the specified substring.
5404
- *
5405
- * **Arbitrary**
5694
+ * Validates at runtime that a string contains the specified literal substring.
5406
5695
  *
5407
- * When generating test data with fast-check, this applies a `patterns`
5408
- * constraint to ensure generated strings contain the required substring.
5696
+ * **Notes**
5697
+ * The JSON Schema and arbitrary metadata use the substring as a raw regexp
5698
+ * pattern. If the substring contains regexp syntax, generated patterns may not be
5699
+ * equivalent to the runtime `includes` check.
5409
5700
  *
5410
5701
  * @category String checks
5411
5702
  * @since 4.0.0
@@ -5434,17 +5725,12 @@ export function isIncludes(includes: string, annotations?: Annotations.Filter) {
5434
5725
  const UPPERCASED_PATTERN = "^[^a-z]*$"
5435
5726
 
5436
5727
  /**
5437
- * Validates that a string contains only uppercase characters.
5728
+ * Validates that a string is unchanged by JavaScript's `toUpperCase()`.
5438
5729
  *
5439
- * **JSON Schema**
5440
- *
5441
- * This check corresponds to a `pattern` constraint in JSON Schema that matches
5442
- * strings with only uppercase characters.
5443
- *
5444
- * **Arbitrary**
5445
- *
5446
- * When generating test data with fast-check, this applies a `patterns`
5447
- * constraint to ensure generated strings contain only uppercase characters.
5730
+ * **Details**
5731
+ * This accepts empty strings and characters that do not have lowercase forms,
5732
+ * such as digits, punctuation, and whitespace. It rejects strings that would
5733
+ * change when uppercased.
5448
5734
  *
5449
5735
  * @category String checks
5450
5736
  * @since 4.0.0
@@ -5471,17 +5757,12 @@ export function isUppercased(annotations?: Annotations.Filter) {
5471
5757
  const LOWERCASED_PATTERN = "^[^A-Z]*$"
5472
5758
 
5473
5759
  /**
5474
- * Validates that a string contains only lowercase characters.
5475
- *
5476
- * **JSON Schema**
5477
- *
5478
- * This check corresponds to a `pattern` constraint in JSON Schema that matches
5479
- * strings with only lowercase characters.
5760
+ * Validates that a string is unchanged by JavaScript's `toLowerCase()`.
5480
5761
  *
5481
- * **Arbitrary**
5482
- *
5483
- * When generating test data with fast-check, this applies a `patterns`
5484
- * constraint to ensure generated strings contain only lowercase characters.
5762
+ * **Details**
5763
+ * This accepts empty strings and characters that do not have uppercase forms,
5764
+ * such as digits, punctuation, and whitespace. It rejects strings that would
5765
+ * change when lowercased.
5485
5766
  *
5486
5767
  * @category String checks
5487
5768
  * @since 4.0.0
@@ -5508,17 +5789,12 @@ export function isLowercased(annotations?: Annotations.Filter) {
5508
5789
  const CAPITALIZED_PATTERN = "^[^a-z]?.*$"
5509
5790
 
5510
5791
  /**
5511
- * Validates that a string has its first character in uppercase.
5512
- *
5513
- * **JSON Schema**
5792
+ * Validates that the first character of a string is unchanged by
5793
+ * `toUpperCase()`.
5514
5794
  *
5515
- * This check corresponds to a `pattern` constraint in JSON Schema that matches
5516
- * strings with the first character in uppercase.
5517
- *
5518
- * **Arbitrary**
5519
- *
5520
- * When generating test data with fast-check, this applies a `patterns`
5521
- * constraint to ensure generated strings have the first character in uppercase.
5795
+ * **Details**
5796
+ * Empty strings pass. Strings whose first character has no lowercase form, such
5797
+ * as a digit, punctuation mark, or whitespace, also pass.
5522
5798
  *
5523
5799
  * @category String checks
5524
5800
  * @since 4.0.0
@@ -5545,17 +5821,12 @@ export function isCapitalized(annotations?: Annotations.Filter) {
5545
5821
  const UNCAPITALIZED_PATTERN = "^[^A-Z]?.*$"
5546
5822
 
5547
5823
  /**
5548
- * Validates that a string has its first character in lowercase.
5549
- *
5550
- * **JSON Schema**
5824
+ * Validates that the first character of a string is unchanged by
5825
+ * `toLowerCase()`.
5551
5826
  *
5552
- * This check corresponds to a `pattern` constraint in JSON Schema that matches
5553
- * strings with the first character in lowercase.
5554
- *
5555
- * **Arbitrary**
5556
- *
5557
- * When generating test data with fast-check, this applies a `patterns`
5558
- * constraint to ensure generated strings have the first character in lowercase.
5827
+ * **Details**
5828
+ * Empty strings pass. Strings whose first character has no uppercase form, such
5829
+ * as a digit, punctuation mark, or whitespace, also pass.
5559
5830
  *
5560
5831
  * @category String checks
5561
5832
  * @since 4.0.0
@@ -6452,7 +6723,11 @@ export const isLessThanOrEqualToBigDecimal = makeIsLessThanOrEqualTo({
6452
6723
  })
6453
6724
 
6454
6725
  /**
6455
- * Validates that a BigDecimal is within a specified range.
6726
+ * Validates that a `BigDecimal` is within a specified range.
6727
+ *
6728
+ * **Details**
6729
+ * The minimum and maximum boundaries are inclusive by default. Pass
6730
+ * `exclusiveMinimum` or `exclusiveMaximum` to exclude either boundary.
6456
6731
  *
6457
6732
  * @category BigDecimal checks
6458
6733
  * @since 4.0.0
@@ -6869,12 +7144,16 @@ export function isPropertiesLengthBetween(minimum: number, maximum: number, anno
6869
7144
  }
6870
7145
 
6871
7146
  /**
6872
- * Validates that all property names in an object satisfy the provided key
6873
- * schema (encoded side of the schema).
7147
+ * Validates that every own property key of an object satisfies the encoded side
7148
+ * of the provided key schema.
6874
7149
  *
6875
- * **JSON Schema**
7150
+ * **Details**
7151
+ * This check uses `Reflect.ownKeys`, so symbol keys are validated in addition to
7152
+ * string property names.
6876
7153
  *
6877
- * This check corresponds to the `propertyNames` constraint in JSON Schema.
7154
+ * **JSON Schema**
7155
+ * For string property names, this corresponds to the `propertyNames` constraint
7156
+ * in JSON Schema.
6878
7157
  *
6879
7158
  * @category Object checks
6880
7159
  * @since 4.0.0
@@ -6911,18 +7190,14 @@ export function isPropertyNames(keySchema: Top, annotations?: Annotations.Filter
6911
7190
  }
6912
7191
 
6913
7192
  /**
6914
- * Validates that all items in an array are unique according to the provided
6915
- * equivalence function.
7193
+ * Validates that all items in an array are unique according to Effect equality.
6916
7194
  *
6917
7195
  * **JSON Schema**
6918
- *
6919
7196
  * This check corresponds to the `uniqueItems: true` constraint in JSON Schema.
6920
7197
  *
6921
7198
  * **Arbitrary**
6922
- *
6923
- * When generating test data with fast-check, this applies a `comparator`
6924
- * constraint using the provided equivalence function to ensure generated arrays
6925
- * contain only unique items.
7199
+ * When generating test data with fast-check, this applies a comparator based on
7200
+ * Effect equality to ensure generated arrays contain only unique items.
6926
7201
  *
6927
7202
  * @category Array checks
6928
7203
  * @since 4.0.0
@@ -6951,7 +7226,8 @@ export function isUnique<T>(annotations?: Annotations.Filter) {
6951
7226
  // -----------------------------------------------------------------------------
6952
7227
 
6953
7228
  /**
6954
- * Companion type for {@link NonEmptyString}.
7229
+ * Type-level representation of the `NonEmptyString` schema, which validates
7230
+ * strings with a length of at least one.
6955
7231
  *
6956
7232
  * @category String
6957
7233
  * @since 4.0.0
@@ -6970,7 +7246,8 @@ export interface NonEmptyString extends String {
6970
7246
  export const NonEmptyString: NonEmptyString = String.check(isNonEmpty())
6971
7247
 
6972
7248
  /**
6973
- * Companion type for {@link Char}.
7249
+ * Type-level representation of the `Char` schema, which validates strings whose
7250
+ * length is exactly one.
6974
7251
  *
6975
7252
  * @category String
6976
7253
  * @since 4.0.0
@@ -7021,6 +7298,12 @@ export interface Option<A extends Top> extends
7021
7298
  }
7022
7299
 
7023
7300
  /**
7301
+ * Iso representation used for `Option` schemas.
7302
+ *
7303
+ * **Details**
7304
+ * `None` is represented as `{ _tag: "None" }`, while `Some` is represented as
7305
+ * `{ _tag: "Some", value }` using the wrapped schema's `Iso` type.
7306
+ *
7024
7307
  * @category Option
7025
7308
  * @since 4.0.0
7026
7309
  */
@@ -7096,7 +7379,8 @@ export function Option<A extends Top>(value: A): Option<A> {
7096
7379
  }
7097
7380
 
7098
7381
  /**
7099
- * Companion type for {@link OptionFromNullOr}.
7382
+ * Type-level representation of a schema that decodes `null` as `None` and all
7383
+ * other values as `Some`.
7100
7384
  *
7101
7385
  * @category Option
7102
7386
  * @since 4.0.0
@@ -7127,7 +7411,8 @@ export function OptionFromNullOr<S extends Top>(schema: S): OptionFromNullOr<S>
7127
7411
  }
7128
7412
 
7129
7413
  /**
7130
- * Companion type for {@link OptionFromUndefinedOr}.
7414
+ * Type-level representation of a schema that decodes `undefined` as `None` and
7415
+ * all other values as `Some`.
7131
7416
  *
7132
7417
  * @category Option
7133
7418
  * @since 4.0.0
@@ -7158,7 +7443,8 @@ export function OptionFromUndefinedOr<S extends Top>(schema: S): OptionFromUndef
7158
7443
  }
7159
7444
 
7160
7445
  /**
7161
- * Companion type for {@link OptionFromNullishOr}.
7446
+ * Type-level representation of a schema that decodes `null` or `undefined` as
7447
+ * `None` and all other values as `Some`.
7162
7448
  *
7163
7449
  * @category Option
7164
7450
  * @since 4.0.0
@@ -7194,7 +7480,8 @@ export function OptionFromNullishOr<S extends Top>(
7194
7480
  }
7195
7481
 
7196
7482
  /**
7197
- * Companion type for {@link OptionFromOptionalKey}.
7483
+ * Type-level representation of a schema that decodes a missing object key as
7484
+ * `None` and a present key as `Some`.
7198
7485
  *
7199
7486
  * @category Option
7200
7487
  * @since 4.0.0
@@ -7225,7 +7512,8 @@ export function OptionFromOptionalKey<S extends Top>(schema: S): OptionFromOptio
7225
7512
  }
7226
7513
 
7227
7514
  /**
7228
- * Companion type for {@link OptionFromOptional}.
7515
+ * Type-level representation of a schema that decodes a missing key or
7516
+ * `undefined` value as `None` and other present values as `Some`.
7229
7517
  *
7230
7518
  * @category Option
7231
7519
  * @since 4.0.0
@@ -7258,7 +7546,8 @@ export function OptionFromOptional<S extends Top>(schema: S): OptionFromOptional
7258
7546
  }
7259
7547
 
7260
7548
  /**
7261
- * Companion type for {@link OptionFromOptionalNullOr}.
7549
+ * Type-level representation of a schema that decodes a missing key, `undefined`,
7550
+ * or `null` as `None` and all other present values as `Some`.
7262
7551
  *
7263
7552
  * @category Option
7264
7553
  * @since 4.0.0
@@ -7328,6 +7617,12 @@ export interface Result<A extends Top, E extends Top> extends
7328
7617
  }
7329
7618
 
7330
7619
  /**
7620
+ * Iso representation used for `Result` schemas.
7621
+ *
7622
+ * **Details**
7623
+ * Successful results are represented as `{ _tag: "Success", success }`, while
7624
+ * failed results are represented as `{ _tag: "Failure", failure }`.
7625
+ *
7331
7626
  * @category Result
7332
7627
  * @since 4.0.0
7333
7628
  */
@@ -7517,7 +7812,8 @@ export function Redacted<S extends Top>(value: S, options?: {
7517
7812
  }
7518
7813
 
7519
7814
  /**
7520
- * Companion type for {@link RedactedFromValue}.
7815
+ * Type-level representation of a schema that decodes a raw value with the
7816
+ * provided schema and wraps the result in `Redacted`.
7521
7817
  *
7522
7818
  * @category Redacted
7523
7819
  * @since 4.0.0
@@ -7562,10 +7858,14 @@ export function RedactedFromValue<S extends Top>(value: S, options?: {
7562
7858
  }
7563
7859
 
7564
7860
  /**
7565
- * Schema for a single `Cause.Reason<E>`, representing one reason a fiber may
7566
- * fail: a typed error (`Fail`), an unexpected defect (`Die`), or an interrupt
7861
+ * Schema for a single `Cause.Reason`, representing one reason a fiber may fail:
7862
+ * a typed error (`Fail`), an unexpected defect (`Die`), or an interrupt
7567
7863
  * (`Interrupt`).
7568
7864
  *
7865
+ * **Details**
7866
+ * The `error` schema validates typed failures and the `defect` schema validates
7867
+ * unexpected defects.
7868
+ *
7569
7869
  * @category CauseReason
7570
7870
  * @since 4.0.0
7571
7871
  */
@@ -7583,6 +7883,12 @@ export interface CauseReason<E extends Top, D extends Top> extends
7583
7883
  }
7584
7884
 
7585
7885
  /**
7886
+ * Iso representation used for `CauseReason` schemas.
7887
+ *
7888
+ * **Details**
7889
+ * Failures are represented with a `Fail` tag and encoded error, defects with a
7890
+ * `Die` tag and encoded defect, and interrupts with an optional `fiberId`.
7891
+ *
7586
7892
  * @category CauseReason
7587
7893
  * @since 4.0.0
7588
7894
  */
@@ -7598,7 +7904,8 @@ export type CauseReasonIso<E extends Top, D extends Top> = {
7598
7904
  }
7599
7905
 
7600
7906
  /**
7601
- * Creates a schema for `Cause.Reason<E>`. See {@link CauseReason} for details.
7907
+ * Creates a schema for `Cause.Reason` values using separate schemas for typed
7908
+ * failures and unexpected defects.
7602
7909
  *
7603
7910
  * @category CauseReason
7604
7911
  * @since 4.0.0
@@ -7711,8 +8018,12 @@ function causeReasonToFormatter<E>(error: Formatter<E>, defect: Formatter<unknow
7711
8018
  }
7712
8019
 
7713
8020
  /**
7714
- * Schema for `Cause<E>`, an ordered collection of reasons a fiber failed,
7715
- * combining typed errors, defects, and interrupts.
8021
+ * Schema for `Cause` values, represented as an ordered collection of failure
8022
+ * reasons combining typed errors, defects, and interrupts.
8023
+ *
8024
+ * **Details**
8025
+ * The `error` schema validates typed failures and the `defect` schema validates
8026
+ * unexpected defects.
7716
8027
  *
7717
8028
  * @category Cause
7718
8029
  * @since 4.0.0
@@ -7731,13 +8042,17 @@ export interface Cause<E extends Top, D extends Top> extends
7731
8042
  }
7732
8043
 
7733
8044
  /**
8045
+ * Iso representation used for `Cause` schemas: an ordered array of
8046
+ * `CauseReasonIso` values.
8047
+ *
7734
8048
  * @category Cause
7735
8049
  * @since 4.0.0
7736
8050
  */
7737
8051
  export type CauseIso<E extends Top, D extends Top> = ReadonlyArray<CauseReasonIso<E, D>>
7738
8052
 
7739
8053
  /**
7740
- * Creates a schema for `Cause<E>`. See {@link Cause} for details.
8054
+ * Creates a schema for `Cause` values using separate schemas for typed failures
8055
+ * and unexpected defects.
7741
8056
  *
7742
8057
  * @category Cause
7743
8058
  * @since 4.0.0
@@ -7800,7 +8115,7 @@ function causeToFormatter<E>(error: Formatter<E>, defect: Formatter<unknown>) {
7800
8115
  }
7801
8116
 
7802
8117
  /**
7803
- * Companion type for {@link Error}.
8118
+ * Type-level representation of the schema for JavaScript `Error` instances.
7804
8119
  *
7805
8120
  * @category Error
7806
8121
  * @since 4.0.0
@@ -7816,10 +8131,12 @@ const ErrorJsonEncoded = Struct({
7816
8131
  })
7817
8132
 
7818
8133
  /**
7819
- * A schema that represents `Error` objects.
8134
+ * A schema for JavaScript `Error` objects.
7820
8135
  *
7821
- * The default json serializer decodes to a struct with `name` and `message`
7822
- * properties (stack is omitted for security).
8136
+ * **Default JSON serializer**
8137
+ * Encodes an `Error` as an object with `message` and optional `name` properties,
8138
+ * and decodes that object back into an `Error`. The stack trace is omitted from
8139
+ * the encoded form for security.
7823
8140
  *
7824
8141
  * @category Schemas
7825
8142
  * @since 4.0.0
@@ -7838,10 +8155,12 @@ export const Error: Error = instanceOf(globalThis.Error, {
7838
8155
  })
7839
8156
 
7840
8157
  /**
7841
- * A schema that represents `Error` objects.
8158
+ * A schema for JavaScript `Error` objects that preserves stack traces in the JSON
8159
+ * encoded form.
7842
8160
  *
7843
- * The default json serializer decodes to a struct with `name`, `message` and
7844
- * `stack` properties.
8161
+ * **Default JSON serializer**
8162
+ * Encodes an `Error` as an object with `message`, optional `name`, and optional
8163
+ * `stack` properties, and decodes that object back into an `Error`.
7845
8164
  *
7846
8165
  * @category Schemas
7847
8166
  * @since 4.0.0
@@ -7866,7 +8185,8 @@ export const ErrorWithStack: Error = instanceOf(globalThis.Error, {
7866
8185
  })
7867
8186
 
7868
8187
  /**
7869
- * Companion type for {@link Defect}.
8188
+ * Type-level representation of the `Defect` schema, which accepts JavaScript
8189
+ * `Error` values and arbitrary unknown defect values.
7870
8190
  *
7871
8191
  * @category Defect
7872
8192
  * @since 4.0.0
@@ -7901,7 +8221,12 @@ const defectTransformation = new Transformation.Transformation(
7901
8221
  )
7902
8222
 
7903
8223
  /**
7904
- * A schema that represents defects.
8224
+ * A schema for defect values, accepting either JavaScript `Error` values encoded
8225
+ * with `message` and optional `name`, or arbitrary unknown defect values.
8226
+ *
8227
+ * **Default JSON serializer**
8228
+ * Unknown defects are serialized with `JSON.stringify` when possible and fall
8229
+ * back to Effect's formatted representation when JSON serialization fails.
7905
8230
  *
7906
8231
  * @category Constructors
7907
8232
  * @since 4.0.0
@@ -7941,8 +8266,8 @@ export const DefectWithStack: Defect = Union([
7941
8266
  ])
7942
8267
 
7943
8268
  /**
7944
- * Schema for `Exit<A, E>`, representing the result of a fiber execution
7945
- * either a success with value `A` or a failure with `Cause<E>`.
8269
+ * Schema for `Exit` values, representing either a success with value `A` or a
8270
+ * failure with a `Cause` containing typed errors and defects.
7946
8271
  *
7947
8272
  * @category Exit
7948
8273
  * @since 4.0.0
@@ -7962,6 +8287,12 @@ export interface Exit<A extends Top, E extends Top, D extends Top> extends
7962
8287
  }
7963
8288
 
7964
8289
  /**
8290
+ * Iso representation used for `Exit` schemas.
8291
+ *
8292
+ * **Details**
8293
+ * Successful exits are represented as `{ _tag: "Success", value }`, while failed
8294
+ * exits are represented as `{ _tag: "Failure", cause }`.
8295
+ *
7965
8296
  * @category Exit
7966
8297
  * @since 4.0.0
7967
8298
  */
@@ -7974,7 +8305,8 @@ export type ExitIso<A extends Top, E extends Top, D extends Top> = {
7974
8305
  }
7975
8306
 
7976
8307
  /**
7977
- * Creates a schema for `Exit<A, E>`. See {@link Exit} for details.
8308
+ * Creates a schema for `Exit` values using schemas for the success value, typed
8309
+ * failure, and unexpected defect channels.
7978
8310
  *
7979
8311
  * @category Exit
7980
8312
  * @since 4.0.0
@@ -8074,7 +8406,8 @@ export function Exit<A extends Top, E extends Top, D extends Top>(value: A, erro
8074
8406
  }
8075
8407
 
8076
8408
  /**
8077
- * Companion type for {@link ReadonlyMap}.
8409
+ * Type-level representation of a `ReadonlyMap` schema whose keys and values are
8410
+ * validated by the provided schemas.
8078
8411
  *
8079
8412
  * @category ReadonlyMap
8080
8413
  * @since 4.0.0
@@ -8093,6 +8426,9 @@ export interface $ReadonlyMap<Key extends Top, Value extends Top> extends
8093
8426
  }
8094
8427
 
8095
8428
  /**
8429
+ * Iso representation used for `ReadonlyMap` schemas: an array of readonly
8430
+ * `[key, value]` tuples using each entry schema's `Iso` type.
8431
+ *
8096
8432
  * @category ReadonlyMap
8097
8433
  * @since 4.0.0
8098
8434
  */
@@ -8187,6 +8523,9 @@ export interface HashMap<Key extends Top, Value extends Top> extends
8187
8523
  }
8188
8524
 
8189
8525
  /**
8526
+ * Iso representation used for `HashMap` schemas: an array of readonly
8527
+ * `[key, value]` tuples using each entry schema's `Iso` type.
8528
+ *
8190
8529
  * @category HashMap
8191
8530
  * @since 4.0.0
8192
8531
  */
@@ -8262,7 +8601,8 @@ export function HashMap<Key extends Top, Value extends Top>(key: Key, value: Val
8262
8601
  }
8263
8602
 
8264
8603
  /**
8265
- * Companion type for {@link ReadonlySet}.
8604
+ * Type-level representation of a `ReadonlySet` schema whose values are validated
8605
+ * by the provided element schema.
8266
8606
  *
8267
8607
  * @category ReadonlySet
8268
8608
  * @since 4.0.0
@@ -8280,12 +8620,18 @@ export interface $ReadonlySet<Value extends Top> extends
8280
8620
  }
8281
8621
 
8282
8622
  /**
8623
+ * Iso representation used for `ReadonlySet` schemas: an array of element values
8624
+ * using the element schema's `Iso` type.
8625
+ *
8283
8626
  * @category ReadonlySet
8284
8627
  * @since 4.0.0
8285
8628
  */
8286
8629
  export type ReadonlySetIso<Value extends Top> = ReadonlyArray<Value["Iso"]>
8287
8630
 
8288
8631
  /**
8632
+ * Creates a schema that validates a `ReadonlySet` whose values conform to the
8633
+ * provided element schema.
8634
+ *
8289
8635
  * @category ReadonlySet
8290
8636
  * @since 4.0.0
8291
8637
  */
@@ -8370,6 +8716,9 @@ export interface HashSet<Value extends Top> extends
8370
8716
  }
8371
8717
 
8372
8718
  /**
8719
+ * Iso representation used for `HashSet` schemas: an array of element values
8720
+ * using the element schema's `Iso` type.
8721
+ *
8373
8722
  * @category HashSet
8374
8723
  * @since 4.0.0
8375
8724
  */
@@ -8463,6 +8812,9 @@ export interface Chunk<Value extends Top> extends
8463
8812
  }
8464
8813
 
8465
8814
  /**
8815
+ * Iso representation used for `Chunk` schemas: an array of element values using
8816
+ * the element schema's `Iso` type.
8817
+ *
8466
8818
  * @category Chunk
8467
8819
  * @since 4.0.0
8468
8820
  */
@@ -8537,7 +8889,7 @@ export function Chunk<Value extends Top>(value: Value): Chunk<Value> {
8537
8889
  }
8538
8890
 
8539
8891
  /**
8540
- * Companion type for {@link RegExp}.
8892
+ * Type-level representation of the schema for JavaScript `RegExp` instances.
8541
8893
  *
8542
8894
  * @category RegExp
8543
8895
  * @since 4.0.0
@@ -8611,7 +8963,7 @@ export const RegExp: RegExp = instanceOf(
8611
8963
  )
8612
8964
 
8613
8965
  /**
8614
- * Companion type for {@link URL}.
8966
+ * Type-level representation of the schema for JavaScript `URL` instances.
8615
8967
  *
8616
8968
  * @category URL
8617
8969
  * @since 4.0.0
@@ -8629,8 +8981,8 @@ const URLString = String.annotate({ expected: "a string that will be decoded as
8629
8981
  *
8630
8982
  * - encodes `URL` as a `string`
8631
8983
  *
8632
- * @since 4.0.0
8633
8984
  * @category URL
8985
+ * @since 4.0.0
8634
8986
  */
8635
8987
  export const URL: URL = instanceOf(
8636
8988
  globalThis.URL,
@@ -8654,7 +9006,8 @@ export const URL: URL = instanceOf(
8654
9006
  )
8655
9007
 
8656
9008
  /**
8657
- * Companion type for {@link URLFromString}.
9009
+ * Type-level representation of a transformation schema that decodes valid URL
9010
+ * strings into JavaScript `URL` instances.
8658
9011
  *
8659
9012
  * @category URL
8660
9013
  * @since 4.0.0
@@ -8678,7 +9031,8 @@ export interface URLFromString extends decodeTo<URL, String> {
8678
9031
  export const URLFromString: URLFromString = URLString.pipe(decodeTo(URL, Transformation.urlFromString))
8679
9032
 
8680
9033
  /**
8681
- * Companion type for {@link Date}.
9034
+ * Type-level representation of the schema for JavaScript `Date` instances,
9035
+ * including invalid dates.
8682
9036
  *
8683
9037
  * @category Date
8684
9038
  * @since 4.0.0
@@ -8692,9 +9046,10 @@ const DateString = String.annotate({ expected: "a string in ISO 8601 format that
8692
9046
  /**
8693
9047
  * A schema for JavaScript `Date` objects.
8694
9048
  *
8695
- * This schema accepts any `Date` instance, including invalid dates (e.g., `new
8696
- * Date("invalid")`). For validating only valid dates, use {@link DateValid}
8697
- * instead. The default JSON serializer encodes `Date` as an ISO 8601 string.
9049
+ * This schema accepts any `Date` instance, including invalid dates. For
9050
+ * validating only valid dates, use `DateValid` instead. The default JSON
9051
+ * serializer encodes valid dates as ISO 8601 strings; invalid dates encode as
9052
+ * `"Invalid Date"`.
8698
9053
  *
8699
9054
  * **Example** (Date schema)
8700
9055
  *
@@ -8729,7 +9084,8 @@ export const Date: Date = instanceOf(
8729
9084
  )
8730
9085
 
8731
9086
  /**
8732
- * Companion type for {@link DateFromString}.
9087
+ * Type-level representation of a transformation schema that decodes strings into
9088
+ * JavaScript `Date` instances.
8733
9089
  *
8734
9090
  * @category Date
8735
9091
  * @since 4.0.0
@@ -8739,13 +9095,15 @@ export interface DateFromString extends decodeTo<Date, String> {
8739
9095
  }
8740
9096
 
8741
9097
  /**
8742
- * A transformation schema that parses an ISO 8601 string into a `Date`.
9098
+ * A transformation schema that decodes a string into a JavaScript `Date`.
8743
9099
  *
8744
- * Decoding:
8745
- * - A `string` is decoded as a `Date`.
9100
+ * **Decoding**
9101
+ * The string is passed to JavaScript `Date` construction and may decode to an
9102
+ * invalid `Date`. Compose with `DateValid` when invalid dates should be rejected.
8746
9103
  *
8747
- * Encoding:
8748
- * - A `Date` is encoded as a `string`.
9104
+ * **Encoding**
9105
+ * A valid `Date` is encoded as an ISO string; an invalid `Date` is encoded as
9106
+ * `"Invalid Date"`.
8749
9107
  *
8750
9108
  * @category Date
8751
9109
  * @since 4.0.0
@@ -8753,7 +9111,8 @@ export interface DateFromString extends decodeTo<Date, String> {
8753
9111
  export const DateFromString: DateFromString = DateString.pipe(decodeTo(Date, Transformation.dateFromString))
8754
9112
 
8755
9113
  /**
8756
- * Companion type for {@link DateValid}.
9114
+ * Type-level representation of the `DateValid` schema, which accepts only valid
9115
+ * JavaScript `Date` instances.
8757
9116
  *
8758
9117
  * @category Date
8759
9118
  * @since 4.0.0
@@ -8774,7 +9133,7 @@ export interface DateValid extends Date {
8774
9133
  export const DateValid: DateValid = Date.check(isDateValid())
8775
9134
 
8776
9135
  /**
8777
- * Companion type for {@link Duration}.
9136
+ * Type-level representation of the schema for Effect `Duration` values.
8778
9137
  *
8779
9138
  * @category Duration
8780
9139
  * @since 4.0.0
@@ -8865,7 +9224,8 @@ export const Duration: Duration = declare(
8865
9224
  const DurationString = String.annotate({ expected: "a string that will be decoded as a Duration" })
8866
9225
 
8867
9226
  /**
8868
- * Companion type for {@link DurationFromString}.
9227
+ * Type-level representation of a transformation schema that decodes strings
9228
+ * accepted by `Duration.fromInput` into `Duration` values.
8869
9229
  *
8870
9230
  * @category Duration
8871
9231
  * @since 4.0.0
@@ -8892,7 +9252,8 @@ export const DurationFromString: DurationFromString = DurationString.pipe(
8892
9252
  )
8893
9253
 
8894
9254
  /**
8895
- * Companion type for {@link DurationFromNanos}.
9255
+ * Type-level representation of a transformation schema that decodes non-negative
9256
+ * nanosecond `bigint` values into `Duration` values.
8896
9257
  *
8897
9258
  * @category Duration
8898
9259
  * @since 4.0.0
@@ -8905,13 +9266,15 @@ const bigint0 = globalThis.BigInt(0)
8905
9266
 
8906
9267
  /**
8907
9268
  * A transformation schema that decodes a non-negative `bigint` into a
8908
- * `Duration`, treating the `bigint` value as the duration in nanoseconds.
9269
+ * `Duration`, treating the bigint as nanoseconds.
8909
9270
  *
8910
- * Decoding:
8911
- * - A non-negative `bigint` representing nanoseconds is decoded as a `Duration`
9271
+ * **Decoding**
9272
+ * A non-negative `bigint` representing nanoseconds is decoded as a `Duration`.
8912
9273
  *
8913
- * Encoding:
8914
- * - A `Duration` is encoded to a non-negative `bigint` representing nanoseconds
9274
+ * **Encoding**
9275
+ * Finite durations are encoded as a non-negative `bigint` number of nanoseconds.
9276
+ * Encoding fails when the duration cannot be represented as nanoseconds, such as
9277
+ * `Duration.infinity`.
8915
9278
  *
8916
9279
  * @category Duration
8917
9280
  * @since 4.0.0
@@ -8921,7 +9284,8 @@ export const DurationFromNanos: DurationFromNanos = BigInt.check(isGreaterThanOr
8921
9284
  )
8922
9285
 
8923
9286
  /**
8924
- * Companion type for {@link DurationFromMillis}.
9287
+ * Type-level representation of a transformation schema that decodes
9288
+ * non-negative millisecond numbers into `Duration` values.
8925
9289
  *
8926
9290
  * @category Duration
8927
9291
  * @since 4.0.0
@@ -8951,7 +9315,7 @@ export const DurationFromMillis: DurationFromMillis = Number.check(isGreaterThan
8951
9315
  )
8952
9316
 
8953
9317
  /**
8954
- * Companion type for {@link BigDecimal}.
9318
+ * Type-level representation of the schema for Effect `BigDecimal` values.
8955
9319
  *
8956
9320
  * @category BigDecimal
8957
9321
  * @since 4.0.0
@@ -8998,7 +9362,8 @@ export const BigDecimal: BigDecimal = declare(
8998
9362
  )
8999
9363
 
9000
9364
  /**
9001
- * Companion type for {@link BigDecimalFromString}.
9365
+ * Type-level representation of a transformation schema that decodes strings into
9366
+ * `BigDecimal` values.
9002
9367
  *
9003
9368
  * @category BigDecimal
9004
9369
  * @since 4.0.0
@@ -9024,7 +9389,8 @@ export const BigDecimalFromString: BigDecimalFromString = BigDecimalString.pipe(
9024
9389
  )
9025
9390
 
9026
9391
  /**
9027
- * Companion type for {@link UnknownFromJsonString}.
9392
+ * Type-level representation of a transformation schema that decodes
9393
+ * JSON-encoded strings into `unknown` values.
9028
9394
  *
9029
9395
  * @category JSON
9030
9396
  * @since 4.0.0
@@ -9059,7 +9425,8 @@ export interface UnknownFromJsonString extends fromJsonString<Unknown> {
9059
9425
  export const UnknownFromJsonString: UnknownFromJsonString = fromJsonString(Unknown)
9060
9426
 
9061
9427
  /**
9062
- * Companion type for {@link fromJsonString}.
9428
+ * Type-level representation of a schema that parses a JSON string and then
9429
+ * decodes the parsed value with the provided schema.
9063
9430
  *
9064
9431
  * @category JSON
9065
9432
  * @since 4.0.0
@@ -9141,7 +9508,7 @@ export function fromJsonString<S extends Top>(schema: S): fromJsonString<S> {
9141
9508
  }
9142
9509
 
9143
9510
  /**
9144
- * Companion type for {@link File}.
9511
+ * Type-level representation of the schema for JavaScript `File` instances.
9145
9512
  *
9146
9513
  * @category File
9147
9514
  * @since 4.0.0
@@ -9213,7 +9580,7 @@ export const File: File = instanceOf(globalThis.File, {
9213
9580
  })
9214
9581
 
9215
9582
  /**
9216
- * Companion type for {@link FormData}.
9583
+ * Type-level representation of the schema for JavaScript `FormData` instances.
9217
9584
  *
9218
9585
  * @category FormData
9219
9586
  * @since 4.0.0
@@ -9275,7 +9642,8 @@ export const FormData: FormData = instanceOf(globalThis.FormData, {
9275
9642
  })
9276
9643
 
9277
9644
  /**
9278
- * Companion type for {@link fromFormData}.
9645
+ * Type-level representation of a schema that parses `FormData` into a tree
9646
+ * record and then decodes it with the provided schema.
9279
9647
  *
9280
9648
  * @category FormData
9281
9649
  * @since 4.0.0
@@ -9372,7 +9740,8 @@ export function fromFormData<S extends Top>(schema: S): fromFormData<S> {
9372
9740
  }
9373
9741
 
9374
9742
  /**
9375
- * Companion type for {@link URLSearchParams}.
9743
+ * Type-level representation of the schema for JavaScript `URLSearchParams`
9744
+ * instances.
9376
9745
  *
9377
9746
  * @category URLSearchParams
9378
9747
  * @since 4.0.0
@@ -9409,7 +9778,8 @@ export const URLSearchParams: URLSearchParams = instanceOf(globalThis.URLSearchP
9409
9778
  })
9410
9779
 
9411
9780
  /**
9412
- * Companion type for {@link fromURLSearchParams}.
9781
+ * Type-level representation of a schema that parses `URLSearchParams` into a
9782
+ * tree record and then decodes it with the provided schema.
9413
9783
  *
9414
9784
  * @category URLSearchParams
9415
9785
  * @since 4.0.0
@@ -9497,7 +9867,8 @@ export function fromURLSearchParams<S extends Top>(schema: S): fromURLSearchPara
9497
9867
  }
9498
9868
 
9499
9869
  /**
9500
- * Companion type for {@link Finite}.
9870
+ * Type-level representation of the `Finite` number schema, which rejects `NaN`,
9871
+ * `Infinity`, and `-Infinity`.
9501
9872
  *
9502
9873
  * @category Number
9503
9874
  * @since 4.0.0
@@ -9515,7 +9886,8 @@ export interface Finite extends Number {
9515
9886
  export const Finite: Finite = Number.check(isFinite())
9516
9887
 
9517
9888
  /**
9518
- * Companion type for {@link Int}.
9889
+ * Type-level representation of the `Int` schema, which accepts only finite
9890
+ * integer numbers.
9519
9891
  *
9520
9892
  * @category Number
9521
9893
  * @since 4.0.0
@@ -9533,7 +9905,8 @@ export interface Int extends Number {
9533
9905
  export const Int: Int = Number.check(isInt())
9534
9906
 
9535
9907
  /**
9536
- * Companion type for {@link NumberFromString}.
9908
+ * Type-level representation of a transformation schema that decodes strings into
9909
+ * numbers using JavaScript number coercion.
9537
9910
  *
9538
9911
  * @category Number
9539
9912
  * @since 4.0.0
@@ -9543,13 +9916,16 @@ export interface NumberFromString extends decodeTo<Finite, String> {
9543
9916
  }
9544
9917
 
9545
9918
  /**
9546
- * A transformation schema that parses a string into a number.
9919
+ * A transformation schema that parses a string into a `number` using JavaScript
9920
+ * number coercion.
9547
9921
  *
9548
- * Decoding:
9549
- * - A `string` is decoded as a finite number.
9922
+ * **Decoding**
9923
+ * A `string` is decoded as a number, including possible non-finite values such as
9924
+ * `NaN`, `Infinity`, and `-Infinity`. Use `FiniteFromString` to reject non-finite
9925
+ * numbers.
9550
9926
  *
9551
- * Encoding:
9552
- * - A number is encoded as a `string`.
9927
+ * **Encoding**
9928
+ * A number is encoded as a `string`.
9553
9929
  *
9554
9930
  * @category Number
9555
9931
  * @since 4.0.0
@@ -9559,7 +9935,8 @@ export const NumberFromString: NumberFromString = String.annotate({
9559
9935
  }).pipe(decodeTo(Number, Transformation.numberFromString))
9560
9936
 
9561
9937
  /**
9562
- * Companion type for {@link FiniteFromString}.
9938
+ * Type-level representation of a transformation schema that decodes strings into
9939
+ * finite numbers.
9563
9940
  *
9564
9941
  * @category Number
9565
9942
  * @since 4.0.0
@@ -9586,7 +9963,8 @@ export const FiniteFromString: FiniteFromString = String.annotate({
9586
9963
  }).pipe(decodeTo(Finite, Transformation.numberFromString))
9587
9964
 
9588
9965
  /**
9589
- * Companion type for {@link BigIntFromString}.
9966
+ * Type-level representation of a transformation schema that decodes strings into
9967
+ * `bigint` values.
9590
9968
  *
9591
9969
  * @category BigInt
9592
9970
  * @since 4.0.0
@@ -9612,7 +9990,8 @@ export const BigIntFromString: BigIntFromString = make<String>(AST.bigIntString)
9612
9990
  )
9613
9991
 
9614
9992
  /**
9615
- * Companion type for {@link Trimmed}.
9993
+ * Schema interface for `Trimmed`, representing strings with no leading or
9994
+ * trailing whitespace.
9616
9995
  *
9617
9996
  * @category String
9618
9997
  * @since 4.0.0
@@ -9630,7 +10009,8 @@ export interface Trimmed extends String {
9630
10009
  export const Trimmed: Trimmed = String.check(isTrimmed())
9631
10010
 
9632
10011
  /**
9633
- * Companion type for {@link Trim}.
10012
+ * Schema interface for `Trim`, a transformation that trims leading and trailing
10013
+ * whitespace while decoding and encodes the trimmed string unchanged.
9634
10014
  *
9635
10015
  * @category String
9636
10016
  * @since 4.0.0
@@ -9656,7 +10036,8 @@ export const Trim: Trim = String.annotate({
9656
10036
  }).pipe(decodeTo(Trimmed, Transformation.trim()))
9657
10037
 
9658
10038
  /**
9659
- * Companion type for {@link StringFromBase64}.
10039
+ * Schema interface for `StringFromBase64`, a transformation between RFC4648
10040
+ * base64-encoded strings and UTF-8 strings.
9660
10041
  *
9661
10042
  * @category String
9662
10043
  * @since 4.0.0
@@ -9684,7 +10065,8 @@ export const StringFromBase64: StringFromBase64 = String.annotate({
9684
10065
  )
9685
10066
 
9686
10067
  /**
9687
- * Companion type for {@link StringFromBase64Url}.
10068
+ * Schema interface for `StringFromBase64Url`, a transformation between URL-safe
10069
+ * base64-encoded strings and UTF-8 strings.
9688
10070
  *
9689
10071
  * @category String
9690
10072
  * @since 4.0.0
@@ -9712,7 +10094,8 @@ export const StringFromBase64Url: StringFromBase64Url = String.annotate({
9712
10094
  )
9713
10095
 
9714
10096
  /**
9715
- * Companion type for {@link StringFromHex}.
10097
+ * Schema interface for `StringFromHex`, a transformation between hex-encoded
10098
+ * strings and UTF-8 strings.
9716
10099
  *
9717
10100
  * @category String
9718
10101
  * @since 4.0.0
@@ -9740,7 +10123,8 @@ export const StringFromHex: StringFromHex = String.annotate({
9740
10123
  )
9741
10124
 
9742
10125
  /**
9743
- * Companion type for {@link StringFromUriComponent}.
10126
+ * Schema interface for `StringFromUriComponent`, a transformation between
10127
+ * URI-component encoded strings and UTF-8 strings.
9744
10128
  *
9745
10129
  * @category String
9746
10130
  * @since 4.0.0
@@ -9787,7 +10171,8 @@ export const StringFromUriComponent: StringFromUriComponent = String.annotate({
9787
10171
  )
9788
10172
 
9789
10173
  /**
9790
- * A union schema for JavaScript property keys: `number | symbol | string`.
10174
+ * A union schema for property keys accepted by Effect schemas: finite `number`,
10175
+ * `symbol`, or `string`.
9791
10176
  *
9792
10177
  * @category PropertyKey
9793
10178
  * @since 4.0.0
@@ -9795,6 +10180,11 @@ export const StringFromUriComponent: StringFromUriComponent = String.annotate({
9795
10180
  export const PropertyKey = Union([Finite, Symbol, String])
9796
10181
 
9797
10182
  /**
10183
+ * Schema for a Standard Schema v1 failure result.
10184
+ *
10185
+ * The result contains an `issues` array where each issue has a message and an
10186
+ * optional path made of property keys or keyed path segments.
10187
+ *
9798
10188
  * @category StandardSchema
9799
10189
  * @since 4.0.0
9800
10190
  */
@@ -9806,7 +10196,8 @@ export const StandardSchemaV1FailureResult = Struct({
9806
10196
  })
9807
10197
 
9808
10198
  /**
9809
- * Companion type for {@link BooleanFromBit}.
10199
+ * Schema interface for `BooleanFromBit`, a transformation between bit literals
10200
+ * `0 | 1` and boolean values.
9810
10201
  *
9811
10202
  * @category Boolean
9812
10203
  * @since 4.0.0
@@ -9832,7 +10223,8 @@ export const BooleanFromBit: BooleanFromBit = Literals([0, 1]).pipe(
9832
10223
  )
9833
10224
 
9834
10225
  /**
9835
- * Companion type for {@link Uint8Array}.
10226
+ * Schema interface for `Uint8Array`, representing JavaScript `Uint8Array`
10227
+ * instances with base64 JSON encoding.
9836
10228
  *
9837
10229
  * @category Uint8Array
9838
10230
  * @since 4.0.0
@@ -9875,7 +10267,8 @@ export const Uint8Array: Uint8Array = instanceOf(globalThis.Uint8Array<ArrayBuff
9875
10267
  })
9876
10268
 
9877
10269
  /**
9878
- * Companion type for {@link Uint8ArrayFromBase64}.
10270
+ * Schema interface for `Uint8ArrayFromBase64`, a transformation between
10271
+ * base64-encoded strings and `Uint8Array` values.
9879
10272
  *
9880
10273
  * @category Uint8Array
9881
10274
  * @since 4.0.0
@@ -9902,7 +10295,8 @@ export const Uint8ArrayFromBase64: Uint8ArrayFromBase64 = Base64String.pipe(
9902
10295
  )
9903
10296
 
9904
10297
  /**
9905
- * Companion type for {@link Uint8ArrayFromBase64Url}.
10298
+ * Schema interface for `Uint8ArrayFromBase64Url`, a transformation between
10299
+ * URL-safe base64-encoded strings and `Uint8Array` values.
9906
10300
  *
9907
10301
  * @category Uint8Array
9908
10302
  * @since 4.0.0
@@ -9934,7 +10328,8 @@ export const Uint8ArrayFromBase64Url: Uint8ArrayFromBase64Url = String.annotate(
9934
10328
  )
9935
10329
 
9936
10330
  /**
9937
- * Companion type for {@link Uint8ArrayFromHex}.
10331
+ * Schema interface for `Uint8ArrayFromHex`, a transformation between
10332
+ * hex-encoded strings and `Uint8Array` values.
9938
10333
  *
9939
10334
  * @category Uint8Array
9940
10335
  * @since 4.0.0
@@ -9966,7 +10361,8 @@ export const Uint8ArrayFromHex: Uint8ArrayFromHex = String.annotate({
9966
10361
  )
9967
10362
 
9968
10363
  /**
9969
- * Companion type for {@link DateTimeUtc}.
10364
+ * Schema interface for `DateTimeUtc`, representing `DateTime.Utc` values with
10365
+ * UTC ISO string JSON encoding.
9970
10366
  *
9971
10367
  * @category DateTime
9972
10368
  * @since 4.0.0
@@ -10010,7 +10406,8 @@ export const DateTimeUtc: DateTimeUtc = declare(
10010
10406
  )
10011
10407
 
10012
10408
  /**
10013
- * Companion type for {@link DateTimeUtcFromDate}.
10409
+ * Schema interface for `DateTimeUtcFromDate`, a transformation from valid
10410
+ * JavaScript `Date` values to `DateTime.Utc`.
10014
10411
  *
10015
10412
  * @category DateTime
10016
10413
  * @since 4.0.0
@@ -10039,7 +10436,8 @@ export const DateTimeUtcFromDate: DateTimeUtcFromDate = DateValid.pipe(
10039
10436
  )
10040
10437
 
10041
10438
  /**
10042
- * Companion type for {@link DateTimeUtcFromString}.
10439
+ * Schema interface for `DateTimeUtcFromString`, a transformation from date-time
10440
+ * strings to `DateTime.Utc`.
10043
10441
  *
10044
10442
  * @category DateTime
10045
10443
  * @since 4.0.0
@@ -10049,15 +10447,16 @@ export interface DateTimeUtcFromString extends decodeTo<DateTimeUtc, String> {
10049
10447
  }
10050
10448
 
10051
10449
  /**
10052
- * A transformation schema that decodes a string into a `DateTime.Utc`.
10450
+ * A transformation schema that decodes a date-time string into a `DateTime.Utc`.
10053
10451
  *
10054
10452
  * Decoding:
10055
- * - A `string` that can be parsed by `Date.parse` is decoded as a
10056
- * `DateTime.Utc`
10453
+ *
10454
+ * - A string accepted by `DateTime.make` is parsed and normalized to UTC. Strings
10455
+ * without an explicit zone are interpreted as UTC.
10057
10456
  *
10058
10457
  * Encoding:
10059
- * - A `DateTime.Utc` is encoded as a `string` in ISO 8601 format, ignoring any
10060
- * time zone.
10458
+ *
10459
+ * - A `DateTime.Utc` is encoded as a UTC ISO 8601 string.
10061
10460
  *
10062
10461
  * @category DateTime
10063
10462
  * @since 4.0.0
@@ -10072,7 +10471,8 @@ export const DateTimeUtcFromString: DateTimeUtcFromString = String.annotate({
10072
10471
  )
10073
10472
 
10074
10473
  /**
10075
- * Companion type for {@link DateTimeUtcFromMillis}.
10474
+ * Schema interface for `DateTimeUtcFromMillis`, a transformation between epoch
10475
+ * milliseconds and `DateTime.Utc` values.
10076
10476
  *
10077
10477
  * @category DateTime
10078
10478
  * @since 4.0.0
@@ -10101,7 +10501,8 @@ export const DateTimeUtcFromMillis: DateTimeUtcFromMillis = Number.pipe(
10101
10501
  )
10102
10502
 
10103
10503
  /**
10104
- * Companion type for {@link TimeZoneOffset}.
10504
+ * Schema interface for `TimeZoneOffset`, representing
10505
+ * `DateTime.TimeZone.Offset` values encoded as offset milliseconds.
10105
10506
  *
10106
10507
  * @category DateTime
10107
10508
  * @since 4.0.0
@@ -10145,7 +10546,8 @@ export const TimeZoneOffset: TimeZoneOffset = declare(
10145
10546
  )
10146
10547
 
10147
10548
  /**
10148
- * Companion type for {@link TimeZoneNamed}.
10549
+ * Schema interface for `TimeZoneNamed`, representing
10550
+ * `DateTime.TimeZone.Named` values encoded as IANA time zone identifiers.
10149
10551
  *
10150
10552
  * @category DateTime
10151
10553
  * @since 4.0.0
@@ -10195,7 +10597,8 @@ export const TimeZoneNamed: TimeZoneNamed = declare(
10195
10597
  )
10196
10598
 
10197
10599
  /**
10198
- * Companion type for {@link TimeZoneNamedFromString}.
10600
+ * Schema interface for `TimeZoneNamedFromString`, a transformation between IANA
10601
+ * time zone identifier strings and `DateTime.TimeZone.Named` values.
10199
10602
  *
10200
10603
  * @category DateTime
10201
10604
  * @since 4.0.0
@@ -10221,7 +10624,8 @@ export const TimeZoneNamedFromString: TimeZoneNamedFromString = TimeZoneNamedStr
10221
10624
  )
10222
10625
 
10223
10626
  /**
10224
- * Companion type for {@link TimeZone}.
10627
+ * Schema interface for `TimeZone`, representing `DateTime.TimeZone` values
10628
+ * encoded as either IANA identifiers or numeric offset strings.
10225
10629
  *
10226
10630
  * @category DateTime
10227
10631
  * @since 4.0.0
@@ -10277,7 +10681,8 @@ export const TimeZone: TimeZone = declare(
10277
10681
  )
10278
10682
 
10279
10683
  /**
10280
- * Companion type for {@link TimeZoneFromString}.
10684
+ * Schema interface for `TimeZoneFromString`, a transformation from IANA
10685
+ * identifier or offset strings to `DateTime.TimeZone` values.
10281
10686
  *
10282
10687
  * @category DateTime
10283
10688
  * @since 4.0.0
@@ -10303,7 +10708,8 @@ export const TimeZoneFromString: TimeZoneFromString = TimeZoneString.pipe(
10303
10708
  )
10304
10709
 
10305
10710
  /**
10306
- * Companion type for {@link DateTimeZoned}.
10711
+ * Schema interface for `DateTimeZoned`, representing `DateTime.Zoned` values
10712
+ * with ISO offset or named-zone string JSON encoding.
10307
10713
  *
10308
10714
  * @category DateTime
10309
10715
  * @since 4.0.0
@@ -10321,7 +10727,9 @@ const DateTimeZonedString = String.annotate({
10321
10727
  *
10322
10728
  * **Default JSON serializer**
10323
10729
  *
10324
- * - encodes `DateTime.Zoned` as a string in the format
10730
+ * - encodes offset zones as an ISO date-time with a numeric offset, such as
10731
+ * `YYYY-MM-DDTHH:mm:ss.sss+HH:MM`
10732
+ * - encodes named zones by appending the IANA identifier in brackets, such as
10325
10733
  * `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]`
10326
10734
  *
10327
10735
  * @category DateTime
@@ -10360,7 +10768,8 @@ export const DateTimeZoned: DateTimeZoned = declare(
10360
10768
  )
10361
10769
 
10362
10770
  /**
10363
- * Companion type for {@link DateTimeZonedFromString}.
10771
+ * Schema interface for `DateTimeZonedFromString`, a transformation between
10772
+ * zoned date-time strings and `DateTime.Zoned` values.
10364
10773
  *
10365
10774
  * @category DateTime
10366
10775
  * @since 4.0.0
@@ -10512,10 +10921,7 @@ function makeClass<
10512
10921
  return Parser.makeOption(getClassSchema(this) as any)(input ?? {}, options) as any
10513
10922
  }
10514
10923
  static makeEffect(input: S["~type.make.in"], options?: MakeOptions): Effect.Effect<Self, SchemaError> {
10515
- return Effect.mapErrorEager(
10516
- Parser.makeEffect(getClassSchema(this) as any)(input ?? {}, options),
10517
- (issue) => new SchemaError(issue)
10518
- ) as any
10924
+ return (getClassSchema(this) as any).makeEffect(input ?? {}, options)
10519
10925
  }
10520
10926
  static annotate(annotations: Annotations.Declaration<Self, readonly [S]>) {
10521
10927
  return this.rebuild(AST.annotate(this.ast, annotations))
@@ -10942,13 +11348,14 @@ export const TaggedClass: {
10942
11348
  schema: Struct.Fields | Struct<Struct.Fields>,
10943
11349
  annotations?: Annotations.Declaration<any, readonly [Struct<Struct.Fields>]>
10944
11350
  ): any => {
11351
+ const struct = isStruct(schema) ?
11352
+ schema.mapFields((fields) => ({ _tag: tag(tagValue), ...fields }), {
11353
+ unsafePreserveChecks: true
11354
+ }) :
11355
+ TaggedStruct(tagValue, schema)
10945
11356
  return Class<any, {}>(identifier ?? tagValue)(
10946
- isStruct(schema) ?
10947
- schema.mapFields((fields) => ({ _tag: tag(tagValue), ...fields }), {
10948
- unsafePreserveChecks: true
10949
- }) :
10950
- TaggedStruct(tagValue, schema),
10951
- annotations
11357
+ struct,
11358
+ annotations as Annotations.Declaration<any, readonly [typeof struct]>
10952
11359
  )
10953
11360
  }
10954
11361
  }
@@ -11186,13 +11593,14 @@ export const TaggedErrorClass: {
11186
11593
  schema: Struct.Fields | Struct<Struct.Fields>,
11187
11594
  annotations?: Annotations.Declaration<any, readonly [Struct<Struct.Fields>]>
11188
11595
  ): any => {
11596
+ const struct = isStruct(schema) ?
11597
+ schema.mapFields((fields) => ({ _tag: tag(tagValue), ...fields }), {
11598
+ unsafePreserveChecks: true
11599
+ }) :
11600
+ TaggedStruct(tagValue, schema)
11189
11601
  return ErrorClass<any, {}>(identifier ?? tagValue)(
11190
- isStruct(schema) ?
11191
- schema.mapFields((fields) => ({ _tag: tag(tagValue), ...fields }), {
11192
- unsafePreserveChecks: true
11193
- }) :
11194
- TaggedStruct(tagValue, schema),
11195
- annotations
11602
+ struct,
11603
+ annotations as Annotations.Declaration<any, readonly [typeof struct]>
11196
11604
  )
11197
11605
  }
11198
11606
  }
@@ -11256,10 +11664,11 @@ export function toArbitrary<S extends Top>(schema: S): FastCheck.Arbitrary<S["Ty
11256
11664
  // -----------------------------------------------------------------------------
11257
11665
 
11258
11666
  /**
11259
- * **Technical Note**
11667
+ * Annotates a schema with a custom formatter used by `toFormatter`.
11260
11668
  *
11261
- * This annotation cannot be added to `Annotations.Bottom` because it would make
11262
- * the schema invariant.
11669
+ * Use this when the formatter derived from the schema structure is not suitable.
11670
+ * The annotation is applied through this helper because adding it directly to
11671
+ * `Annotations.Bottom` would make schemas invariant.
11263
11672
  *
11264
11673
  * @category Formatter
11265
11674
  * @since 4.0.0
@@ -11500,9 +11909,11 @@ export interface ToJsonSchemaOptions {
11500
11909
  }
11501
11910
 
11502
11911
  /**
11503
- * Returns a JSON Schema Document (draft-2020-12).
11912
+ * Returns a JSON Schema document using draft 2020-12.
11504
11913
  *
11505
- * You can use the `options` parameter to return a different target JSON Schema.
11914
+ * The `options` parameter controls generation details such as additional
11915
+ * properties and synthesized check descriptions; it does not change the draft
11916
+ * target.
11506
11917
  *
11507
11918
  * @category JsonSchema
11508
11919
  * @since 4.0.0
@@ -11522,8 +11933,8 @@ export function toJsonSchemaDocument(schema: Top, options?: ToJsonSchemaOptions)
11522
11933
  // -----------------------------------------------------------------------------
11523
11934
 
11524
11935
  /**
11525
- * Derives a canonical JSON codec from a schema. The encoded form is `unknown`
11526
- * (any JSON-compatible value), decoded to the schema's `Type`.
11936
+ * Derives a canonical JSON codec from a schema. The encoded form is `Json`, and
11937
+ * decoding produces the schema's `Type`.
11527
11938
  *
11528
11939
  * @category Canonical Codecs
11529
11940
  * @since 4.0.0
@@ -11686,9 +12097,11 @@ type XmlEncoderOptions = {
11686
12097
  }
11687
12098
 
11688
12099
  /**
11689
- * Derives an XML encoder from a codec. Encodes a value to an XML string by
11690
- * first converting it through {@link toCodecStringTree}, then serializing the
11691
- * resulting tree to XML.
12100
+ * Derives an XML encoder from a codec.
12101
+ *
12102
+ * The returned function encodes a value through `toCodecStringTree` and returns
12103
+ * an `Effect` that succeeds with the XML string or fails with `SchemaError` if
12104
+ * codec encoding fails.
11692
12105
  *
11693
12106
  * @category Canonical Codecs
11694
12107
  * @since 4.0.0
@@ -12066,6 +12479,9 @@ export function toDifferJsonPatch<T, E>(schema: Codec<T, E>): Differ<T, JsonPatc
12066
12479
  }
12067
12480
 
12068
12481
  /**
12482
+ * Recursive tree type whose leaves are `Node` values and whose branches are
12483
+ * readonly arrays or string-keyed records of child trees.
12484
+ *
12069
12485
  * @category Tree
12070
12486
  * @since 4.0.0
12071
12487
  */
@@ -12152,6 +12568,9 @@ export interface JsonObject {
12152
12568
  export const Json: Codec<Json> = make(AST.Json)
12153
12569
 
12154
12570
  /**
12571
+ * Recursive TypeScript type for mutable JSON values: `null`, `number`,
12572
+ * `boolean`, `string`, mutable arrays, or mutable string-keyed records.
12573
+ *
12155
12574
  * @category JSON
12156
12575
  * @since 4.0.0
12157
12576
  */
@@ -12278,6 +12697,15 @@ export declare namespace Annotations {
12278
12697
  * @since 4.0.0
12279
12698
  */
12280
12699
  export interface Augment extends Annotations {
12700
+ /**
12701
+ * Human-readable description of what a value is expected to satisfy.
12702
+ *
12703
+ * For filter and refinement failures, the default formatter uses
12704
+ * `message` first, then `expected`, and finally falls back to `<filter>`.
12705
+ *
12706
+ * Use this to name a failed filter in the default message:
12707
+ * `Expected <expected>, got <actual>`.
12708
+ */
12281
12709
  readonly expected?: string | undefined
12282
12710
  readonly title?: string | undefined
12283
12711
  readonly description?: string | undefined
@@ -12325,13 +12753,31 @@ export declare namespace Annotations {
12325
12753
  */
12326
12754
  export interface Bottom<T, TypeParameters extends ReadonlyArray<Top>> extends Documentation<T> {
12327
12755
  /**
12328
- * The message to use when the value is invalid.
12756
+ * Complete message to use when this schema node reports an issue.
12757
+ *
12758
+ * This replaces the default message for matching issue types instead of
12759
+ * only changing the expected label. For a filter or refinement failure,
12760
+ * annotate the filter with `message` to replace the whole filter failure
12761
+ * message, or `expected` to keep the default
12762
+ * `Expected <expected>, got <actual>` shape.
12329
12763
  */
12330
12764
  readonly message?: string | undefined
12331
12765
  /**
12332
12766
  * The message to use when a key is unexpected.
12333
12767
  */
12334
12768
  readonly messageUnexpectedKey?: string | undefined
12769
+ /**
12770
+ * Stable identifier for this schema node.
12771
+ *
12772
+ * Identifiers are used by schema tooling, including JSON Schema
12773
+ * generation, to name references. The default formatter also uses
12774
+ * `identifier` as the expected label for type-level failures, such as
12775
+ * `Expected UserId, got null`.
12776
+ *
12777
+ * `identifier` does not name a failed filter or refinement. If the base
12778
+ * type matches and a filter fails, put `expected` or `message` on the
12779
+ * filter/refinement instead.
12780
+ */
12335
12781
  readonly identifier?: string | undefined
12336
12782
  readonly parseOptions?: AST.ParseOptions | undefined
12337
12783
  /**
@@ -12348,16 +12794,24 @@ export declare namespace Annotations {
12348
12794
  }
12349
12795
 
12350
12796
  /**
12797
+ * Helpers for projecting declaration type-parameter schemas into decoded or
12798
+ * encoded codec arrays used by annotation hooks.
12799
+ *
12351
12800
  * @since 4.0.0
12352
12801
  */
12353
12802
  export namespace TypeParameters {
12354
12803
  /**
12804
+ * Maps declaration type-parameter schemas to codecs for their decoded `Type`
12805
+ * values.
12806
+ *
12355
12807
  * @since 4.0.0
12356
12808
  */
12357
12809
  export type Type<TypeParameters extends ReadonlyArray<Top>> = {
12358
12810
  readonly [K in keyof TypeParameters]: Codec<TypeParameters[K]["Type"]>
12359
12811
  }
12360
12812
  /**
12813
+ * Maps declaration type-parameter schemas to codecs for their `Encoded` values.
12814
+ *
12361
12815
  * @since 4.0.0
12362
12816
  */
12363
12817
  export type Encoded<TypeParameters extends ReadonlyArray<Top>> = {
@@ -12416,7 +12870,21 @@ export declare namespace Annotations {
12416
12870
  * @since 4.0.0
12417
12871
  */
12418
12872
  export interface Filter extends Augment {
12873
+ /**
12874
+ * Complete message to use when this filter or refinement fails.
12875
+ *
12876
+ * The default formatter checks filter annotations in this order:
12877
+ * `message`, then `expected`, then `<filter>`.
12878
+ */
12419
12879
  readonly message?: string | undefined
12880
+ /**
12881
+ * Stable identifier for the schema after this filter is attached.
12882
+ *
12883
+ * This can affect schema tooling such as JSON Schema generation and
12884
+ * type-level failures before the filter runs, but it does not name the
12885
+ * failed filter itself. For filter failure messages, use `expected` or
12886
+ * `message`.
12887
+ */
12420
12888
  readonly identifier?: string | undefined
12421
12889
  /**
12422
12890
  * Optional metadata used to identify or extend the filter with custom data.
@@ -12436,10 +12904,16 @@ export declare namespace Annotations {
12436
12904
  }
12437
12905
 
12438
12906
  /**
12907
+ * Types used by arbitrary-derivation annotations to configure `toArbitrary`
12908
+ * hooks and carry merged fast-check constraints.
12909
+ *
12439
12910
  * @since 4.0.0
12440
12911
  */
12441
12912
  export namespace ToArbitrary {
12442
12913
  /**
12914
+ * fast-check string constraints plus optional regular-expression pattern strings
12915
+ * used when deriving string arbitraries from schema checks.
12916
+ *
12443
12917
  * @since 4.0.0
12444
12918
  */
12445
12919
  export interface StringConstraints extends FastCheck.StringSharedConstraints {
@@ -12447,6 +12921,9 @@ export declare namespace Annotations {
12447
12921
  }
12448
12922
 
12449
12923
  /**
12924
+ * fast-check floating-point constraints plus `isInteger`, which switches
12925
+ * derived number arbitraries to integer generation.
12926
+ *
12450
12927
  * @since 4.0.0
12451
12928
  */
12452
12929
  export interface NumberConstraints extends FastCheck.FloatConstraints {
@@ -12454,11 +12931,17 @@ export declare namespace Annotations {
12454
12931
  }
12455
12932
 
12456
12933
  /**
12934
+ * fast-check bigint constraints used when deriving arbitraries for bigint
12935
+ * schemas.
12936
+ *
12457
12937
  * @since 4.0.0
12458
12938
  */
12459
12939
  export interface BigIntConstraints extends FastCheck.BigIntConstraints {}
12460
12940
 
12461
12941
  /**
12942
+ * fast-check array constraints plus an optional comparator used when deriving
12943
+ * unique-array arbitraries.
12944
+ *
12462
12945
  * @since 4.0.0
12463
12946
  */
12464
12947
  export interface ArrayConstraints extends FastCheck.ArrayConstraints {
@@ -12466,11 +12949,17 @@ export declare namespace Annotations {
12466
12949
  }
12467
12950
 
12468
12951
  /**
12952
+ * fast-check date constraints used when deriving arbitraries for `Date` and
12953
+ * DateTime schemas.
12954
+ *
12469
12955
  * @since 4.0.0
12470
12956
  */
12471
12957
  export interface DateConstraints extends FastCheck.DateConstraints {}
12472
12958
 
12473
12959
  /**
12960
+ * Grouped arbitrary-generation constraints accumulated from schema checks and
12961
+ * passed to `toArbitrary` derivation.
12962
+ *
12474
12963
  * @since 4.0.0
12475
12964
  */
12476
12965
  export interface Constraint {
@@ -12482,6 +12971,10 @@ export declare namespace Annotations {
12482
12971
  }
12483
12972
 
12484
12973
  /**
12974
+ * Context passed to arbitrary-derivation hooks, including accumulated
12975
+ * constraints and an `isSuspend` flag used to limit recursion for suspended
12976
+ * schemas.
12977
+ *
12485
12978
  * @since 4.0.0
12486
12979
  */
12487
12980
  export interface Context {
@@ -12495,6 +12988,11 @@ export declare namespace Annotations {
12495
12988
  }
12496
12989
 
12497
12990
  /**
12991
+ * Hook signature for declaration schema arbitrary annotations.
12992
+ *
12993
+ * Given arbitraries for any type parameters, returns a function that receives the
12994
+ * fast-check module and derivation context and produces an arbitrary for `T`.
12995
+ *
12498
12996
  * @since 4.0.0
12499
12997
  */
12500
12998
  export interface Declaration<T, TypeParameters extends ReadonlyArray<Top>> {
@@ -12506,10 +13004,17 @@ export declare namespace Annotations {
12506
13004
  }
12507
13005
 
12508
13006
  /**
13007
+ * Types used by formatter annotations to customize formatter derivation for
13008
+ * declaration schemas.
13009
+ *
12509
13010
  * @since 4.0.0
12510
13011
  */
12511
13012
  export namespace ToFormatter {
12512
13013
  /**
13014
+ * Hook signature for declaration schema formatter annotations.
13015
+ *
13016
+ * Given formatters for any type parameters, returns a formatter for `T`.
13017
+ *
12513
13018
  * @since 4.0.0
12514
13019
  */
12515
13020
  export interface Declaration<T, TypeParameters extends ReadonlyArray<Top>> {
@@ -12521,10 +13026,17 @@ export declare namespace Annotations {
12521
13026
  }
12522
13027
 
12523
13028
  /**
13029
+ * Types used by equivalence annotations to customize equivalence derivation for
13030
+ * declaration schemas.
13031
+ *
12524
13032
  * @since 4.0.0
12525
13033
  */
12526
13034
  export namespace ToEquivalence {
12527
13035
  /**
13036
+ * Hook signature for declaration schema equivalence annotations.
13037
+ *
13038
+ * Given equivalences for any type parameters, returns an `Equivalence` for `T`.
13039
+ *
12528
13040
  * @since 4.0.0
12529
13041
  */
12530
13042
  export interface Declaration<T, TypeParameters extends ReadonlyArray<Top>> {
@@ -12536,6 +13048,10 @@ export declare namespace Annotations {
12536
13048
  }
12537
13049
 
12538
13050
  /**
13051
+ * Annotations that can be attached to schema issues.
13052
+ *
13053
+ * The optional `message` field overrides the default issue message.
13054
+ *
12539
13055
  * @category Model
12540
13056
  * @since 4.0.0
12541
13057
  */
@@ -12544,7 +13060,10 @@ export declare namespace Annotations {
12544
13060
  }
12545
13061
 
12546
13062
  /**
12547
- * This MUST NOT be extended with custom meta.
13063
+ * Registry of metadata payloads emitted by built-in schema filters and checks.
13064
+ *
13065
+ * Do not augment this interface with custom metadata; extend `MetaDefinitions`
13066
+ * instead.
12548
13067
  *
12549
13068
  * @since 4.0.0
12550
13069
  */
@@ -12755,18 +13274,25 @@ export declare namespace Annotations {
12755
13274
  }
12756
13275
 
12757
13276
  /**
13277
+ * Union of all metadata payloads defined by `BuiltInMetaDefinitions`.
13278
+ *
12758
13279
  * @since 4.0.0
12759
13280
  */
12760
13281
  export type BuiltInMeta = BuiltInMetaDefinitions[keyof BuiltInMetaDefinitions]
12761
13282
 
12762
13283
  /**
12763
- * This MAY be extended with custom meta.
13284
+ * Augmentable registry of schema filter metadata payloads.
13285
+ *
13286
+ * Extend this interface to add custom values accepted by annotation `meta`
13287
+ * fields.
12764
13288
  *
12765
13289
  * @since 4.0.0
12766
13290
  */
12767
13291
  export interface MetaDefinitions extends BuiltInMetaDefinitions {}
12768
13292
 
12769
13293
  /**
13294
+ * Union of built-in and user-augmented schema filter metadata payloads.
13295
+ *
12770
13296
  * @since 4.0.0
12771
13297
  */
12772
13298
  export type Meta = MetaDefinitions[keyof MetaDefinitions]