effect 4.0.0-beta.71 → 4.0.0-beta.73

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 (999) hide show
  1. package/dist/Array.d.ts +65 -111
  2. package/dist/Array.d.ts.map +1 -1
  3. package/dist/Array.js +28 -44
  4. package/dist/Array.js.map +1 -1
  5. package/dist/BigDecimal.d.ts +66 -58
  6. package/dist/BigDecimal.d.ts.map +1 -1
  7. package/dist/BigDecimal.js +30 -26
  8. package/dist/BigDecimal.js.map +1 -1
  9. package/dist/BigInt.d.ts +21 -19
  10. package/dist/BigInt.d.ts.map +1 -1
  11. package/dist/BigInt.js +17 -15
  12. package/dist/BigInt.js.map +1 -1
  13. package/dist/Boolean.d.ts +15 -17
  14. package/dist/Boolean.d.ts.map +1 -1
  15. package/dist/Boolean.js +13 -13
  16. package/dist/Boolean.js.map +1 -1
  17. package/dist/Brand.d.ts +2 -3
  18. package/dist/Brand.d.ts.map +1 -1
  19. package/dist/Brand.js +2 -3
  20. package/dist/Brand.js.map +1 -1
  21. package/dist/Cache.d.ts +9 -9
  22. package/dist/Cache.js +3 -3
  23. package/dist/Cause.d.ts +35 -39
  24. package/dist/Cause.d.ts.map +1 -1
  25. package/dist/Cause.js +31 -33
  26. package/dist/Cause.js.map +1 -1
  27. package/dist/Channel.d.ts +141 -99
  28. package/dist/Channel.d.ts.map +1 -1
  29. package/dist/Channel.js +56 -42
  30. package/dist/Channel.js.map +1 -1
  31. package/dist/ChannelSchema.d.ts +3 -3
  32. package/dist/ChannelSchema.js +1 -1
  33. package/dist/Chunk.d.ts +67 -54
  34. package/dist/Chunk.d.ts.map +1 -1
  35. package/dist/Chunk.js +33 -22
  36. package/dist/Chunk.js.map +1 -1
  37. package/dist/Clock.d.ts +3 -3
  38. package/dist/Clock.js +1 -1
  39. package/dist/Combiner.d.ts +6 -10
  40. package/dist/Combiner.d.ts.map +1 -1
  41. package/dist/Combiner.js +6 -10
  42. package/dist/Combiner.js.map +1 -1
  43. package/dist/Config.d.ts +9 -10
  44. package/dist/Config.d.ts.map +1 -1
  45. package/dist/Config.js +7 -8
  46. package/dist/Config.js.map +1 -1
  47. package/dist/ConfigProvider.d.ts +4 -4
  48. package/dist/ConfigProvider.js +4 -4
  49. package/dist/Console.d.ts +11 -7
  50. package/dist/Console.d.ts.map +1 -1
  51. package/dist/Console.js +11 -7
  52. package/dist/Console.js.map +1 -1
  53. package/dist/Context.d.ts +35 -35
  54. package/dist/Context.js +13 -13
  55. package/dist/Cron.d.ts +7 -6
  56. package/dist/Cron.d.ts.map +1 -1
  57. package/dist/Cron.js +7 -6
  58. package/dist/Cron.js.map +1 -1
  59. package/dist/Crypto.d.ts +1 -1
  60. package/dist/Crypto.js +1 -1
  61. package/dist/Data.d.ts +26 -32
  62. package/dist/Data.d.ts.map +1 -1
  63. package/dist/Data.js +9 -8
  64. package/dist/Data.js.map +1 -1
  65. package/dist/DateTime.d.ts +164 -122
  66. package/dist/DateTime.d.ts.map +1 -1
  67. package/dist/DateTime.js +86 -66
  68. package/dist/DateTime.js.map +1 -1
  69. package/dist/Deferred.d.ts +6 -6
  70. package/dist/Deferred.js +4 -4
  71. package/dist/Duration.d.ts +39 -39
  72. package/dist/Duration.js +21 -21
  73. package/dist/Effect.d.ts +220 -309
  74. package/dist/Effect.d.ts.map +1 -1
  75. package/dist/Effect.js +115 -140
  76. package/dist/Effect.js.map +1 -1
  77. package/dist/Effectable.d.ts +2 -2
  78. package/dist/Effectable.js +2 -2
  79. package/dist/Encoding.d.ts +13 -10
  80. package/dist/Encoding.d.ts.map +1 -1
  81. package/dist/Encoding.js +12 -9
  82. package/dist/Encoding.js.map +1 -1
  83. package/dist/Equal.d.ts +3 -4
  84. package/dist/Equal.d.ts.map +1 -1
  85. package/dist/Equal.js +2 -3
  86. package/dist/Equal.js.map +1 -1
  87. package/dist/Equivalence.d.ts +5 -19
  88. package/dist/Equivalence.d.ts.map +1 -1
  89. package/dist/Equivalence.js +5 -14
  90. package/dist/Equivalence.js.map +1 -1
  91. package/dist/ErrorReporter.d.ts +14 -13
  92. package/dist/ErrorReporter.d.ts.map +1 -1
  93. package/dist/ErrorReporter.js +10 -9
  94. package/dist/ErrorReporter.js.map +1 -1
  95. package/dist/ExecutionPlan.d.ts +7 -2
  96. package/dist/ExecutionPlan.d.ts.map +1 -1
  97. package/dist/ExecutionPlan.js +7 -2
  98. package/dist/ExecutionPlan.js.map +1 -1
  99. package/dist/Exit.d.ts +25 -23
  100. package/dist/Exit.d.ts.map +1 -1
  101. package/dist/Exit.js +13 -13
  102. package/dist/Exit.js.map +1 -1
  103. package/dist/Fiber.d.ts +4 -4
  104. package/dist/Fiber.js +2 -2
  105. package/dist/FiberHandle.d.ts +6 -6
  106. package/dist/FiberHandle.js +4 -4
  107. package/dist/FiberMap.d.ts +18 -18
  108. package/dist/FiberMap.js +8 -8
  109. package/dist/FiberSet.d.ts +21 -13
  110. package/dist/FiberSet.d.ts.map +1 -1
  111. package/dist/FiberSet.js +17 -9
  112. package/dist/FiberSet.js.map +1 -1
  113. package/dist/FileSystem.d.ts +13 -9
  114. package/dist/FileSystem.d.ts.map +1 -1
  115. package/dist/FileSystem.js +11 -7
  116. package/dist/FileSystem.js.map +1 -1
  117. package/dist/Filter.d.ts +2 -2
  118. package/dist/Filter.js +2 -2
  119. package/dist/Formatter.d.ts +1 -3
  120. package/dist/Formatter.d.ts.map +1 -1
  121. package/dist/Formatter.js +1 -3
  122. package/dist/Formatter.js.map +1 -1
  123. package/dist/Function.d.ts +12 -12
  124. package/dist/Function.js +12 -12
  125. package/dist/Graph.d.ts +22 -22
  126. package/dist/Graph.js +12 -12
  127. package/dist/HKT.d.ts +5 -4
  128. package/dist/HKT.d.ts.map +1 -1
  129. package/dist/Hash.d.ts +3 -3
  130. package/dist/Hash.js +3 -3
  131. package/dist/HashMap.d.ts +33 -35
  132. package/dist/HashMap.d.ts.map +1 -1
  133. package/dist/HashMap.js +11 -13
  134. package/dist/HashMap.js.map +1 -1
  135. package/dist/HashRing.d.ts +7 -9
  136. package/dist/HashRing.d.ts.map +1 -1
  137. package/dist/HashRing.js +3 -5
  138. package/dist/HashRing.js.map +1 -1
  139. package/dist/HashSet.d.ts +16 -16
  140. package/dist/HashSet.js +6 -6
  141. package/dist/Inspectable.d.ts +4 -4
  142. package/dist/Inspectable.js +4 -4
  143. package/dist/Iterable.d.ts +82 -56
  144. package/dist/Iterable.d.ts.map +1 -1
  145. package/dist/Iterable.js +28 -20
  146. package/dist/Iterable.js.map +1 -1
  147. package/dist/JsonPatch.d.ts +1 -1
  148. package/dist/JsonPatch.js +1 -1
  149. package/dist/JsonPointer.d.ts +3 -3
  150. package/dist/JsonPointer.js +3 -3
  151. package/dist/JsonSchema.d.ts +13 -23
  152. package/dist/JsonSchema.d.ts.map +1 -1
  153. package/dist/JsonSchema.js +13 -23
  154. package/dist/JsonSchema.js.map +1 -1
  155. package/dist/Latch.d.ts +2 -2
  156. package/dist/Latch.js +2 -2
  157. package/dist/Layer.d.ts +47 -27
  158. package/dist/Layer.d.ts.map +1 -1
  159. package/dist/Layer.js +23 -15
  160. package/dist/Layer.js.map +1 -1
  161. package/dist/LayerMap.d.ts +1 -2
  162. package/dist/LayerMap.d.ts.map +1 -1
  163. package/dist/LayerMap.js +1 -2
  164. package/dist/LayerMap.js.map +1 -1
  165. package/dist/LogLevel.d.ts +3 -3
  166. package/dist/LogLevel.js +3 -3
  167. package/dist/Logger.d.ts +2 -2
  168. package/dist/Logger.js +2 -2
  169. package/dist/ManagedRuntime.d.ts +1 -1
  170. package/dist/ManagedRuntime.js +1 -1
  171. package/dist/Match.d.ts +32 -37
  172. package/dist/Match.d.ts.map +1 -1
  173. package/dist/Match.js +32 -37
  174. package/dist/Match.js.map +1 -1
  175. package/dist/Metric.d.ts +35 -21
  176. package/dist/Metric.d.ts.map +1 -1
  177. package/dist/Metric.js +34 -20
  178. package/dist/Metric.js.map +1 -1
  179. package/dist/MutableHashMap.d.ts +13 -19
  180. package/dist/MutableHashMap.d.ts.map +1 -1
  181. package/dist/MutableHashMap.js +5 -7
  182. package/dist/MutableHashMap.js.map +1 -1
  183. package/dist/MutableHashSet.d.ts +4 -4
  184. package/dist/MutableHashSet.js +2 -2
  185. package/dist/MutableList.d.ts +16 -6
  186. package/dist/MutableList.d.ts.map +1 -1
  187. package/dist/MutableList.js +15 -5
  188. package/dist/MutableList.js.map +1 -1
  189. package/dist/MutableRef.d.ts +5 -4
  190. package/dist/MutableRef.d.ts.map +1 -1
  191. package/dist/MutableRef.js +3 -2
  192. package/dist/MutableRef.js.map +1 -1
  193. package/dist/NonEmptyIterable.d.ts +3 -3
  194. package/dist/NonEmptyIterable.js +1 -1
  195. package/dist/Number.d.ts +20 -18
  196. package/dist/Number.d.ts.map +1 -1
  197. package/dist/Number.js +16 -14
  198. package/dist/Number.js.map +1 -1
  199. package/dist/Optic.d.ts +11 -18
  200. package/dist/Optic.d.ts.map +1 -1
  201. package/dist/Optic.js +7 -14
  202. package/dist/Optic.js.map +1 -1
  203. package/dist/Option.d.ts +21 -24
  204. package/dist/Option.d.ts.map +1 -1
  205. package/dist/Option.js +9 -10
  206. package/dist/Option.js.map +1 -1
  207. package/dist/Order.d.ts +11 -38
  208. package/dist/Order.d.ts.map +1 -1
  209. package/dist/Order.js +11 -33
  210. package/dist/Order.js.map +1 -1
  211. package/dist/Ordering.d.ts +5 -5
  212. package/dist/Ordering.js +3 -3
  213. package/dist/PartitionedSemaphore.d.ts +4 -8
  214. package/dist/PartitionedSemaphore.d.ts.map +1 -1
  215. package/dist/PartitionedSemaphore.js +3 -7
  216. package/dist/PartitionedSemaphore.js.map +1 -1
  217. package/dist/Path.d.ts +4 -7
  218. package/dist/Path.d.ts.map +1 -1
  219. package/dist/Path.js +3 -6
  220. package/dist/Path.js.map +1 -1
  221. package/dist/Pipeable.d.ts +2 -2
  222. package/dist/Pipeable.js +2 -2
  223. package/dist/PlatformError.d.ts +1 -1
  224. package/dist/PlatformError.js +1 -1
  225. package/dist/Predicate.d.ts +2 -81
  226. package/dist/Predicate.d.ts.map +1 -1
  227. package/dist/Predicate.js +2 -47
  228. package/dist/Predicate.js.map +1 -1
  229. package/dist/PrimaryKey.d.ts +3 -3
  230. package/dist/PrimaryKey.js +1 -1
  231. package/dist/PubSub.d.ts +147 -46
  232. package/dist/PubSub.d.ts.map +1 -1
  233. package/dist/PubSub.js +93 -32
  234. package/dist/PubSub.js.map +1 -1
  235. package/dist/Pull.d.ts +1 -1
  236. package/dist/Pull.js +1 -1
  237. package/dist/Queue.d.ts +40 -24
  238. package/dist/Queue.d.ts.map +1 -1
  239. package/dist/Queue.js +36 -20
  240. package/dist/Queue.js.map +1 -1
  241. package/dist/RcMap.d.ts +3 -3
  242. package/dist/RcMap.js +1 -1
  243. package/dist/Record.d.ts +79 -52
  244. package/dist/Record.d.ts.map +1 -1
  245. package/dist/Record.js +33 -22
  246. package/dist/Record.js.map +1 -1
  247. package/dist/Redactable.d.ts +7 -7
  248. package/dist/Redactable.js +7 -7
  249. package/dist/Reducer.d.ts +0 -2
  250. package/dist/Reducer.d.ts.map +1 -1
  251. package/dist/Reducer.js +0 -2
  252. package/dist/Reducer.js.map +1 -1
  253. package/dist/Ref.d.ts +12 -12
  254. package/dist/Ref.js +10 -10
  255. package/dist/References.d.ts +20 -20
  256. package/dist/References.js +20 -20
  257. package/dist/RegExp.d.ts +2 -2
  258. package/dist/RegExp.js +2 -2
  259. package/dist/Request.d.ts +3 -3
  260. package/dist/Request.js +3 -3
  261. package/dist/RequestResolver.d.ts +11 -14
  262. package/dist/RequestResolver.d.ts.map +1 -1
  263. package/dist/RequestResolver.js +5 -6
  264. package/dist/RequestResolver.js.map +1 -1
  265. package/dist/Result.d.ts +52 -34
  266. package/dist/Result.d.ts.map +1 -1
  267. package/dist/Result.js +44 -20
  268. package/dist/Result.js.map +1 -1
  269. package/dist/Runtime.d.ts +1 -1
  270. package/dist/Runtime.js +1 -1
  271. package/dist/Schedule.d.ts +20 -24
  272. package/dist/Schedule.d.ts.map +1 -1
  273. package/dist/Schedule.js +12 -12
  274. package/dist/Schedule.js.map +1 -1
  275. package/dist/Scheduler.d.ts +3 -3
  276. package/dist/Scheduler.js +3 -3
  277. package/dist/Schema.d.ts +480 -210
  278. package/dist/Schema.d.ts.map +1 -1
  279. package/dist/Schema.js +410 -172
  280. package/dist/Schema.js.map +1 -1
  281. package/dist/SchemaAST.d.ts +40 -32
  282. package/dist/SchemaAST.d.ts.map +1 -1
  283. package/dist/SchemaAST.js +40 -32
  284. package/dist/SchemaAST.js.map +1 -1
  285. package/dist/SchemaGetter.d.ts +4 -6
  286. package/dist/SchemaGetter.d.ts.map +1 -1
  287. package/dist/SchemaGetter.js +4 -6
  288. package/dist/SchemaGetter.js.map +1 -1
  289. package/dist/SchemaIssue.d.ts +35 -47
  290. package/dist/SchemaIssue.d.ts.map +1 -1
  291. package/dist/SchemaIssue.js +31 -42
  292. package/dist/SchemaIssue.js.map +1 -1
  293. package/dist/SchemaParser.d.ts +16 -12
  294. package/dist/SchemaParser.d.ts.map +1 -1
  295. package/dist/SchemaParser.js +16 -12
  296. package/dist/SchemaParser.js.map +1 -1
  297. package/dist/SchemaRepresentation.d.ts +47 -62
  298. package/dist/SchemaRepresentation.d.ts.map +1 -1
  299. package/dist/SchemaRepresentation.js +44 -58
  300. package/dist/SchemaRepresentation.js.map +1 -1
  301. package/dist/SchemaTransformation.d.ts +16 -18
  302. package/dist/SchemaTransformation.d.ts.map +1 -1
  303. package/dist/SchemaTransformation.js +13 -15
  304. package/dist/SchemaTransformation.js.map +1 -1
  305. package/dist/Scope.d.ts +51 -14
  306. package/dist/Scope.d.ts.map +1 -1
  307. package/dist/Scope.js +29 -8
  308. package/dist/Scope.js.map +1 -1
  309. package/dist/ScopedCache.d.ts +12 -12
  310. package/dist/ScopedCache.js +4 -4
  311. package/dist/ScopedRef.d.ts +2 -2
  312. package/dist/ScopedRef.js +2 -2
  313. package/dist/Semaphore.d.ts +1 -1
  314. package/dist/Semaphore.js +1 -1
  315. package/dist/Sink.d.ts +36 -41
  316. package/dist/Sink.d.ts.map +1 -1
  317. package/dist/Sink.js +21 -24
  318. package/dist/Sink.js.map +1 -1
  319. package/dist/Stdio.d.ts +5 -4
  320. package/dist/Stdio.d.ts.map +1 -1
  321. package/dist/Stdio.js +4 -3
  322. package/dist/Stdio.js.map +1 -1
  323. package/dist/Stream.d.ts +264 -165
  324. package/dist/Stream.d.ts.map +1 -1
  325. package/dist/Stream.js +103 -62
  326. package/dist/Stream.js.map +1 -1
  327. package/dist/String.d.ts +48 -47
  328. package/dist/String.d.ts.map +1 -1
  329. package/dist/String.js +32 -29
  330. package/dist/String.js.map +1 -1
  331. package/dist/Struct.d.ts +35 -100
  332. package/dist/Struct.d.ts.map +1 -1
  333. package/dist/Struct.js +13 -38
  334. package/dist/Struct.js.map +1 -1
  335. package/dist/SubscriptionRef.d.ts +268 -91
  336. package/dist/SubscriptionRef.d.ts.map +1 -1
  337. package/dist/SubscriptionRef.js +90 -31
  338. package/dist/SubscriptionRef.js.map +1 -1
  339. package/dist/Symbol.d.ts +1 -1
  340. package/dist/Symbol.js +1 -1
  341. package/dist/SynchronizedRef.d.ts +27 -27
  342. package/dist/SynchronizedRef.js +9 -9
  343. package/dist/Terminal.d.ts +8 -3
  344. package/dist/Terminal.d.ts.map +1 -1
  345. package/dist/Terminal.js +8 -3
  346. package/dist/Terminal.js.map +1 -1
  347. package/dist/Tracer.d.ts +25 -7
  348. package/dist/Tracer.d.ts.map +1 -1
  349. package/dist/Tracer.js +25 -7
  350. package/dist/Tracer.js.map +1 -1
  351. package/dist/Trie.d.ts +21 -23
  352. package/dist/Trie.d.ts.map +1 -1
  353. package/dist/Trie.js +7 -7
  354. package/dist/Trie.js.map +1 -1
  355. package/dist/Tuple.d.ts +26 -73
  356. package/dist/Tuple.d.ts.map +1 -1
  357. package/dist/Tuple.js +10 -31
  358. package/dist/Tuple.js.map +1 -1
  359. package/dist/TxChunk.d.ts +2 -2
  360. package/dist/TxChunk.js +2 -2
  361. package/dist/TxHashMap.d.ts +20 -20
  362. package/dist/TxHashMap.js +8 -8
  363. package/dist/TxHashSet.d.ts +14 -14
  364. package/dist/TxHashSet.js +6 -6
  365. package/dist/TxPriorityQueue.d.ts +14 -6
  366. package/dist/TxPriorityQueue.d.ts.map +1 -1
  367. package/dist/TxPriorityQueue.js +12 -4
  368. package/dist/TxPriorityQueue.js.map +1 -1
  369. package/dist/TxPubSub.d.ts +4 -4
  370. package/dist/TxPubSub.js +4 -4
  371. package/dist/TxQueue.d.ts +10 -10
  372. package/dist/TxQueue.js +10 -10
  373. package/dist/TxReentrantLock.d.ts +48 -12
  374. package/dist/TxReentrantLock.d.ts.map +1 -1
  375. package/dist/TxReentrantLock.js +38 -10
  376. package/dist/TxReentrantLock.js.map +1 -1
  377. package/dist/TxRef.d.ts +1 -1
  378. package/dist/TxRef.js +1 -1
  379. package/dist/TxSubscriptionRef.d.ts +1 -1
  380. package/dist/TxSubscriptionRef.js +1 -1
  381. package/dist/Types.d.ts +8 -7
  382. package/dist/Types.d.ts.map +1 -1
  383. package/dist/Unify.d.ts +19 -19
  384. package/dist/Utils.d.ts +1 -2
  385. package/dist/Utils.d.ts.map +1 -1
  386. package/dist/Utils.js +1 -2
  387. package/dist/Utils.js.map +1 -1
  388. package/dist/testing/TestSchema.d.ts +3 -11
  389. package/dist/testing/TestSchema.d.ts.map +1 -1
  390. package/dist/testing/TestSchema.js +3 -11
  391. package/dist/testing/TestSchema.js.map +1 -1
  392. package/dist/unstable/ai/AiError.d.ts +10 -5
  393. package/dist/unstable/ai/AiError.d.ts.map +1 -1
  394. package/dist/unstable/ai/AiError.js +10 -5
  395. package/dist/unstable/ai/AiError.js.map +1 -1
  396. package/dist/unstable/ai/Chat.d.ts +20 -5
  397. package/dist/unstable/ai/Chat.d.ts.map +1 -1
  398. package/dist/unstable/ai/Chat.js +20 -5
  399. package/dist/unstable/ai/Chat.js.map +1 -1
  400. package/dist/unstable/ai/EmbeddingModel.d.ts +5 -4
  401. package/dist/unstable/ai/EmbeddingModel.d.ts.map +1 -1
  402. package/dist/unstable/ai/EmbeddingModel.js +4 -3
  403. package/dist/unstable/ai/EmbeddingModel.js.map +1 -1
  404. package/dist/unstable/ai/IdGenerator.d.ts +7 -2
  405. package/dist/unstable/ai/IdGenerator.d.ts.map +1 -1
  406. package/dist/unstable/ai/IdGenerator.js +7 -2
  407. package/dist/unstable/ai/IdGenerator.js.map +1 -1
  408. package/dist/unstable/ai/LanguageModel.d.ts +10 -5
  409. package/dist/unstable/ai/LanguageModel.d.ts.map +1 -1
  410. package/dist/unstable/ai/LanguageModel.js +10 -5
  411. package/dist/unstable/ai/LanguageModel.js.map +1 -1
  412. package/dist/unstable/ai/McpSchema.d.ts +291 -169
  413. package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
  414. package/dist/unstable/ai/McpSchema.js +270 -147
  415. package/dist/unstable/ai/McpSchema.js.map +1 -1
  416. package/dist/unstable/ai/McpServer.d.ts +49 -13
  417. package/dist/unstable/ai/McpServer.d.ts.map +1 -1
  418. package/dist/unstable/ai/McpServer.js +21 -9
  419. package/dist/unstable/ai/McpServer.js.map +1 -1
  420. package/dist/unstable/ai/Prompt.d.ts +1 -1
  421. package/dist/unstable/ai/Prompt.js +1 -1
  422. package/dist/unstable/ai/Response.d.ts +1 -1
  423. package/dist/unstable/ai/Response.js +1 -1
  424. package/dist/unstable/ai/Tokenizer.d.ts +7 -2
  425. package/dist/unstable/ai/Tokenizer.d.ts.map +1 -1
  426. package/dist/unstable/ai/Tokenizer.js +7 -2
  427. package/dist/unstable/ai/Tokenizer.js.map +1 -1
  428. package/dist/unstable/ai/Tool.d.ts +3 -3
  429. package/dist/unstable/ai/Tool.js +3 -3
  430. package/dist/unstable/cli/CliError.d.ts +3 -3
  431. package/dist/unstable/cli/CliError.js +3 -3
  432. package/dist/unstable/cli/CliOutput.d.ts +1 -1
  433. package/dist/unstable/cli/Command.d.ts +3 -3
  434. package/dist/unstable/cli/Command.js +1 -1
  435. package/dist/unstable/cli/Flag.d.ts +9 -9
  436. package/dist/unstable/cli/Flag.js +3 -3
  437. package/dist/unstable/cli/GlobalFlag.d.ts +13 -6
  438. package/dist/unstable/cli/GlobalFlag.d.ts.map +1 -1
  439. package/dist/unstable/cli/GlobalFlag.js +13 -6
  440. package/dist/unstable/cli/GlobalFlag.js.map +1 -1
  441. package/dist/unstable/cli/Param.d.ts +2 -2
  442. package/dist/unstable/cli/Param.js +2 -2
  443. package/dist/unstable/cli/Primitive.d.ts +1 -1
  444. package/dist/unstable/cli/Primitive.js +1 -1
  445. package/dist/unstable/cli/Prompt.d.ts +11 -6
  446. package/dist/unstable/cli/Prompt.d.ts.map +1 -1
  447. package/dist/unstable/cli/Prompt.js +26 -9
  448. package/dist/unstable/cli/Prompt.js.map +1 -1
  449. package/dist/unstable/cli/internal/parser.js +1 -1
  450. package/dist/unstable/cluster/ClusterMetrics.d.ts +5 -5
  451. package/dist/unstable/cluster/ClusterMetrics.js +5 -5
  452. package/dist/unstable/cluster/ClusterSchema.d.ts +11 -2
  453. package/dist/unstable/cluster/ClusterSchema.d.ts.map +1 -1
  454. package/dist/unstable/cluster/ClusterSchema.js +11 -2
  455. package/dist/unstable/cluster/ClusterSchema.js.map +1 -1
  456. package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts.map +1 -1
  457. package/dist/unstable/cluster/ClusterWorkflowEngine.js +49 -10
  458. package/dist/unstable/cluster/ClusterWorkflowEngine.js.map +1 -1
  459. package/dist/unstable/cluster/DeliverAt.d.ts +6 -1
  460. package/dist/unstable/cluster/DeliverAt.d.ts.map +1 -1
  461. package/dist/unstable/cluster/DeliverAt.js +6 -1
  462. package/dist/unstable/cluster/DeliverAt.js.map +1 -1
  463. package/dist/unstable/cluster/Entity.d.ts +15 -5
  464. package/dist/unstable/cluster/Entity.d.ts.map +1 -1
  465. package/dist/unstable/cluster/Entity.js +15 -5
  466. package/dist/unstable/cluster/Entity.js.map +1 -1
  467. package/dist/unstable/cluster/EntityResource.d.ts +6 -6
  468. package/dist/unstable/cluster/EntityResource.d.ts.map +1 -1
  469. package/dist/unstable/cluster/EntityResource.js +9 -8
  470. package/dist/unstable/cluster/EntityResource.js.map +1 -1
  471. package/dist/unstable/cluster/Envelope.d.ts +11 -11
  472. package/dist/unstable/cluster/Envelope.d.ts.map +1 -1
  473. package/dist/unstable/cluster/Envelope.js +11 -11
  474. package/dist/unstable/cluster/Envelope.js.map +1 -1
  475. package/dist/unstable/cluster/HttpRunner.d.ts +16 -8
  476. package/dist/unstable/cluster/HttpRunner.d.ts.map +1 -1
  477. package/dist/unstable/cluster/HttpRunner.js +16 -8
  478. package/dist/unstable/cluster/HttpRunner.js.map +1 -1
  479. package/dist/unstable/cluster/Message.d.ts +10 -10
  480. package/dist/unstable/cluster/Message.js +10 -10
  481. package/dist/unstable/cluster/MessageStorage.d.ts +7 -7
  482. package/dist/unstable/cluster/MessageStorage.js +6 -6
  483. package/dist/unstable/cluster/Reply.d.ts +18 -8
  484. package/dist/unstable/cluster/Reply.d.ts.map +1 -1
  485. package/dist/unstable/cluster/Reply.js +18 -8
  486. package/dist/unstable/cluster/Reply.js.map +1 -1
  487. package/dist/unstable/cluster/Runner.d.ts +1 -1
  488. package/dist/unstable/cluster/Runner.js +1 -1
  489. package/dist/unstable/cluster/RunnerAddress.d.ts +7 -1
  490. package/dist/unstable/cluster/RunnerAddress.d.ts.map +1 -1
  491. package/dist/unstable/cluster/RunnerAddress.js +7 -1
  492. package/dist/unstable/cluster/RunnerAddress.js.map +1 -1
  493. package/dist/unstable/cluster/RunnerHealth.d.ts +4 -4
  494. package/dist/unstable/cluster/RunnerHealth.js +4 -4
  495. package/dist/unstable/cluster/RunnerServer.d.ts +4 -3
  496. package/dist/unstable/cluster/RunnerServer.d.ts.map +1 -1
  497. package/dist/unstable/cluster/RunnerServer.js +4 -3
  498. package/dist/unstable/cluster/RunnerServer.js.map +1 -1
  499. package/dist/unstable/cluster/Runners.d.ts +1 -1
  500. package/dist/unstable/cluster/ShardId.d.ts +2 -2
  501. package/dist/unstable/cluster/ShardId.js +2 -2
  502. package/dist/unstable/cluster/Sharding.d.ts +8 -3
  503. package/dist/unstable/cluster/Sharding.d.ts.map +1 -1
  504. package/dist/unstable/cluster/Sharding.js +8 -3
  505. package/dist/unstable/cluster/Sharding.js.map +1 -1
  506. package/dist/unstable/cluster/ShardingConfig.d.ts +3 -3
  507. package/dist/unstable/cluster/ShardingConfig.js +3 -3
  508. package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts +1 -2
  509. package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts.map +1 -1
  510. package/dist/unstable/cluster/ShardingRegistrationEvent.js +1 -2
  511. package/dist/unstable/cluster/ShardingRegistrationEvent.js.map +1 -1
  512. package/dist/unstable/cluster/SingleRunner.d.ts +1 -1
  513. package/dist/unstable/cluster/SingleRunner.js +1 -1
  514. package/dist/unstable/cluster/Snowflake.d.ts +6 -5
  515. package/dist/unstable/cluster/Snowflake.d.ts.map +1 -1
  516. package/dist/unstable/cluster/Snowflake.js +6 -5
  517. package/dist/unstable/cluster/Snowflake.js.map +1 -1
  518. package/dist/unstable/cluster/SocketRunner.d.ts +6 -1
  519. package/dist/unstable/cluster/SocketRunner.d.ts.map +1 -1
  520. package/dist/unstable/cluster/SocketRunner.js +6 -1
  521. package/dist/unstable/cluster/SocketRunner.js.map +1 -1
  522. package/dist/unstable/cluster/TestRunner.d.ts +1 -1
  523. package/dist/unstable/cluster/TestRunner.js +1 -1
  524. package/dist/unstable/encoding/Msgpack.d.ts +2 -1
  525. package/dist/unstable/encoding/Msgpack.d.ts.map +1 -1
  526. package/dist/unstable/encoding/Msgpack.js +2 -1
  527. package/dist/unstable/encoding/Msgpack.js.map +1 -1
  528. package/dist/unstable/encoding/Sse.d.ts +3 -3
  529. package/dist/unstable/encoding/Sse.js +3 -3
  530. package/dist/unstable/eventlog/EventGroup.d.ts +1 -1
  531. package/dist/unstable/eventlog/EventGroup.js +1 -1
  532. package/dist/unstable/eventlog/EventJournal.d.ts +7 -7
  533. package/dist/unstable/eventlog/EventJournal.js +5 -5
  534. package/dist/unstable/eventlog/EventLog.d.ts +11 -10
  535. package/dist/unstable/eventlog/EventLog.d.ts.map +1 -1
  536. package/dist/unstable/eventlog/EventLog.js +9 -8
  537. package/dist/unstable/eventlog/EventLog.js.map +1 -1
  538. package/dist/unstable/eventlog/EventLogEncryption.d.ts +8 -3
  539. package/dist/unstable/eventlog/EventLogEncryption.d.ts.map +1 -1
  540. package/dist/unstable/eventlog/EventLogEncryption.js +8 -3
  541. package/dist/unstable/eventlog/EventLogEncryption.js.map +1 -1
  542. package/dist/unstable/eventlog/EventLogMessage.d.ts +28 -28
  543. package/dist/unstable/eventlog/EventLogMessage.d.ts.map +1 -1
  544. package/dist/unstable/eventlog/EventLogMessage.js +27 -27
  545. package/dist/unstable/eventlog/EventLogMessage.js.map +1 -1
  546. package/dist/unstable/eventlog/EventLogRemote.d.ts +14 -4
  547. package/dist/unstable/eventlog/EventLogRemote.d.ts.map +1 -1
  548. package/dist/unstable/eventlog/EventLogRemote.js +14 -4
  549. package/dist/unstable/eventlog/EventLogRemote.js.map +1 -1
  550. package/dist/unstable/eventlog/EventLogServer.d.ts +7 -2
  551. package/dist/unstable/eventlog/EventLogServer.d.ts.map +1 -1
  552. package/dist/unstable/eventlog/EventLogServer.js +7 -2
  553. package/dist/unstable/eventlog/EventLogServer.js.map +1 -1
  554. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts +7 -2
  555. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts.map +1 -1
  556. package/dist/unstable/eventlog/EventLogServerEncrypted.js +7 -2
  557. package/dist/unstable/eventlog/EventLogServerEncrypted.js.map +1 -1
  558. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +37 -7
  559. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts.map +1 -1
  560. package/dist/unstable/eventlog/EventLogServerUnencrypted.js +37 -7
  561. package/dist/unstable/eventlog/EventLogServerUnencrypted.js.map +1 -1
  562. package/dist/unstable/eventlog/EventLogSessionAuth.d.ts +33 -7
  563. package/dist/unstable/eventlog/EventLogSessionAuth.d.ts.map +1 -1
  564. package/dist/unstable/eventlog/EventLogSessionAuth.js +33 -7
  565. package/dist/unstable/eventlog/EventLogSessionAuth.js.map +1 -1
  566. package/dist/unstable/http/Cookies.d.ts +40 -39
  567. package/dist/unstable/http/Cookies.d.ts.map +1 -1
  568. package/dist/unstable/http/Cookies.js +18 -17
  569. package/dist/unstable/http/Cookies.js.map +1 -1
  570. package/dist/unstable/http/FetchHttpClient.d.ts +6 -1
  571. package/dist/unstable/http/FetchHttpClient.d.ts.map +1 -1
  572. package/dist/unstable/http/FetchHttpClient.js +6 -1
  573. package/dist/unstable/http/FetchHttpClient.js.map +1 -1
  574. package/dist/unstable/http/Headers.d.ts +8 -7
  575. package/dist/unstable/http/Headers.d.ts.map +1 -1
  576. package/dist/unstable/http/Headers.js +6 -5
  577. package/dist/unstable/http/Headers.js.map +1 -1
  578. package/dist/unstable/http/HttpBody.d.ts +6 -2
  579. package/dist/unstable/http/HttpBody.d.ts.map +1 -1
  580. package/dist/unstable/http/HttpBody.js +6 -2
  581. package/dist/unstable/http/HttpBody.js.map +1 -1
  582. package/dist/unstable/http/HttpClient.d.ts +29 -9
  583. package/dist/unstable/http/HttpClient.d.ts.map +1 -1
  584. package/dist/unstable/http/HttpClient.js +15 -5
  585. package/dist/unstable/http/HttpClient.js.map +1 -1
  586. package/dist/unstable/http/HttpClientError.d.ts +15 -14
  587. package/dist/unstable/http/HttpClientError.d.ts.map +1 -1
  588. package/dist/unstable/http/HttpClientError.js +12 -11
  589. package/dist/unstable/http/HttpClientError.js.map +1 -1
  590. package/dist/unstable/http/HttpClientRequest.d.ts +1 -1
  591. package/dist/unstable/http/HttpClientRequest.js +1 -1
  592. package/dist/unstable/http/HttpEffect.d.ts +3 -3
  593. package/dist/unstable/http/HttpEffect.js +3 -3
  594. package/dist/unstable/http/HttpMethod.d.ts +16 -5
  595. package/dist/unstable/http/HttpMethod.d.ts.map +1 -1
  596. package/dist/unstable/http/HttpMethod.js +16 -5
  597. package/dist/unstable/http/HttpMethod.js.map +1 -1
  598. package/dist/unstable/http/HttpRouter.d.ts +18 -13
  599. package/dist/unstable/http/HttpRouter.d.ts.map +1 -1
  600. package/dist/unstable/http/HttpRouter.js +14 -9
  601. package/dist/unstable/http/HttpRouter.js.map +1 -1
  602. package/dist/unstable/http/HttpServer.d.ts +4 -4
  603. package/dist/unstable/http/HttpServer.js +4 -4
  604. package/dist/unstable/http/HttpServerError.d.ts +9 -9
  605. package/dist/unstable/http/HttpServerError.js +7 -7
  606. package/dist/unstable/http/HttpServerRequest.d.ts +20 -5
  607. package/dist/unstable/http/HttpServerRequest.d.ts.map +1 -1
  608. package/dist/unstable/http/HttpServerRequest.js +20 -5
  609. package/dist/unstable/http/HttpServerRequest.js.map +1 -1
  610. package/dist/unstable/http/HttpServerResponse.d.ts +24 -24
  611. package/dist/unstable/http/HttpServerResponse.js +8 -8
  612. package/dist/unstable/http/HttpTraceContext.d.ts +4 -4
  613. package/dist/unstable/http/HttpTraceContext.js +4 -4
  614. package/dist/unstable/http/Multipart.d.ts +2 -2
  615. package/dist/unstable/http/Multipart.js +2 -2
  616. package/dist/unstable/http/Url.d.ts +14 -17
  617. package/dist/unstable/http/Url.d.ts.map +1 -1
  618. package/dist/unstable/http/Url.js +5 -6
  619. package/dist/unstable/http/Url.js.map +1 -1
  620. package/dist/unstable/http/UrlParams.d.ts +10 -10
  621. package/dist/unstable/http/UrlParams.js +6 -6
  622. package/dist/unstable/httpapi/HttpApi.d.ts +2 -2
  623. package/dist/unstable/httpapi/HttpApi.js +2 -2
  624. package/dist/unstable/httpapi/HttpApiBuilder.d.ts +3 -3
  625. package/dist/unstable/httpapi/HttpApiBuilder.js +4 -5
  626. package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
  627. package/dist/unstable/httpapi/HttpApiError.d.ts +2 -2
  628. package/dist/unstable/httpapi/HttpApiError.js +1 -1
  629. package/dist/unstable/httpapi/HttpApiSchema.d.ts +4 -7
  630. package/dist/unstable/httpapi/HttpApiSchema.d.ts.map +1 -1
  631. package/dist/unstable/httpapi/HttpApiSchema.js +3 -6
  632. package/dist/unstable/httpapi/HttpApiSchema.js.map +1 -1
  633. package/dist/unstable/httpapi/HttpApiSecurity.d.ts +27 -5
  634. package/dist/unstable/httpapi/HttpApiSecurity.d.ts.map +1 -1
  635. package/dist/unstable/httpapi/HttpApiSecurity.js +26 -3
  636. package/dist/unstable/httpapi/HttpApiSecurity.js.map +1 -1
  637. package/dist/unstable/httpapi/HttpApiTest.d.ts +1 -1
  638. package/dist/unstable/httpapi/HttpApiTest.js +1 -1
  639. package/dist/unstable/httpapi/OpenApi.d.ts +7 -1
  640. package/dist/unstable/httpapi/OpenApi.d.ts.map +1 -1
  641. package/dist/unstable/httpapi/OpenApi.js +9 -3
  642. package/dist/unstable/httpapi/OpenApi.js.map +1 -1
  643. package/dist/unstable/observability/OtlpLogger.d.ts +1 -1
  644. package/dist/unstable/observability/OtlpLogger.js +1 -1
  645. package/dist/unstable/observability/PrometheusMetrics.d.ts +2 -2
  646. package/dist/unstable/observability/PrometheusMetrics.js +2 -2
  647. package/dist/unstable/persistence/KeyValueStore.d.ts +8 -3
  648. package/dist/unstable/persistence/KeyValueStore.d.ts.map +1 -1
  649. package/dist/unstable/persistence/KeyValueStore.js +6 -1
  650. package/dist/unstable/persistence/KeyValueStore.js.map +1 -1
  651. package/dist/unstable/persistence/Persistable.d.ts +8 -3
  652. package/dist/unstable/persistence/Persistable.d.ts.map +1 -1
  653. package/dist/unstable/persistence/Persistable.js +8 -3
  654. package/dist/unstable/persistence/Persistable.js.map +1 -1
  655. package/dist/unstable/persistence/PersistedQueue.d.ts +10 -5
  656. package/dist/unstable/persistence/PersistedQueue.d.ts.map +1 -1
  657. package/dist/unstable/persistence/PersistedQueue.js +9 -4
  658. package/dist/unstable/persistence/PersistedQueue.js.map +1 -1
  659. package/dist/unstable/persistence/RateLimiter.d.ts +20 -10
  660. package/dist/unstable/persistence/RateLimiter.d.ts.map +1 -1
  661. package/dist/unstable/persistence/RateLimiter.js +19 -9
  662. package/dist/unstable/persistence/RateLimiter.js.map +1 -1
  663. package/dist/unstable/process/ChildProcess.d.ts +14 -14
  664. package/dist/unstable/process/ChildProcess.js +7 -7
  665. package/dist/unstable/process/ChildProcessSpawner.d.ts +2 -2
  666. package/dist/unstable/process/ChildProcessSpawner.js +2 -2
  667. package/dist/unstable/reactivity/AsyncResult.d.ts +36 -5
  668. package/dist/unstable/reactivity/AsyncResult.d.ts.map +1 -1
  669. package/dist/unstable/reactivity/AsyncResult.js +14 -3
  670. package/dist/unstable/reactivity/AsyncResult.js.map +1 -1
  671. package/dist/unstable/reactivity/Atom.d.ts +45 -13
  672. package/dist/unstable/reactivity/Atom.d.ts.map +1 -1
  673. package/dist/unstable/reactivity/Atom.js +34 -10
  674. package/dist/unstable/reactivity/Atom.js.map +1 -1
  675. package/dist/unstable/reactivity/AtomRegistry.d.ts +7 -2
  676. package/dist/unstable/reactivity/AtomRegistry.d.ts.map +1 -1
  677. package/dist/unstable/reactivity/AtomRegistry.js +7 -2
  678. package/dist/unstable/reactivity/AtomRegistry.js.map +1 -1
  679. package/dist/unstable/reactivity/Hydration.d.ts +6 -1
  680. package/dist/unstable/reactivity/Hydration.d.ts.map +1 -1
  681. package/dist/unstable/reactivity/Hydration.js +6 -1
  682. package/dist/unstable/reactivity/Hydration.js.map +1 -1
  683. package/dist/unstable/reactivity/Reactivity.d.ts +6 -1
  684. package/dist/unstable/reactivity/Reactivity.d.ts.map +1 -1
  685. package/dist/unstable/reactivity/Reactivity.js +6 -1
  686. package/dist/unstable/reactivity/Reactivity.js.map +1 -1
  687. package/dist/unstable/rpc/Rpc.d.ts +18 -14
  688. package/dist/unstable/rpc/Rpc.d.ts.map +1 -1
  689. package/dist/unstable/rpc/Rpc.js +15 -11
  690. package/dist/unstable/rpc/Rpc.js.map +1 -1
  691. package/dist/unstable/rpc/RpcClient.d.ts +27 -12
  692. package/dist/unstable/rpc/RpcClient.d.ts.map +1 -1
  693. package/dist/unstable/rpc/RpcClient.js +27 -12
  694. package/dist/unstable/rpc/RpcClient.js.map +1 -1
  695. package/dist/unstable/rpc/RpcClientError.d.ts +2 -2
  696. package/dist/unstable/rpc/RpcClientError.js +2 -2
  697. package/dist/unstable/rpc/RpcMessage.d.ts +5 -5
  698. package/dist/unstable/rpc/RpcMessage.js +4 -4
  699. package/dist/unstable/rpc/RpcSchema.d.ts +1 -1
  700. package/dist/unstable/rpc/RpcSchema.js +1 -1
  701. package/dist/unstable/rpc/RpcSerialization.d.ts +19 -12
  702. package/dist/unstable/rpc/RpcSerialization.d.ts.map +1 -1
  703. package/dist/unstable/rpc/RpcSerialization.js +19 -12
  704. package/dist/unstable/rpc/RpcSerialization.js.map +1 -1
  705. package/dist/unstable/rpc/RpcServer.d.ts +22 -17
  706. package/dist/unstable/rpc/RpcServer.d.ts.map +1 -1
  707. package/dist/unstable/rpc/RpcServer.js +22 -17
  708. package/dist/unstable/rpc/RpcServer.js.map +1 -1
  709. package/dist/unstable/schema/Model.d.ts +32 -33
  710. package/dist/unstable/schema/Model.d.ts.map +1 -1
  711. package/dist/unstable/schema/Model.js +25 -26
  712. package/dist/unstable/schema/Model.js.map +1 -1
  713. package/dist/unstable/schema/VariantSchema.d.ts +1 -1
  714. package/dist/unstable/schema/VariantSchema.js +1 -1
  715. package/dist/unstable/socket/Socket.d.ts +8 -2
  716. package/dist/unstable/socket/Socket.d.ts.map +1 -1
  717. package/dist/unstable/socket/Socket.js +8 -2
  718. package/dist/unstable/socket/Socket.js.map +1 -1
  719. package/dist/unstable/socket/SocketServer.d.ts +2 -2
  720. package/dist/unstable/socket/SocketServer.js +1 -1
  721. package/dist/unstable/sql/SqlClient.d.ts +7 -2
  722. package/dist/unstable/sql/SqlClient.d.ts.map +1 -1
  723. package/dist/unstable/sql/SqlClient.js +7 -2
  724. package/dist/unstable/sql/SqlClient.js.map +1 -1
  725. package/dist/unstable/sql/SqlConnection.d.ts +1 -1
  726. package/dist/unstable/sql/SqlConnection.js +1 -1
  727. package/dist/unstable/sql/SqlError.d.ts +2 -2
  728. package/dist/unstable/sql/SqlError.js +2 -2
  729. package/dist/unstable/sql/SqlResolver.d.ts +3 -3
  730. package/dist/unstable/sql/SqlResolver.js +1 -1
  731. package/dist/unstable/sql/SqlSchema.d.ts +19 -4
  732. package/dist/unstable/sql/SqlSchema.d.ts.map +1 -1
  733. package/dist/unstable/sql/SqlSchema.js +19 -4
  734. package/dist/unstable/sql/SqlSchema.js.map +1 -1
  735. package/dist/unstable/workers/Transferable.d.ts +3 -6
  736. package/dist/unstable/workers/Transferable.d.ts.map +1 -1
  737. package/dist/unstable/workers/Transferable.js +3 -6
  738. package/dist/unstable/workers/Transferable.js.map +1 -1
  739. package/dist/unstable/workers/Worker.d.ts +1 -1
  740. package/dist/unstable/workers/Worker.js +1 -1
  741. package/dist/unstable/workers/WorkerError.d.ts +1 -1
  742. package/dist/unstable/workflow/DurableClock.d.ts +2 -2
  743. package/dist/unstable/workflow/DurableClock.js +2 -2
  744. package/dist/unstable/workflow/DurableDeferred.d.ts +12 -12
  745. package/dist/unstable/workflow/DurableDeferred.js +7 -7
  746. package/dist/unstable/workflow/DurableQueue.d.ts +3 -3
  747. package/dist/unstable/workflow/DurableQueue.js +3 -3
  748. package/dist/unstable/workflow/Workflow.d.ts +22 -23
  749. package/dist/unstable/workflow/Workflow.d.ts.map +1 -1
  750. package/dist/unstable/workflow/Workflow.js +17 -18
  751. package/dist/unstable/workflow/Workflow.js.map +1 -1
  752. package/dist/unstable/workflow/WorkflowEngine.d.ts +26 -8
  753. package/dist/unstable/workflow/WorkflowEngine.d.ts.map +1 -1
  754. package/dist/unstable/workflow/WorkflowEngine.js +25 -7
  755. package/dist/unstable/workflow/WorkflowEngine.js.map +1 -1
  756. package/package.json +1 -1
  757. package/src/Array.ts +65 -113
  758. package/src/BigDecimal.ts +66 -58
  759. package/src/BigInt.ts +21 -19
  760. package/src/Boolean.ts +15 -17
  761. package/src/Brand.ts +2 -3
  762. package/src/Cache.ts +9 -9
  763. package/src/Cause.ts +35 -39
  764. package/src/Channel.ts +149 -107
  765. package/src/ChannelSchema.ts +3 -3
  766. package/src/Chunk.ts +67 -54
  767. package/src/Clock.ts +3 -3
  768. package/src/Combiner.ts +6 -10
  769. package/src/Config.ts +9 -10
  770. package/src/ConfigProvider.ts +4 -4
  771. package/src/Console.ts +11 -7
  772. package/src/Context.ts +36 -36
  773. package/src/Cron.ts +7 -6
  774. package/src/Crypto.ts +1 -1
  775. package/src/Data.ts +26 -32
  776. package/src/DateTime.ts +164 -122
  777. package/src/Deferred.ts +6 -6
  778. package/src/Duration.ts +39 -39
  779. package/src/Effect.ts +220 -309
  780. package/src/Effectable.ts +2 -2
  781. package/src/Encoding.ts +13 -10
  782. package/src/Equal.ts +3 -4
  783. package/src/Equivalence.ts +5 -19
  784. package/src/ErrorReporter.ts +14 -13
  785. package/src/ExecutionPlan.ts +7 -2
  786. package/src/Exit.ts +25 -23
  787. package/src/Fiber.ts +4 -4
  788. package/src/FiberHandle.ts +6 -6
  789. package/src/FiberMap.ts +20 -20
  790. package/src/FiberSet.ts +21 -13
  791. package/src/FileSystem.ts +13 -9
  792. package/src/Filter.ts +2 -2
  793. package/src/Formatter.ts +1 -3
  794. package/src/Function.ts +12 -12
  795. package/src/Graph.ts +22 -22
  796. package/src/HKT.ts +5 -4
  797. package/src/Hash.ts +3 -3
  798. package/src/HashMap.ts +33 -35
  799. package/src/HashRing.ts +7 -9
  800. package/src/HashSet.ts +16 -16
  801. package/src/Inspectable.ts +4 -4
  802. package/src/Iterable.ts +82 -56
  803. package/src/JsonPatch.ts +1 -1
  804. package/src/JsonPointer.ts +3 -3
  805. package/src/JsonSchema.ts +13 -23
  806. package/src/Latch.ts +2 -2
  807. package/src/Layer.ts +47 -27
  808. package/src/LayerMap.ts +1 -2
  809. package/src/LogLevel.ts +3 -3
  810. package/src/Logger.ts +6 -6
  811. package/src/ManagedRuntime.ts +1 -1
  812. package/src/Match.ts +32 -37
  813. package/src/Metric.ts +35 -21
  814. package/src/MutableHashMap.ts +21 -31
  815. package/src/MutableHashSet.ts +4 -4
  816. package/src/MutableList.ts +16 -6
  817. package/src/MutableRef.ts +5 -4
  818. package/src/NonEmptyIterable.ts +3 -3
  819. package/src/Number.ts +20 -18
  820. package/src/Optic.ts +11 -18
  821. package/src/Option.ts +21 -24
  822. package/src/Order.ts +11 -38
  823. package/src/Ordering.ts +5 -5
  824. package/src/PartitionedSemaphore.ts +4 -8
  825. package/src/Path.ts +4 -7
  826. package/src/Pipeable.ts +2 -2
  827. package/src/PlatformError.ts +1 -1
  828. package/src/Predicate.ts +2 -81
  829. package/src/PrimaryKey.ts +3 -3
  830. package/src/PubSub.ts +147 -46
  831. package/src/Pull.ts +1 -1
  832. package/src/Queue.ts +40 -24
  833. package/src/RcMap.ts +3 -3
  834. package/src/Record.ts +79 -52
  835. package/src/Redactable.ts +7 -7
  836. package/src/Reducer.ts +0 -2
  837. package/src/Ref.ts +32 -32
  838. package/src/References.ts +20 -20
  839. package/src/RegExp.ts +2 -2
  840. package/src/Request.ts +3 -3
  841. package/src/RequestResolver.ts +11 -14
  842. package/src/Result.ts +52 -34
  843. package/src/Runtime.ts +1 -1
  844. package/src/Schedule.ts +28 -36
  845. package/src/Scheduler.ts +3 -3
  846. package/src/Schema.ts +480 -210
  847. package/src/SchemaAST.ts +40 -32
  848. package/src/SchemaGetter.ts +4 -6
  849. package/src/SchemaIssue.ts +35 -47
  850. package/src/SchemaParser.ts +16 -12
  851. package/src/SchemaRepresentation.ts +47 -62
  852. package/src/SchemaTransformation.ts +16 -18
  853. package/src/Scope.ts +51 -14
  854. package/src/ScopedCache.ts +14 -14
  855. package/src/ScopedRef.ts +2 -2
  856. package/src/Semaphore.ts +1 -1
  857. package/src/Sink.ts +36 -41
  858. package/src/Stdio.ts +5 -4
  859. package/src/Stream.ts +275 -176
  860. package/src/String.ts +50 -49
  861. package/src/Struct.ts +35 -100
  862. package/src/SubscriptionRef.ts +268 -91
  863. package/src/Symbol.ts +1 -1
  864. package/src/SynchronizedRef.ts +27 -27
  865. package/src/Terminal.ts +8 -3
  866. package/src/Tracer.ts +25 -7
  867. package/src/Trie.ts +21 -23
  868. package/src/Tuple.ts +26 -73
  869. package/src/TxChunk.ts +2 -2
  870. package/src/TxHashMap.ts +22 -22
  871. package/src/TxHashSet.ts +22 -22
  872. package/src/TxPriorityQueue.ts +14 -6
  873. package/src/TxPubSub.ts +4 -4
  874. package/src/TxQueue.ts +10 -10
  875. package/src/TxReentrantLock.ts +48 -12
  876. package/src/TxRef.ts +1 -1
  877. package/src/TxSubscriptionRef.ts +1 -1
  878. package/src/Types.ts +8 -7
  879. package/src/Unify.ts +19 -19
  880. package/src/Utils.ts +1 -2
  881. package/src/testing/TestSchema.ts +3 -11
  882. package/src/unstable/ai/AiError.ts +10 -5
  883. package/src/unstable/ai/Chat.ts +20 -5
  884. package/src/unstable/ai/EmbeddingModel.ts +5 -4
  885. package/src/unstable/ai/IdGenerator.ts +7 -2
  886. package/src/unstable/ai/LanguageModel.ts +10 -5
  887. package/src/unstable/ai/McpSchema.ts +291 -169
  888. package/src/unstable/ai/McpServer.ts +49 -13
  889. package/src/unstable/ai/Prompt.ts +1 -1
  890. package/src/unstable/ai/Response.ts +1 -1
  891. package/src/unstable/ai/Tokenizer.ts +7 -2
  892. package/src/unstable/ai/Tool.ts +3 -3
  893. package/src/unstable/cli/CliError.ts +3 -3
  894. package/src/unstable/cli/CliOutput.ts +1 -1
  895. package/src/unstable/cli/Command.ts +3 -3
  896. package/src/unstable/cli/Flag.ts +9 -9
  897. package/src/unstable/cli/GlobalFlag.ts +13 -6
  898. package/src/unstable/cli/Param.ts +2 -2
  899. package/src/unstable/cli/Primitive.ts +1 -1
  900. package/src/unstable/cli/Prompt.ts +37 -13
  901. package/src/unstable/cli/internal/parser.ts +1 -1
  902. package/src/unstable/cluster/ClusterMetrics.ts +5 -5
  903. package/src/unstable/cluster/ClusterSchema.ts +11 -2
  904. package/src/unstable/cluster/ClusterWorkflowEngine.ts +63 -11
  905. package/src/unstable/cluster/DeliverAt.ts +6 -1
  906. package/src/unstable/cluster/Entity.ts +15 -5
  907. package/src/unstable/cluster/EntityResource.ts +13 -10
  908. package/src/unstable/cluster/Envelope.ts +11 -11
  909. package/src/unstable/cluster/HttpRunner.ts +16 -8
  910. package/src/unstable/cluster/Message.ts +10 -10
  911. package/src/unstable/cluster/MessageStorage.ts +7 -7
  912. package/src/unstable/cluster/Reply.ts +18 -8
  913. package/src/unstable/cluster/Runner.ts +1 -1
  914. package/src/unstable/cluster/RunnerAddress.ts +7 -1
  915. package/src/unstable/cluster/RunnerHealth.ts +4 -4
  916. package/src/unstable/cluster/RunnerServer.ts +4 -3
  917. package/src/unstable/cluster/Runners.ts +1 -1
  918. package/src/unstable/cluster/ShardId.ts +2 -2
  919. package/src/unstable/cluster/Sharding.ts +8 -3
  920. package/src/unstable/cluster/ShardingConfig.ts +3 -3
  921. package/src/unstable/cluster/ShardingRegistrationEvent.ts +1 -2
  922. package/src/unstable/cluster/SingleRunner.ts +1 -1
  923. package/src/unstable/cluster/Snowflake.ts +6 -5
  924. package/src/unstable/cluster/SocketRunner.ts +6 -1
  925. package/src/unstable/cluster/TestRunner.ts +1 -1
  926. package/src/unstable/encoding/Msgpack.ts +2 -1
  927. package/src/unstable/encoding/Sse.ts +3 -3
  928. package/src/unstable/eventlog/EventGroup.ts +1 -1
  929. package/src/unstable/eventlog/EventJournal.ts +7 -7
  930. package/src/unstable/eventlog/EventLog.ts +11 -10
  931. package/src/unstable/eventlog/EventLogEncryption.ts +8 -3
  932. package/src/unstable/eventlog/EventLogMessage.ts +28 -28
  933. package/src/unstable/eventlog/EventLogRemote.ts +14 -4
  934. package/src/unstable/eventlog/EventLogServer.ts +7 -2
  935. package/src/unstable/eventlog/EventLogServerEncrypted.ts +7 -2
  936. package/src/unstable/eventlog/EventLogServerUnencrypted.ts +37 -7
  937. package/src/unstable/eventlog/EventLogSessionAuth.ts +33 -7
  938. package/src/unstable/http/Cookies.ts +40 -39
  939. package/src/unstable/http/FetchHttpClient.ts +6 -1
  940. package/src/unstable/http/Headers.ts +10 -9
  941. package/src/unstable/http/HttpBody.ts +6 -2
  942. package/src/unstable/http/HttpClient.ts +29 -9
  943. package/src/unstable/http/HttpClientError.ts +15 -14
  944. package/src/unstable/http/HttpClientRequest.ts +1 -1
  945. package/src/unstable/http/HttpEffect.ts +3 -3
  946. package/src/unstable/http/HttpMethod.ts +16 -5
  947. package/src/unstable/http/HttpRouter.ts +18 -13
  948. package/src/unstable/http/HttpServer.ts +4 -4
  949. package/src/unstable/http/HttpServerError.ts +9 -9
  950. package/src/unstable/http/HttpServerRequest.ts +20 -5
  951. package/src/unstable/http/HttpServerResponse.ts +24 -24
  952. package/src/unstable/http/HttpTraceContext.ts +4 -4
  953. package/src/unstable/http/Multipart.ts +2 -2
  954. package/src/unstable/http/Url.ts +14 -17
  955. package/src/unstable/http/UrlParams.ts +10 -10
  956. package/src/unstable/httpapi/HttpApi.ts +2 -2
  957. package/src/unstable/httpapi/HttpApiBuilder.ts +5 -6
  958. package/src/unstable/httpapi/HttpApiError.ts +2 -2
  959. package/src/unstable/httpapi/HttpApiSchema.ts +4 -7
  960. package/src/unstable/httpapi/HttpApiSecurity.ts +36 -8
  961. package/src/unstable/httpapi/HttpApiTest.ts +1 -1
  962. package/src/unstable/httpapi/OpenApi.ts +9 -3
  963. package/src/unstable/observability/OtlpLogger.ts +1 -1
  964. package/src/unstable/observability/PrometheusMetrics.ts +2 -2
  965. package/src/unstable/persistence/KeyValueStore.ts +8 -3
  966. package/src/unstable/persistence/Persistable.ts +8 -3
  967. package/src/unstable/persistence/PersistedQueue.ts +10 -5
  968. package/src/unstable/persistence/RateLimiter.ts +20 -10
  969. package/src/unstable/process/ChildProcess.ts +14 -14
  970. package/src/unstable/process/ChildProcessSpawner.ts +2 -2
  971. package/src/unstable/reactivity/AsyncResult.ts +58 -7
  972. package/src/unstable/reactivity/Atom.ts +53 -13
  973. package/src/unstable/reactivity/AtomRegistry.ts +7 -2
  974. package/src/unstable/reactivity/Hydration.ts +6 -1
  975. package/src/unstable/reactivity/Reactivity.ts +6 -1
  976. package/src/unstable/rpc/Rpc.ts +18 -14
  977. package/src/unstable/rpc/RpcClient.ts +27 -12
  978. package/src/unstable/rpc/RpcClientError.ts +2 -2
  979. package/src/unstable/rpc/RpcMessage.ts +5 -5
  980. package/src/unstable/rpc/RpcSchema.ts +1 -1
  981. package/src/unstable/rpc/RpcSerialization.ts +19 -12
  982. package/src/unstable/rpc/RpcServer.ts +22 -17
  983. package/src/unstable/schema/Model.ts +32 -33
  984. package/src/unstable/schema/VariantSchema.ts +1 -1
  985. package/src/unstable/socket/Socket.ts +8 -2
  986. package/src/unstable/socket/SocketServer.ts +2 -2
  987. package/src/unstable/sql/SqlClient.ts +7 -2
  988. package/src/unstable/sql/SqlConnection.ts +1 -1
  989. package/src/unstable/sql/SqlError.ts +2 -2
  990. package/src/unstable/sql/SqlResolver.ts +3 -3
  991. package/src/unstable/sql/SqlSchema.ts +19 -4
  992. package/src/unstable/workers/Transferable.ts +3 -6
  993. package/src/unstable/workers/Worker.ts +1 -1
  994. package/src/unstable/workers/WorkerError.ts +1 -1
  995. package/src/unstable/workflow/DurableClock.ts +2 -2
  996. package/src/unstable/workflow/DurableDeferred.ts +12 -12
  997. package/src/unstable/workflow/DurableQueue.ts +3 -3
  998. package/src/unstable/workflow/Workflow.ts +22 -23
  999. package/src/unstable/workflow/WorkflowEngine.ts +26 -8
package/dist/Stream.d.ts CHANGED
@@ -111,7 +111,7 @@ import type * as Unify from "./Unify.ts";
111
111
  /**
112
112
  * String literal type used as the unique brand for `Stream` values.
113
113
  *
114
- * @category Type Identifiers
114
+ * @category type IDs
115
115
  * @since 4.0.0
116
116
  */
117
117
  export type TypeId = "~effect/Stream";
@@ -119,14 +119,14 @@ export type TypeId = "~effect/Stream";
119
119
  * Runtime identifier stored on `Stream` values and used by `isStream` to
120
120
  * recognize them.
121
121
  *
122
- * **When to use**
122
+ * **Details**
123
123
  *
124
- * Use when implementing low-level `Stream` integrations that need direct access
125
- * to the runtime brand checked by `isStream`.
124
+ * This marker is part of the runtime representation of `Stream` values. Prefer
125
+ * `isStream` when narrowing unknown values.
126
126
  *
127
127
  * @see {@link isStream} for the public guard that checks this identifier
128
128
  *
129
- * @category Type Identifiers
129
+ * @category type IDs
130
130
  * @since 4.0.0
131
131
  */
132
132
  export declare const TypeId: TypeId;
@@ -366,8 +366,7 @@ export type HaltStrategy = Channel.HaltStrategy;
366
366
  */
367
367
  export declare const fromChannel: <Arr extends Arr.NonEmptyReadonlyArray<any>, E, R>(channel: Channel.Channel<Arr, E, void, unknown, unknown, unknown, R>) => Stream<Arr extends Arr.NonEmptyReadonlyArray<infer A> ? A : never, E, R>;
368
368
  /**
369
- * Either emits the success value of this effect or terminates the stream
370
- * with the failure value of this effect.
369
+ * Creates a stream from an effect.
371
370
  *
372
371
  * **Example** (Creating a stream from an effect)
373
372
  *
@@ -425,6 +424,11 @@ export declare const service: <I, S>(service: Context.Key<I, S>) => Stream<S, ne
425
424
  * Optionally accesses a service from the context and emits the result as a
426
425
  * single element.
427
426
  *
427
+ * **When to use**
428
+ *
429
+ * Use to emit an optional dependency as a stream element without requiring that
430
+ * dependency to be present.
431
+ *
428
432
  * **Example** (Accessing an optional service as a stream)
429
433
  *
430
434
  * ```ts
@@ -589,7 +593,7 @@ export declare const tick: (interval: Duration.Input) => Stream<void>;
589
593
  */
590
594
  export declare const fromPull: <A, E, R, EX, RX>(pull: Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E, void, R>, EX, RX>) => Stream<A, Pull.ExcludeDone<E> | EX, R | RX>;
591
595
  /**
592
- * Derive a stream by transforming its pull effect.
596
+ * Derives a stream by transforming its pull effect.
593
597
  *
594
598
  * **Example** (Transforming a pull effect)
595
599
  *
@@ -1468,9 +1472,17 @@ export declare const fromEventListener: <A = unknown>(target: EventListener<A>,
1468
1472
  */
1469
1473
  export declare const unfold: <S, A, E, R>(s: S, f: (s: S) => Effect.Effect<readonly [A, S] | undefined, E, R>) => Stream<A, E, R>;
1470
1474
  /**
1471
- * Like `Stream.unfold`, but allows the emission of values to end one step further
1472
- * than the unfolding of the state. This is useful for embedding paginated APIs,
1473
- * hence the name.
1475
+ * Creates a stream by repeatedly evaluating an effectful page function.
1476
+ *
1477
+ * **When to use**
1478
+ *
1479
+ * Use to consume paginated APIs where each step returns a batch of values
1480
+ * together with an optional next state.
1481
+ *
1482
+ * **Details**
1483
+ *
1484
+ * This is similar to {@link unfold}, but each step can emit zero or more values
1485
+ * and independently decide whether another state should be requested.
1474
1486
  *
1475
1487
  * **Example** (Paginating stream state)
1476
1488
  *
@@ -2020,7 +2032,7 @@ export declare const flattenEffect: <Arg extends Stream<Effect.Effect<any, any,
2020
2032
  readonly unordered?: boolean | undefined;
2021
2033
  } | undefined) => [Arg] extends [Stream<Effect.Effect<infer _A, infer _EX, infer _RX>, infer _E, infer _R>] ? Stream<_A, _EX | _E, _RX | _R> : <A, EX, RX, E, R>(self: Stream<Effect.Effect<A, EX, RX>, E, R>) => Stream<A, EX | E, RX | R>;
2022
2034
  /**
2023
- * Effectfully maps over non-empty array chunks emitted by the stream.
2035
+ * Maps over non-empty array chunks emitted by the stream effectfully.
2024
2036
  *
2025
2037
  * **Example** (Effectfully mapping stream chunks)
2026
2038
  *
@@ -2047,7 +2059,7 @@ export declare const flattenEffect: <Arg extends Stream<Effect.Effect<any, any,
2047
2059
  */
2048
2060
  export declare const mapArrayEffect: {
2049
2061
  /**
2050
- * Effectfully maps over non-empty array chunks emitted by the stream.
2062
+ * Maps over non-empty array chunks emitted by the stream effectfully.
2051
2063
  *
2052
2064
  * **Example** (Effectfully mapping stream chunks)
2053
2065
  *
@@ -2074,7 +2086,7 @@ export declare const mapArrayEffect: {
2074
2086
  */
2075
2087
  <A, B, E2, R2>(f: (a: Arr.NonEmptyReadonlyArray<A>, i: number) => Effect.Effect<Arr.NonEmptyReadonlyArray<B>, E2, R2>): <E, R>(self: Stream<A, E, R>) => Stream<B, E | E2, R | R2>;
2076
2088
  /**
2077
- * Effectfully maps over non-empty array chunks emitted by the stream.
2089
+ * Maps over non-empty array chunks emitted by the stream effectfully.
2078
2090
  *
2079
2091
  * **Example** (Effectfully mapping stream chunks)
2080
2092
  *
@@ -2350,8 +2362,7 @@ export declare const tapBoth: {
2350
2362
  }): Stream<A, E | E2 | E3, R | R2 | R3>;
2351
2363
  };
2352
2364
  /**
2353
- * Sends all elements emitted by this stream to the specified sink in addition
2354
- * to emitting them.
2365
+ * Runs a sink for all stream elements while still emitting them downstream.
2355
2366
  *
2356
2367
  * **Example** (Tapping values with a sink)
2357
2368
  *
@@ -2382,8 +2393,7 @@ export declare const tapBoth: {
2382
2393
  */
2383
2394
  export declare const tapSink: {
2384
2395
  /**
2385
- * Sends all elements emitted by this stream to the specified sink in addition
2386
- * to emitting them.
2396
+ * Runs a sink for all stream elements while still emitting them downstream.
2387
2397
  *
2388
2398
  * **Example** (Tapping values with a sink)
2389
2399
  *
@@ -2414,8 +2424,7 @@ export declare const tapSink: {
2414
2424
  */
2415
2425
  <A, E2, R2>(sink: Sink.Sink<unknown, A, unknown, E2, R2>): <E, R>(self: Stream<A, E, R>) => Stream<A, E2 | E, R2 | R>;
2416
2426
  /**
2417
- * Sends all elements emitted by this stream to the specified sink in addition
2418
- * to emitting them.
2427
+ * Runs a sink for all stream elements while still emitting them downstream.
2419
2428
  *
2420
2429
  * **Example** (Tapping values with a sink)
2421
2430
  *
@@ -2880,7 +2889,7 @@ export declare const repeat: {
2880
2889
  <A, E, R, B, E2, R2>(self: Stream<A, E, R>, schedule: Schedule.Schedule<B, void, E2, R2> | (($: <SO, SE, SR>(_: Schedule.Schedule<SO, void, SE, SR>) => Schedule.Schedule<SO, void, SE, SR>) => Schedule.Schedule<B, void, E2, R2>)): Stream<A, E | E2, R | R2>;
2881
2890
  };
2882
2891
  /**
2883
- * Spaces the stream's elements according to the provided `schedule`.
2892
+ * Schedules the stream's elements according to the provided schedule.
2884
2893
  *
2885
2894
  * **Example** (Scheduling stream elements)
2886
2895
  *
@@ -2900,12 +2909,12 @@ export declare const repeat: {
2900
2909
  * // Output: [ 1, 2, 3 ]
2901
2910
  * ```
2902
2911
  *
2903
- * @category Rate Limiting
2912
+ * @category rate limiting
2904
2913
  * @since 2.0.0
2905
2914
  */
2906
2915
  export declare const schedule: {
2907
2916
  /**
2908
- * Spaces the stream's elements according to the provided `schedule`.
2917
+ * Schedules the stream's elements according to the provided schedule.
2909
2918
  *
2910
2919
  * **Example** (Scheduling stream elements)
2911
2920
  *
@@ -2925,12 +2934,12 @@ export declare const schedule: {
2925
2934
  * // Output: [ 1, 2, 3 ]
2926
2935
  * ```
2927
2936
  *
2928
- * @category Rate Limiting
2937
+ * @category rate limiting
2929
2938
  * @since 2.0.0
2930
2939
  */
2931
2940
  <X, E2, R2, A>(schedule: Schedule.Schedule<X, NoInfer<A>, E2, R2>): <E, R>(self: Stream<A, E, R>) => Stream<A, E | E2, R2 | R>;
2932
2941
  /**
2933
- * Spaces the stream's elements according to the provided `schedule`.
2942
+ * Schedules the stream's elements according to the provided schedule.
2934
2943
  *
2935
2944
  * **Example** (Scheduling stream elements)
2936
2945
  *
@@ -2950,7 +2959,7 @@ export declare const schedule: {
2950
2959
  * // Output: [ 1, 2, 3 ]
2951
2960
  * ```
2952
2961
  *
2953
- * @category Rate Limiting
2962
+ * @category rate limiting
2954
2963
  * @since 2.0.0
2955
2964
  */
2956
2965
  <A, E, R, X, E2, R2>(self: Stream<A, E, R>, schedule: Schedule.Schedule<X, NoInfer<A>, E2, R2>): Stream<A, E | E2, R | R2>;
@@ -2976,7 +2985,7 @@ export declare const schedule: {
2976
2985
  * // Output: [ 1 ]
2977
2986
  * ```
2978
2987
  *
2979
- * @category Rate Limiting
2988
+ * @category rate limiting
2980
2989
  * @since 2.0.0
2981
2990
  */
2982
2991
  export declare const timeout: {
@@ -3001,7 +3010,7 @@ export declare const timeout: {
3001
3010
  * // Output: [ 1 ]
3002
3011
  * ```
3003
3012
  *
3004
- * @category Rate Limiting
3013
+ * @category rate limiting
3005
3014
  * @since 2.0.0
3006
3015
  */
3007
3016
  (duration: Duration.Input): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E, R>;
@@ -3026,7 +3035,7 @@ export declare const timeout: {
3026
3035
  * // Output: [ 1 ]
3027
3036
  * ```
3028
3037
  *
3029
- * @category Rate Limiting
3038
+ * @category rate limiting
3030
3039
  * @since 2.0.0
3031
3040
  */
3032
3041
  <A, E, R>(self: Stream<A, E, R>, duration: Duration.Input): Stream<A, E, R>;
@@ -3052,7 +3061,7 @@ export declare const timeout: {
3052
3061
  *
3053
3062
  * @see {@link timeout} for ending the stream instead of switching to a fallback stream
3054
3063
  *
3055
- * @category Rate Limiting
3064
+ * @category rate limiting
3056
3065
  * @since 4.0.0
3057
3066
  */
3058
3067
  export declare const timeoutOrElse: {
@@ -3077,7 +3086,7 @@ export declare const timeoutOrElse: {
3077
3086
  *
3078
3087
  * @see {@link timeout} for ending the stream instead of switching to a fallback stream
3079
3088
  *
3080
- * @category Rate Limiting
3089
+ * @category rate limiting
3081
3090
  * @since 4.0.0
3082
3091
  */
3083
3092
  <B, E2, R2>(options: {
@@ -3105,7 +3114,7 @@ export declare const timeoutOrElse: {
3105
3114
  *
3106
3115
  * @see {@link timeout} for ending the stream instead of switching to a fallback stream
3107
3116
  *
3108
- * @category Rate Limiting
3117
+ * @category rate limiting
3109
3118
  * @since 4.0.0
3110
3119
  */
3111
3120
  <A, E, R, B, E2, R2>(self: Stream<A, E, R>, options: {
@@ -3216,7 +3225,7 @@ export declare const repeatElements: {
3216
3225
  */
3217
3226
  export declare const forever: <A, E, R>(self: Stream<A, E, R>) => Stream<A, E, R>;
3218
3227
  /**
3219
- * Submerges the iterables emitted by this stream into the stream's structure.
3228
+ * Flattens the iterables emitted by this stream into the stream's structure.
3220
3229
  *
3221
3230
  * **Example** (Flattening iterable values)
3222
3231
  *
@@ -5378,7 +5387,7 @@ export declare const filterMap: {
5378
5387
  <A, E, R, B, X>(self: Stream<A, E, R>, filter: Filter.Filter<A, B, X>): Stream<B, E, R>;
5379
5388
  };
5380
5389
  /**
5381
- * Effectfully filters elements in a single pass.
5390
+ * Filters elements in a single pass effectfully.
5382
5391
  *
5383
5392
  * **Example** (Effectfully filtering stream values)
5384
5393
  *
@@ -5401,7 +5410,7 @@ export declare const filterMap: {
5401
5410
  */
5402
5411
  export declare const filterEffect: {
5403
5412
  /**
5404
- * Effectfully filters elements in a single pass.
5413
+ * Filters elements in a single pass effectfully.
5405
5414
  *
5406
5415
  * **Example** (Effectfully filtering stream values)
5407
5416
  *
@@ -5424,7 +5433,7 @@ export declare const filterEffect: {
5424
5433
  */
5425
5434
  <A, EX, RX>(predicate: (a: NoInfer<A>, i: number) => Effect.Effect<boolean, EX, RX>): <E, R>(self: Stream<A, E, R>) => Stream<A, E | EX, R | RX>;
5426
5435
  /**
5427
- * Effectfully filters elements in a single pass.
5436
+ * Filters elements in a single pass effectfully.
5428
5437
  *
5429
5438
  * **Example** (Effectfully filtering stream values)
5430
5439
  *
@@ -5448,7 +5457,7 @@ export declare const filterEffect: {
5448
5457
  <A, E, R, EX, RX>(self: Stream<A, E, R>, predicate: (a: NoInfer<A>, i: number) => Effect.Effect<boolean, EX, RX>): Stream<A, E | EX, R | RX>;
5449
5458
  };
5450
5459
  /**
5451
- * Effectfully filters and maps elements in one pass using a `FilterEffect`.
5460
+ * Filters and maps elements in one pass effectfully using a `FilterEffect`.
5452
5461
  *
5453
5462
  * **When to use**
5454
5463
  *
@@ -5469,7 +5478,7 @@ export declare const filterEffect: {
5469
5478
  */
5470
5479
  export declare const filterMapEffect: {
5471
5480
  /**
5472
- * Effectfully filters and maps elements in one pass using a `FilterEffect`.
5481
+ * Filters and maps elements in one pass effectfully using a `FilterEffect`.
5473
5482
  *
5474
5483
  * **When to use**
5475
5484
  *
@@ -5490,7 +5499,7 @@ export declare const filterMapEffect: {
5490
5499
  */
5491
5500
  <A, B, X, EX, RX>(filter: Filter.FilterEffect<NoInfer<A>, B, X, EX, RX>): <E, R>(self: Stream<A, E, R>) => Stream<B, E | EX, R | RX>;
5492
5501
  /**
5493
- * Effectfully filters and maps elements in one pass using a `FilterEffect`.
5502
+ * Filters and maps elements in one pass effectfully using a `FilterEffect`.
5494
5503
  *
5495
5504
  * **When to use**
5496
5505
  *
@@ -6020,7 +6029,7 @@ export declare const peel: {
6020
6029
  * // Output: [ 1, 2, 3 ]
6021
6030
  * ```
6022
6031
  *
6023
- * @category Rate Limiting
6032
+ * @category rate limiting
6024
6033
  * @since 2.0.0
6025
6034
  */
6026
6035
  export declare const buffer: {
@@ -6052,7 +6061,7 @@ export declare const buffer: {
6052
6061
  * // Output: [ 1, 2, 3 ]
6053
6062
  * ```
6054
6063
  *
6055
- * @category Rate Limiting
6064
+ * @category rate limiting
6056
6065
  * @since 2.0.0
6057
6066
  */
6058
6067
  (options: {
@@ -6089,7 +6098,7 @@ export declare const buffer: {
6089
6098
  * // Output: [ 1, 2, 3 ]
6090
6099
  * ```
6091
6100
  *
6092
- * @category Rate Limiting
6101
+ * @category rate limiting
6093
6102
  * @since 2.0.0
6094
6103
  */
6095
6104
  <A, E, R>(self: Stream<A, E, R>, options: {
@@ -6126,7 +6135,7 @@ export declare const buffer: {
6126
6135
  * // Output: [ 1, 2, 3, 4 ]
6127
6136
  * ```
6128
6137
  *
6129
- * @category Rate Limiting
6138
+ * @category rate limiting
6130
6139
  * @since 4.0.0
6131
6140
  */
6132
6141
  export declare const bufferArray: {
@@ -6157,7 +6166,7 @@ export declare const bufferArray: {
6157
6166
  * // Output: [ 1, 2, 3, 4 ]
6158
6167
  * ```
6159
6168
  *
6160
- * @category Rate Limiting
6169
+ * @category rate limiting
6161
6170
  * @since 4.0.0
6162
6171
  */
6163
6172
  (options: {
@@ -6193,7 +6202,7 @@ export declare const bufferArray: {
6193
6202
  * // Output: [ 1, 2, 3, 4 ]
6194
6203
  * ```
6195
6204
  *
6196
- * @category Rate Limiting
6205
+ * @category rate limiting
6197
6206
  * @since 4.0.0
6198
6207
  */
6199
6208
  <A, E, R>(self: Stream<A, E, R>, options: {
@@ -6420,7 +6429,7 @@ export {
6420
6429
  */
6421
6430
  catch_ as catch };
6422
6431
  /**
6423
- * Effectfully peeks at errors without changing the stream unless the tap fails.
6432
+ * Peeks at errors effectfully without changing the stream unless the tap fails.
6424
6433
  *
6425
6434
  * **Example** (Effectfully peeking at errors)
6426
6435
  *
@@ -6449,7 +6458,7 @@ catch_ as catch };
6449
6458
  */
6450
6459
  export declare const tapError: {
6451
6460
  /**
6452
- * Effectfully peeks at errors without changing the stream unless the tap fails.
6461
+ * Peeks at errors effectfully without changing the stream unless the tap fails.
6453
6462
  *
6454
6463
  * **Example** (Effectfully peeking at errors)
6455
6464
  *
@@ -6478,7 +6487,7 @@ export declare const tapError: {
6478
6487
  */
6479
6488
  <E, A2, E2, R2>(f: (error: E) => Effect.Effect<A2, E2, R2>): <A, R>(self: Stream<A, E, R>) => Stream<A, E | E2, R2 | R>;
6480
6489
  /**
6481
- * Effectfully peeks at errors without changing the stream unless the tap fails.
6490
+ * Peeks at errors effectfully without changing the stream unless the tap fails.
6482
6491
  *
6483
6492
  * **Example** (Effectfully peeking at errors)
6484
6493
  *
@@ -7795,7 +7804,7 @@ export declare const ignoreCause: <Arg extends Stream<any, any, any> | {
7795
7804
  readonly log?: boolean | Severity | undefined;
7796
7805
  } | undefined) => [Arg] extends [Stream<infer A, infer _E, infer R>] ? Stream<A, never, R> : <A, E, R>(self: Stream<A, E, R>) => Stream<A, never, R>;
7797
7806
  /**
7798
- * When the stream fails, retry it according to the given schedule.
7807
+ * Retries the stream according to the given schedule when it fails.
7799
7808
  *
7800
7809
  * **Details**
7801
7810
  *
@@ -7830,7 +7839,7 @@ export declare const ignoreCause: <Arg extends Stream<any, any, any> | {
7830
7839
  */
7831
7840
  export declare const retry: {
7832
7841
  /**
7833
- * When the stream fails, retry it according to the given schedule.
7842
+ * Retries the stream according to the given schedule when it fails.
7834
7843
  *
7835
7844
  * **Details**
7836
7845
  *
@@ -7865,7 +7874,7 @@ export declare const retry: {
7865
7874
  */
7866
7875
  <E, X, E2, R2>(policy: Schedule.Schedule<X, NoInfer<E>, E2, R2> | (($: <SO, SE, SR>(_: Schedule.Schedule<SO, NoInfer<E>, SE, SR>) => Schedule.Schedule<SO, E, SE, SR>) => Schedule.Schedule<X, NoInfer<E>, E2, R2>)): <A, R>(self: Stream<A, E, R>) => Stream<A, E | E2, R2 | R>;
7867
7876
  /**
7868
- * When the stream fails, retry it according to the given schedule.
7877
+ * Retries the stream according to the given schedule when it fails.
7869
7878
  *
7870
7879
  * **Details**
7871
7880
  *
@@ -7901,7 +7910,7 @@ export declare const retry: {
7901
7910
  <A, E, R, X, E2, R2>(self: Stream<A, E, R>, policy: Schedule.Schedule<X, NoInfer<E>, E2, R2> | (($: <SO, SE, SR>(_: Schedule.Schedule<SO, NoInfer<E>, SE, SR>) => Schedule.Schedule<SO, E, SE, SR>) => Schedule.Schedule<X, NoInfer<E>, E2, R2>)): Stream<A, E | E2, R2 | R>;
7902
7911
  };
7903
7912
  /**
7904
- * Apply an `ExecutionPlan` to a stream, retrying with step-provided resources
7913
+ * Applies an `ExecutionPlan` to a stream, retrying with step-provided resources
7905
7914
  * until it succeeds or the plan is exhausted.
7906
7915
  *
7907
7916
  * **Details**
@@ -7945,7 +7954,7 @@ export declare const retry: {
7945
7954
  */
7946
7955
  export declare const withExecutionPlan: {
7947
7956
  /**
7948
- * Apply an `ExecutionPlan` to a stream, retrying with step-provided resources
7957
+ * Applies an `ExecutionPlan` to a stream, retrying with step-provided resources
7949
7958
  * until it succeeds or the plan is exhausted.
7950
7959
  *
7951
7960
  * **Details**
@@ -7996,7 +8005,7 @@ export declare const withExecutionPlan: {
7996
8005
  readonly preventFallbackOnPartialStream?: boolean | undefined;
7997
8006
  }): <A, E extends Input, R>(self: Stream<A, E, R>) => Stream<A, E | PolicyE, R2 | Exclude<R, Provides>>;
7998
8007
  /**
7999
- * Apply an `ExecutionPlan` to a stream, retrying with step-provided resources
8008
+ * Applies an `ExecutionPlan` to a stream, retrying with step-provided resources
8000
8009
  * until it succeeds or the plan is exhausted.
8001
8010
  *
8002
8011
  * **Details**
@@ -8304,7 +8313,7 @@ export declare const takeUntil: {
8304
8313
  }): Stream<A, E, R>;
8305
8314
  };
8306
8315
  /**
8307
- * Effectful predicate version of `takeUntil`.
8316
+ * Takes stream elements until an effectful predicate returns `true`.
8308
8317
  *
8309
8318
  * **Example** (Taking until an effectful predicate matches)
8310
8319
  *
@@ -8328,7 +8337,7 @@ export declare const takeUntil: {
8328
8337
  */
8329
8338
  export declare const takeUntilEffect: {
8330
8339
  /**
8331
- * Effectful predicate version of `takeUntil`.
8340
+ * Takes stream elements until an effectful predicate returns `true`.
8332
8341
  *
8333
8342
  * **Example** (Taking until an effectful predicate matches)
8334
8343
  *
@@ -8354,7 +8363,7 @@ export declare const takeUntilEffect: {
8354
8363
  readonly excludeLast?: boolean | undefined;
8355
8364
  }): <E, R>(self: Stream<A, E, R>) => Stream<A, E2 | E, R2 | R>;
8356
8365
  /**
8357
- * Effectful predicate version of `takeUntil`.
8366
+ * Takes stream elements until an effectful predicate returns `true`.
8358
8367
  *
8359
8368
  * **Example** (Taking until an effectful predicate matches)
8360
8369
  *
@@ -9190,12 +9199,12 @@ export declare const dropRight: {
9190
9199
  * // Output: [ [ 1, 2 ], [ 3, 4 ] ]
9191
9200
  * ```
9192
9201
  *
9193
- * @category Grouping
9202
+ * @category grouping
9194
9203
  * @since 2.0.0
9195
9204
  */
9196
9205
  export declare const chunks: <A, E, R>(self: Stream<A, E, R>) => Stream<Arr.NonEmptyReadonlyArray<A>, E, R>;
9197
9206
  /**
9198
- * Re-chunks the stream into arrays of the specified size, preserving element order.
9207
+ * Groups the stream into arrays of the specified size, preserving element order.
9199
9208
  *
9200
9209
  * **Details**
9201
9210
  *
@@ -9219,12 +9228,12 @@ export declare const chunks: <A, E, R>(self: Stream<A, E, R>) => Stream<Arr.NonE
9219
9228
  * // Output: [ [ 1, 2 ], [ 3, 4 ], [ 5 ] ]
9220
9229
  * ```
9221
9230
  *
9222
- * @category Grouping
9231
+ * @category grouping
9223
9232
  * @since 2.0.0
9224
9233
  */
9225
9234
  export declare const rechunk: {
9226
9235
  /**
9227
- * Re-chunks the stream into arrays of the specified size, preserving element order.
9236
+ * Groups the stream into arrays of the specified size, preserving element order.
9228
9237
  *
9229
9238
  * **Details**
9230
9239
  *
@@ -9248,12 +9257,12 @@ export declare const rechunk: {
9248
9257
  * // Output: [ [ 1, 2 ], [ 3, 4 ], [ 5 ] ]
9249
9258
  * ```
9250
9259
  *
9251
- * @category Grouping
9260
+ * @category grouping
9252
9261
  * @since 2.0.0
9253
9262
  */
9254
9263
  (size: number): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E, R>;
9255
9264
  /**
9256
- * Re-chunks the stream into arrays of the specified size, preserving element order.
9265
+ * Groups the stream into arrays of the specified size, preserving element order.
9257
9266
  *
9258
9267
  * **Details**
9259
9268
  *
@@ -9277,7 +9286,7 @@ export declare const rechunk: {
9277
9286
  * // Output: [ [ 1, 2 ], [ 3, 4 ], [ 5 ] ]
9278
9287
  * ```
9279
9288
  *
9280
- * @category Grouping
9289
+ * @category grouping
9281
9290
  * @since 2.0.0
9282
9291
  */
9283
9292
  <A, E, R>(self: Stream<A, E, R>, size: number): Stream<A, E, R>;
@@ -9301,7 +9310,7 @@ export declare const rechunk: {
9301
9310
  * // Output: [ [1, 2], [2, 3], [3, 4], [4, 5] ]
9302
9311
  * ```
9303
9312
  *
9304
- * @category Grouping
9313
+ * @category grouping
9305
9314
  * @since 2.0.0
9306
9315
  */
9307
9316
  export declare const sliding: {
@@ -9324,7 +9333,7 @@ export declare const sliding: {
9324
9333
  * // Output: [ [1, 2], [2, 3], [3, 4], [4, 5] ]
9325
9334
  * ```
9326
9335
  *
9327
- * @category Grouping
9336
+ * @category grouping
9328
9337
  * @since 2.0.0
9329
9338
  */
9330
9339
  (chunkSize: number): <A, E, R>(self: Stream<A, E, R>) => Stream<Arr.NonEmptyReadonlyArray<A>, E, R>;
@@ -9347,7 +9356,7 @@ export declare const sliding: {
9347
9356
  * // Output: [ [1, 2], [2, 3], [3, 4], [4, 5] ]
9348
9357
  * ```
9349
9358
  *
9350
- * @category Grouping
9359
+ * @category grouping
9351
9360
  * @since 2.0.0
9352
9361
  */
9353
9362
  <A, E, R>(self: Stream<A, E, R>, chunkSize: number): Stream<Arr.NonEmptyReadonlyArray<A>, E, R>;
@@ -9372,7 +9381,7 @@ export declare const sliding: {
9372
9381
  * // Output: [ [ 1, 2, 3 ], [ 3, 4, 5 ] ]
9373
9382
  * ```
9374
9383
  *
9375
- * @category Grouping
9384
+ * @category grouping
9376
9385
  * @since 2.0.0
9377
9386
  */
9378
9387
  export declare const slidingSize: {
@@ -9396,7 +9405,7 @@ export declare const slidingSize: {
9396
9405
  * // Output: [ [ 1, 2, 3 ], [ 3, 4, 5 ] ]
9397
9406
  * ```
9398
9407
  *
9399
- * @category Grouping
9408
+ * @category grouping
9400
9409
  * @since 2.0.0
9401
9410
  */
9402
9411
  (chunkSize: number, stepSize: number): <A, E, R>(self: Stream<A, E, R>) => Stream<Arr.NonEmptyReadonlyArray<A>, E, R>;
@@ -9420,7 +9429,7 @@ export declare const slidingSize: {
9420
9429
  * // Output: [ [ 1, 2, 3 ], [ 3, 4, 5 ] ]
9421
9430
  * ```
9422
9431
  *
9423
- * @category Grouping
9432
+ * @category grouping
9424
9433
  * @since 2.0.0
9425
9434
  */
9426
9435
  <A, E, R>(self: Stream<A, E, R>, chunkSize: number, stepSize: number): Stream<Arr.NonEmptyReadonlyArray<A>, E, R>;
@@ -9449,7 +9458,7 @@ export declare const slidingSize: {
9449
9458
  * // Output: [ [1, 2, 3], [5, 6, 7], [9] ]
9450
9459
  * ```
9451
9460
  *
9452
- * @category Grouping
9461
+ * @category grouping
9453
9462
  * @since 2.0.0
9454
9463
  */
9455
9464
  export declare const split: {
@@ -9477,7 +9486,7 @@ export declare const split: {
9477
9486
  * // Output: [ [1, 2, 3], [5, 6, 7], [9] ]
9478
9487
  * ```
9479
9488
  *
9480
- * @category Grouping
9489
+ * @category grouping
9481
9490
  * @since 2.0.0
9482
9491
  */
9483
9492
  <A, B extends A>(refinement: Refinement<NoInfer<A>, B>): <E, R>(self: Stream<A, E, R>) => Stream<Arr.NonEmptyReadonlyArray<Exclude<A, B>>, E, R>;
@@ -9505,7 +9514,7 @@ export declare const split: {
9505
9514
  * // Output: [ [1, 2, 3], [5, 6, 7], [9] ]
9506
9515
  * ```
9507
9516
  *
9508
- * @category Grouping
9517
+ * @category grouping
9509
9518
  * @since 2.0.0
9510
9519
  */
9511
9520
  <A>(predicate: Predicate<NoInfer<A>>): <E, R>(self: Stream<A, E, R>) => Stream<Arr.NonEmptyReadonlyArray<A>, E, R>;
@@ -9533,7 +9542,7 @@ export declare const split: {
9533
9542
  * // Output: [ [1, 2, 3], [5, 6, 7], [9] ]
9534
9543
  * ```
9535
9544
  *
9536
- * @category Grouping
9545
+ * @category grouping
9537
9546
  * @since 2.0.0
9538
9547
  */
9539
9548
  <A, E, R, B extends A>(self: Stream<A, E, R>, refinement: Refinement<A, B>): Stream<Arr.NonEmptyReadonlyArray<Exclude<A, B>>, E, R>;
@@ -9561,7 +9570,7 @@ export declare const split: {
9561
9570
  * // Output: [ [1, 2, 3], [5, 6, 7], [9] ]
9562
9571
  * ```
9563
9572
  *
9564
- * @category Grouping
9573
+ * @category grouping
9565
9574
  * @since 2.0.0
9566
9575
  */
9567
9576
  <A, E, R>(self: Stream<A, E, R>, predicate: Predicate<A>): Stream<Arr.NonEmptyReadonlyArray<A>, E, R>;
@@ -9679,11 +9688,18 @@ export declare const combine: {
9679
9688
  <A, E, R, A2, E2, R2, S, A3, E3, R3>(self: Stream<A, E, R>, that: Stream<A2, E2, R2>, s: LazyArg<S>, f: (s: S, pullLeft: Pull.Pull<A, E, void>, pullRight: Pull.Pull<A2, E2, void>) => Effect.Effect<readonly [A3, S], E3, R3>): Stream<A3, E3, R | R2 | R3>;
9680
9689
  };
9681
9690
  /**
9682
- * Combines the arrays (chunks) from this stream and the specified stream by
9683
- * repeatedly applying the function `f` to extract an array using both sides and
9684
- * conceptually "offer" it to the destination stream. `f` can maintain some
9685
- * internal state to control the combining process, with the initial state
9686
- * being specified by `s`.
9691
+ * Combines two streams chunk-by-chunk with a stateful pull function.
9692
+ *
9693
+ * **When to use**
9694
+ *
9695
+ * Use to coordinate pulling chunks from two streams when each emitted chunk
9696
+ * depends on both sides and local state.
9697
+ *
9698
+ * **Details**
9699
+ *
9700
+ * The combining function receives the current state and pull functions for the
9701
+ * left and right streams. It returns the next non-empty chunk together with the
9702
+ * next state.
9687
9703
  *
9688
9704
  * **Example** (Combining stream chunks with state)
9689
9705
  *
@@ -9716,11 +9732,18 @@ export declare const combine: {
9716
9732
  */
9717
9733
  export declare const combineArray: {
9718
9734
  /**
9719
- * Combines the arrays (chunks) from this stream and the specified stream by
9720
- * repeatedly applying the function `f` to extract an array using both sides and
9721
- * conceptually "offer" it to the destination stream. `f` can maintain some
9722
- * internal state to control the combining process, with the initial state
9723
- * being specified by `s`.
9735
+ * Combines two streams chunk-by-chunk with a stateful pull function.
9736
+ *
9737
+ * **When to use**
9738
+ *
9739
+ * Use to coordinate pulling chunks from two streams when each emitted chunk
9740
+ * depends on both sides and local state.
9741
+ *
9742
+ * **Details**
9743
+ *
9744
+ * The combining function receives the current state and pull functions for the
9745
+ * left and right streams. It returns the next non-empty chunk together with the
9746
+ * next state.
9724
9747
  *
9725
9748
  * **Example** (Combining stream chunks with state)
9726
9749
  *
@@ -9753,11 +9776,18 @@ export declare const combineArray: {
9753
9776
  */
9754
9777
  <A2, E2, R2, S, E, A, A3, E3, R3>(that: Stream<A2, E2, R2>, s: LazyArg<S>, f: (s: S, pullLeft: Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E, void>, pullRight: Pull.Pull<Arr.NonEmptyReadonlyArray<A2>, E2, void>) => Effect.Effect<readonly [Arr.NonEmptyReadonlyArray<A3>, S], E3, R3>): <R>(self: Stream<A, E, R>) => Stream<A3, Pull.ExcludeDone<E3>, R2 | R3 | R>;
9755
9778
  /**
9756
- * Combines the arrays (chunks) from this stream and the specified stream by
9757
- * repeatedly applying the function `f` to extract an array using both sides and
9758
- * conceptually "offer" it to the destination stream. `f` can maintain some
9759
- * internal state to control the combining process, with the initial state
9760
- * being specified by `s`.
9779
+ * Combines two streams chunk-by-chunk with a stateful pull function.
9780
+ *
9781
+ * **When to use**
9782
+ *
9783
+ * Use to coordinate pulling chunks from two streams when each emitted chunk
9784
+ * depends on both sides and local state.
9785
+ *
9786
+ * **Details**
9787
+ *
9788
+ * The combining function receives the current state and pull functions for the
9789
+ * left and right streams. It returns the next non-empty chunk together with the
9790
+ * next state.
9761
9791
  *
9762
9792
  * **Example** (Combining stream chunks with state)
9763
9793
  *
@@ -9791,7 +9821,7 @@ export declare const combineArray: {
9791
9821
  <R, A2, E2, R2, S, E, A, A3, E3, R3>(self: Stream<A, E, R>, that: Stream<A2, E2, R2>, s: LazyArg<S>, f: (s: S, pullLeft: Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E, void>, pullRight: Pull.Pull<Arr.NonEmptyReadonlyArray<A2>, E2, void>) => Effect.Effect<readonly [Arr.NonEmptyReadonlyArray<A3>, S], E3, R3>): Stream<A3, Pull.ExcludeDone<E3>, R | R2 | R3>;
9792
9822
  };
9793
9823
  /**
9794
- * Statefully maps elements, emitting zero or more outputs per input.
9824
+ * Maps elements statefully, emitting zero or more outputs per input.
9795
9825
  *
9796
9826
  * **Example** (Statefully mapping stream values)
9797
9827
  *
@@ -9819,7 +9849,7 @@ export declare const combineArray: {
9819
9849
  */
9820
9850
  export declare const mapAccum: {
9821
9851
  /**
9822
- * Statefully maps elements, emitting zero or more outputs per input.
9852
+ * Maps elements statefully, emitting zero or more outputs per input.
9823
9853
  *
9824
9854
  * **Example** (Statefully mapping stream values)
9825
9855
  *
@@ -9849,7 +9879,7 @@ export declare const mapAccum: {
9849
9879
  readonly onHalt?: ((state: S) => ReadonlyArray<B>) | undefined;
9850
9880
  }): <E, R>(self: Stream<A, E, R>) => Stream<B, E, R>;
9851
9881
  /**
9852
- * Statefully maps elements, emitting zero or more outputs per input.
9882
+ * Maps elements statefully, emitting zero or more outputs per input.
9853
9883
  *
9854
9884
  * **Example** (Statefully mapping stream values)
9855
9885
  *
@@ -9880,7 +9910,7 @@ export declare const mapAccum: {
9880
9910
  }): Stream<B, E, R>;
9881
9911
  };
9882
9912
  /**
9883
- * Statefully maps over non-empty chunk arrays, emitting zero or more values per chunk.
9913
+ * Maps over non-empty chunk arrays statefully, emitting zero or more values per chunk.
9884
9914
  *
9885
9915
  * **Details**
9886
9916
  *
@@ -9912,7 +9942,7 @@ export declare const mapAccum: {
9912
9942
  */
9913
9943
  export declare const mapAccumArray: {
9914
9944
  /**
9915
- * Statefully maps over non-empty chunk arrays, emitting zero or more values per chunk.
9945
+ * Maps over non-empty chunk arrays statefully, emitting zero or more values per chunk.
9916
9946
  *
9917
9947
  * **Details**
9918
9948
  *
@@ -9946,7 +9976,7 @@ export declare const mapAccumArray: {
9946
9976
  readonly onHalt?: ((state: S) => ReadonlyArray<B>) | undefined;
9947
9977
  }): <E, R>(self: Stream<A, E, R>) => Stream<B, E, R>;
9948
9978
  /**
9949
- * Statefully maps over non-empty chunk arrays, emitting zero or more values per chunk.
9979
+ * Maps over non-empty chunk arrays statefully, emitting zero or more values per chunk.
9950
9980
  *
9951
9981
  * **Details**
9952
9982
  *
@@ -9981,7 +10011,7 @@ export declare const mapAccumArray: {
9981
10011
  }): Stream<B, E, R>;
9982
10012
  };
9983
10013
  /**
9984
- * Statefully and effectfully maps each element, emitting zero or more output
10014
+ * Maps each element statefully and effectfully, emitting zero or more output
9985
10015
  * values per input.
9986
10016
  *
9987
10017
  * **Details**
@@ -10015,7 +10045,7 @@ export declare const mapAccumArray: {
10015
10045
  */
10016
10046
  export declare const mapAccumEffect: {
10017
10047
  /**
10018
- * Statefully and effectfully maps each element, emitting zero or more output
10048
+ * Maps each element statefully and effectfully, emitting zero or more output
10019
10049
  * values per input.
10020
10050
  *
10021
10051
  * **Details**
@@ -10051,7 +10081,7 @@ export declare const mapAccumEffect: {
10051
10081
  readonly onHalt?: ((state: S) => ReadonlyArray<B>) | undefined;
10052
10082
  }): <E, R>(self: Stream<A, E, R>) => Stream<B, E | E2, R | R2>;
10053
10083
  /**
10054
- * Statefully and effectfully maps each element, emitting zero or more output
10084
+ * Maps each element statefully and effectfully, emitting zero or more output
10055
10085
  * values per input.
10056
10086
  *
10057
10087
  * **Details**
@@ -10088,7 +10118,7 @@ export declare const mapAccumEffect: {
10088
10118
  }): Stream<B, E | E2, R | R2>;
10089
10119
  };
10090
10120
  /**
10091
- * Statefully and effectfully maps each non-empty input chunk, emitting zero or
10121
+ * Maps each non-empty input chunk statefully and effectfully, emitting zero or
10092
10122
  * more output values per chunk.
10093
10123
  *
10094
10124
  * **Details**
@@ -10124,7 +10154,7 @@ export declare const mapAccumEffect: {
10124
10154
  */
10125
10155
  export declare const mapAccumArrayEffect: {
10126
10156
  /**
10127
- * Statefully and effectfully maps each non-empty input chunk, emitting zero or
10157
+ * Maps each non-empty input chunk statefully and effectfully, emitting zero or
10128
10158
  * more output values per chunk.
10129
10159
  *
10130
10160
  * **Details**
@@ -10162,7 +10192,7 @@ export declare const mapAccumArrayEffect: {
10162
10192
  readonly onHalt?: ((state: S) => ReadonlyArray<B>) | undefined;
10163
10193
  }): <E, R>(self: Stream<A, E, R>) => Stream<B, E | E2, R | R2>;
10164
10194
  /**
10165
- * Statefully and effectfully maps each non-empty input chunk, emitting zero or
10195
+ * Maps each non-empty input chunk statefully and effectfully, emitting zero or
10166
10196
  * more output values per chunk.
10167
10197
  *
10168
10198
  * **Details**
@@ -10274,7 +10304,7 @@ export declare const scan: {
10274
10304
  <A, E, R, S>(self: Stream<A, E, R>, initial: S, f: (s: S, a: A) => S): Stream<S, E, R>;
10275
10305
  };
10276
10306
  /**
10277
- * Effectfully accumulates state and emits the initial state plus each accumulated state.
10307
+ * Accumulates state effectfully and emits the initial state plus each accumulated state.
10278
10308
  *
10279
10309
  * **Example** (Effectfully scanning stream state)
10280
10310
  *
@@ -10296,7 +10326,7 @@ export declare const scan: {
10296
10326
  */
10297
10327
  export declare const scanEffect: {
10298
10328
  /**
10299
- * Effectfully accumulates state and emits the initial state plus each accumulated state.
10329
+ * Accumulates state effectfully and emits the initial state plus each accumulated state.
10300
10330
  *
10301
10331
  * **Example** (Effectfully scanning stream state)
10302
10332
  *
@@ -10318,7 +10348,7 @@ export declare const scanEffect: {
10318
10348
  */
10319
10349
  <S, A, E2, R2>(initial: S, f: (s: S, a: A) => Effect.Effect<S, E2, R2>): <E, R>(self: Stream<A, E, R>) => Stream<S, E | E2, R | R2>;
10320
10350
  /**
10321
- * Effectfully accumulates state and emits the initial state plus each accumulated state.
10351
+ * Accumulates state effectfully and emits the initial state plus each accumulated state.
10322
10352
  *
10323
10353
  * **Example** (Effectfully scanning stream state)
10324
10354
  *
@@ -10361,7 +10391,7 @@ export declare const scanEffect: {
10361
10391
  * })
10362
10392
  * ```
10363
10393
  *
10364
- * @category Rate Limiting
10394
+ * @category rate limiting
10365
10395
  * @since 2.0.0
10366
10396
  */
10367
10397
  export declare const debounce: {
@@ -10386,7 +10416,7 @@ export declare const debounce: {
10386
10416
  * })
10387
10417
  * ```
10388
10418
  *
10389
- * @category Rate Limiting
10419
+ * @category rate limiting
10390
10420
  * @since 2.0.0
10391
10421
  */
10392
10422
  (duration: Duration.Input): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E, R>;
@@ -10411,19 +10441,23 @@ export declare const debounce: {
10411
10441
  * })
10412
10442
  * ```
10413
10443
  *
10414
- * @category Rate Limiting
10444
+ * @category rate limiting
10415
10445
  * @since 2.0.0
10416
10446
  */
10417
10447
  <A, E, R>(self: Stream<A, E, R>, duration: Duration.Input): Stream<A, E, R>;
10418
10448
  };
10419
10449
  /**
10420
- * Delays the arrays of this stream according to the given bandwidth
10421
- * parameters using the token bucket algorithm. Allows for burst processing by
10422
- * allowing the bucket to accumulate tokens up to a `units + burst` threshold.
10423
- * The weight of each array is determined by the effectful `cost` function.
10450
+ * Rate-limits stream chunks with an effectful cost function.
10451
+ *
10452
+ * **When to use**
10453
+ *
10454
+ * Use to throttle chunks when computing each chunk's cost requires an effect.
10424
10455
  *
10425
10456
  * **Details**
10426
10457
  *
10458
+ * Uses a token bucket. The bucket can accumulate up to `units + burst` tokens,
10459
+ * and each chunk consumes the cost returned by the effectful `cost` function.
10460
+ *
10427
10461
  * If using the "enforce" strategy, arrays that do not meet the bandwidth
10428
10462
  * constraints are dropped. If using the "shape" strategy, arrays are delayed
10429
10463
  * until they can be emitted without exceeding the bandwidth constraints.
@@ -10452,18 +10486,22 @@ export declare const debounce: {
10452
10486
  * // Output: [0, 1, 2, 3, 4, 5]
10453
10487
  * ```
10454
10488
  *
10455
- * @category Rate Limiting
10489
+ * @category rate limiting
10456
10490
  * @since 2.0.0
10457
10491
  */
10458
10492
  export declare const throttleEffect: {
10459
10493
  /**
10460
- * Delays the arrays of this stream according to the given bandwidth
10461
- * parameters using the token bucket algorithm. Allows for burst processing by
10462
- * allowing the bucket to accumulate tokens up to a `units + burst` threshold.
10463
- * The weight of each array is determined by the effectful `cost` function.
10494
+ * Rate-limits stream chunks with an effectful cost function.
10495
+ *
10496
+ * **When to use**
10497
+ *
10498
+ * Use to throttle chunks when computing each chunk's cost requires an effect.
10464
10499
  *
10465
10500
  * **Details**
10466
10501
  *
10502
+ * Uses a token bucket. The bucket can accumulate up to `units + burst` tokens,
10503
+ * and each chunk consumes the cost returned by the effectful `cost` function.
10504
+ *
10467
10505
  * If using the "enforce" strategy, arrays that do not meet the bandwidth
10468
10506
  * constraints are dropped. If using the "shape" strategy, arrays are delayed
10469
10507
  * until they can be emitted without exceeding the bandwidth constraints.
@@ -10492,7 +10530,7 @@ export declare const throttleEffect: {
10492
10530
  * // Output: [0, 1, 2, 3, 4, 5]
10493
10531
  * ```
10494
10532
  *
10495
- * @category Rate Limiting
10533
+ * @category rate limiting
10496
10534
  * @since 2.0.0
10497
10535
  */
10498
10536
  <A, E2, R2>(options: {
@@ -10503,13 +10541,17 @@ export declare const throttleEffect: {
10503
10541
  readonly strategy?: "enforce" | "shape" | undefined;
10504
10542
  }): <E, R>(self: Stream<A, E, R>) => Stream<A, E2 | E, R2 | R>;
10505
10543
  /**
10506
- * Delays the arrays of this stream according to the given bandwidth
10507
- * parameters using the token bucket algorithm. Allows for burst processing by
10508
- * allowing the bucket to accumulate tokens up to a `units + burst` threshold.
10509
- * The weight of each array is determined by the effectful `cost` function.
10544
+ * Rate-limits stream chunks with an effectful cost function.
10545
+ *
10546
+ * **When to use**
10547
+ *
10548
+ * Use to throttle chunks when computing each chunk's cost requires an effect.
10510
10549
  *
10511
10550
  * **Details**
10512
10551
  *
10552
+ * Uses a token bucket. The bucket can accumulate up to `units + burst` tokens,
10553
+ * and each chunk consumes the cost returned by the effectful `cost` function.
10554
+ *
10513
10555
  * If using the "enforce" strategy, arrays that do not meet the bandwidth
10514
10556
  * constraints are dropped. If using the "shape" strategy, arrays are delayed
10515
10557
  * until they can be emitted without exceeding the bandwidth constraints.
@@ -10538,7 +10580,7 @@ export declare const throttleEffect: {
10538
10580
  * // Output: [0, 1, 2, 3, 4, 5]
10539
10581
  * ```
10540
10582
  *
10541
- * @category Rate Limiting
10583
+ * @category rate limiting
10542
10584
  * @since 2.0.0
10543
10585
  */
10544
10586
  <A, E, R, E2, R2>(self: Stream<A, E, R>, options: {
@@ -10550,12 +10592,17 @@ export declare const throttleEffect: {
10550
10592
  }): Stream<A, E | E2, R | R2>;
10551
10593
  };
10552
10594
  /**
10553
- * Delays the arrays of this stream using a token bucket and a per-array cost.
10554
- * Allows bursts by letting the bucket accumulate up to a `units + burst`
10555
- * threshold. The weight of each array is determined by the `cost` function.
10595
+ * Rate-limits stream chunks with a synchronous cost function.
10596
+ *
10597
+ * **When to use**
10598
+ *
10599
+ * Use to throttle chunks when each chunk's cost can be computed synchronously.
10556
10600
  *
10557
10601
  * **Details**
10558
10602
  *
10603
+ * Uses a token bucket. The bucket can accumulate up to `units + burst` tokens,
10604
+ * and each chunk consumes the cost returned by `cost`.
10605
+ *
10559
10606
  * If using the "enforce" strategy, arrays that do not meet the bandwidth
10560
10607
  * constraints are dropped. If using the "shape" strategy, arrays are delayed
10561
10608
  * until they can be emitted without exceeding the bandwidth constraints.
@@ -10584,17 +10631,22 @@ export declare const throttleEffect: {
10584
10631
  * })
10585
10632
  * ```
10586
10633
  *
10587
- * @category Rate Limiting
10634
+ * @category rate limiting
10588
10635
  * @since 2.0.0
10589
10636
  */
10590
10637
  export declare const throttle: {
10591
10638
  /**
10592
- * Delays the arrays of this stream using a token bucket and a per-array cost.
10593
- * Allows bursts by letting the bucket accumulate up to a `units + burst`
10594
- * threshold. The weight of each array is determined by the `cost` function.
10639
+ * Rate-limits stream chunks with a synchronous cost function.
10640
+ *
10641
+ * **When to use**
10642
+ *
10643
+ * Use to throttle chunks when each chunk's cost can be computed synchronously.
10595
10644
  *
10596
10645
  * **Details**
10597
10646
  *
10647
+ * Uses a token bucket. The bucket can accumulate up to `units + burst` tokens,
10648
+ * and each chunk consumes the cost returned by `cost`.
10649
+ *
10598
10650
  * If using the "enforce" strategy, arrays that do not meet the bandwidth
10599
10651
  * constraints are dropped. If using the "shape" strategy, arrays are delayed
10600
10652
  * until they can be emitted without exceeding the bandwidth constraints.
@@ -10623,7 +10675,7 @@ export declare const throttle: {
10623
10675
  * })
10624
10676
  * ```
10625
10677
  *
10626
- * @category Rate Limiting
10678
+ * @category rate limiting
10627
10679
  * @since 2.0.0
10628
10680
  */
10629
10681
  <A>(options: {
@@ -10634,12 +10686,17 @@ export declare const throttle: {
10634
10686
  readonly strategy?: "enforce" | "shape" | undefined;
10635
10687
  }): <E, R>(self: Stream<A, E, R>) => Stream<A, E, R>;
10636
10688
  /**
10637
- * Delays the arrays of this stream using a token bucket and a per-array cost.
10638
- * Allows bursts by letting the bucket accumulate up to a `units + burst`
10639
- * threshold. The weight of each array is determined by the `cost` function.
10689
+ * Rate-limits stream chunks with a synchronous cost function.
10690
+ *
10691
+ * **When to use**
10692
+ *
10693
+ * Use to throttle chunks when each chunk's cost can be computed synchronously.
10640
10694
  *
10641
10695
  * **Details**
10642
10696
  *
10697
+ * Uses a token bucket. The bucket can accumulate up to `units + burst` tokens,
10698
+ * and each chunk consumes the cost returned by `cost`.
10699
+ *
10643
10700
  * If using the "enforce" strategy, arrays that do not meet the bandwidth
10644
10701
  * constraints are dropped. If using the "shape" strategy, arrays are delayed
10645
10702
  * until they can be emitted without exceeding the bandwidth constraints.
@@ -10668,7 +10725,7 @@ export declare const throttle: {
10668
10725
  * })
10669
10726
  * ```
10670
10727
  *
10671
- * @category Rate Limiting
10728
+ * @category rate limiting
10672
10729
  * @since 2.0.0
10673
10730
  */
10674
10731
  <A, E, R>(self: Stream<A, E, R>, options: {
@@ -10703,7 +10760,7 @@ export declare const throttle: {
10703
10760
  * // Output: [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8 ] ]
10704
10761
  * ```
10705
10762
  *
10706
- * @category Grouping
10763
+ * @category grouping
10707
10764
  * @since 2.0.0
10708
10765
  */
10709
10766
  export declare const grouped: {
@@ -10731,7 +10788,7 @@ export declare const grouped: {
10731
10788
  * // Output: [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8 ] ]
10732
10789
  * ```
10733
10790
  *
10734
- * @category Grouping
10791
+ * @category grouping
10735
10792
  * @since 2.0.0
10736
10793
  */
10737
10794
  (n: number): <A, E, R>(self: Stream<A, E, R>) => Stream<Arr.NonEmptyReadonlyArray<A>, E, R>;
@@ -10759,7 +10816,7 @@ export declare const grouped: {
10759
10816
  * // Output: [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8 ] ]
10760
10817
  * ```
10761
10818
  *
10762
- * @category Grouping
10819
+ * @category grouping
10763
10820
  * @since 2.0.0
10764
10821
  */
10765
10822
  <A, E, R>(self: Stream<A, E, R>, n: number): Stream<Arr.NonEmptyReadonlyArray<A>, E, R>;
@@ -10785,7 +10842,7 @@ export declare const grouped: {
10785
10842
  * // Output: [ [ 1, 2 ], [ 3 ] ]
10786
10843
  * ```
10787
10844
  *
10788
- * @category Grouping
10845
+ * @category grouping
10789
10846
  * @since 2.0.0
10790
10847
  */
10791
10848
  export declare const groupedWithin: {
@@ -10810,7 +10867,7 @@ export declare const groupedWithin: {
10810
10867
  * // Output: [ [ 1, 2 ], [ 3 ] ]
10811
10868
  * ```
10812
10869
  *
10813
- * @category Grouping
10870
+ * @category grouping
10814
10871
  * @since 2.0.0
10815
10872
  */
10816
10873
  (chunkSize: number, duration: Duration.Input): <A, E, R>(self: Stream<A, E, R>) => Stream<Array<A>, E, R>;
@@ -10835,7 +10892,7 @@ export declare const groupedWithin: {
10835
10892
  * // Output: [ [ 1, 2 ], [ 3 ] ]
10836
10893
  * ```
10837
10894
  *
10838
- * @category Grouping
10895
+ * @category grouping
10839
10896
  * @since 2.0.0
10840
10897
  */
10841
10898
  <A, E, R>(self: Stream<A, E, R>, chunkSize: number, duration: Duration.Input): Stream<Array<A>, E, R>;
@@ -10869,7 +10926,7 @@ export declare const groupedWithin: {
10869
10926
  * // Output: [ [ "odd", [ 1, 3, 5 ] ], [ "even", [ 2, 4 ] ] ]
10870
10927
  * ```
10871
10928
  *
10872
- * @category Grouping
10929
+ * @category grouping
10873
10930
  * @since 2.0.0
10874
10931
  */
10875
10932
  export declare const groupBy: {
@@ -10902,7 +10959,7 @@ export declare const groupBy: {
10902
10959
  * // Output: [ [ "odd", [ 1, 3, 5 ] ], [ "even", [ 2, 4 ] ] ]
10903
10960
  * ```
10904
10961
  *
10905
- * @category Grouping
10962
+ * @category grouping
10906
10963
  * @since 2.0.0
10907
10964
  */
10908
10965
  <A, K, V, E2, R2>(f: (a: NoInfer<A>) => Effect.Effect<readonly [K, V], E2, R2>, options?: {
@@ -10938,7 +10995,7 @@ export declare const groupBy: {
10938
10995
  * // Output: [ [ "odd", [ 1, 3, 5 ] ], [ "even", [ 2, 4 ] ] ]
10939
10996
  * ```
10940
10997
  *
10941
- * @category Grouping
10998
+ * @category grouping
10942
10999
  * @since 2.0.0
10943
11000
  */
10944
11001
  <A, E, R, K, V, E2, R2>(self: Stream<A, E, R>, f: (a: NoInfer<A>) => Effect.Effect<readonly [K, V], E2, R2>, options?: {
@@ -10973,7 +11030,7 @@ export declare const groupBy: {
10973
11030
  * // Output: [ [ "odd", [ 1, 3, 5 ] ], [ "even", [ 2, 4 ] ] ]
10974
11031
  * ```
10975
11032
  *
10976
- * @category Grouping
11033
+ * @category grouping
10977
11034
  * @since 2.0.0
10978
11035
  */
10979
11036
  export declare const groupByKey: {
@@ -11004,7 +11061,7 @@ export declare const groupByKey: {
11004
11061
  * // Output: [ [ "odd", [ 1, 3, 5 ] ], [ "even", [ 2, 4 ] ] ]
11005
11062
  * ```
11006
11063
  *
11007
- * @category Grouping
11064
+ * @category grouping
11008
11065
  * @since 2.0.0
11009
11066
  */
11010
11067
  <A, K>(f: (a: NoInfer<A>) => K, options?: {
@@ -11038,7 +11095,7 @@ export declare const groupByKey: {
11038
11095
  * // Output: [ [ "odd", [ 1, 3, 5 ] ], [ "even", [ 2, 4 ] ] ]
11039
11096
  * ```
11040
11097
  *
11041
- * @category Grouping
11098
+ * @category grouping
11042
11099
  * @since 2.0.0
11043
11100
  */
11044
11101
  <A, E, R, K>(self: Stream<A, E, R>, f: (a: NoInfer<A>) => K, options?: {
@@ -11064,7 +11121,7 @@ export declare const groupByKey: {
11064
11121
  * @see {@link groupByKey} for grouping all elements with the same key across the stream
11065
11122
  * @see {@link groupBy} for custom grouped stream construction
11066
11123
  *
11067
- * @category Grouping
11124
+ * @category grouping
11068
11125
  * @since 2.0.0
11069
11126
  */
11070
11127
  export declare const groupAdjacentBy: {
@@ -11086,7 +11143,7 @@ export declare const groupAdjacentBy: {
11086
11143
  * @see {@link groupByKey} for grouping all elements with the same key across the stream
11087
11144
  * @see {@link groupBy} for custom grouped stream construction
11088
11145
  *
11089
- * @category Grouping
11146
+ * @category grouping
11090
11147
  * @since 2.0.0
11091
11148
  */
11092
11149
  <A, K>(f: (a: NoInfer<A>) => K): <E, R>(self: Stream<A, E, R>) => Stream<readonly [K, Arr.NonEmptyArray<A>], E, R>;
@@ -11108,7 +11165,7 @@ export declare const groupAdjacentBy: {
11108
11165
  * @see {@link groupByKey} for grouping all elements with the same key across the stream
11109
11166
  * @see {@link groupBy} for custom grouped stream construction
11110
11167
  *
11111
- * @category Grouping
11168
+ * @category grouping
11112
11169
  * @since 2.0.0
11113
11170
  */
11114
11171
  <A, E, R, K>(self: Stream<A, E, R>, f: (a: NoInfer<A>) => K): Stream<readonly [K, Arr.NonEmptyArray<A>], E, R>;
@@ -11319,7 +11376,7 @@ export declare const aggregateWithin: {
11319
11376
  <A, E, R, B, A2, E2, R2, C, E3, R3>(self: Stream<A, E, R>, sink: Sink.Sink<B, A | A2, A2, E2, R2>, schedule: Schedule.Schedule<C, Option.Option<B>, E3, R3>): Stream<B, E | E2 | E3, R | R2 | R3>;
11320
11377
  };
11321
11378
  /**
11322
- * Fan out the stream, producing a fixed-size tuple of streams that each emit
11379
+ * Creates a fixed-size tuple of streams that each emit
11323
11380
  * the same elements as the source stream.
11324
11381
  *
11325
11382
  * **Details**
@@ -11359,7 +11416,7 @@ export declare const aggregateWithin: {
11359
11416
  */
11360
11417
  export declare const broadcastN: {
11361
11418
  /**
11362
- * Fan out the stream, producing a fixed-size tuple of streams that each emit
11419
+ * Creates a fixed-size tuple of streams that each emit
11363
11420
  * the same elements as the source stream.
11364
11421
  *
11365
11422
  * **Details**
@@ -11408,7 +11465,7 @@ export declare const broadcastN: {
11408
11465
  readonly replay?: number | undefined;
11409
11466
  }): <A, E, R>(self: Stream<A, E, R>) => Effect.Effect<TupleOf<N, Stream<A, E>>, never, Scope.Scope | R>;
11410
11467
  /**
11411
- * Fan out the stream, producing a fixed-size tuple of streams that each emit
11468
+ * Creates a fixed-size tuple of streams that each emit
11412
11469
  * the same elements as the source stream.
11413
11470
  *
11414
11471
  * **Details**
@@ -12394,7 +12451,7 @@ export declare const intersperse: {
12394
12451
  <A, E, R, A2>(self: Stream<A, E, R>, element: A2): Stream<A | A2, E, R>;
12395
12452
  };
12396
12453
  /**
12397
- * Intersperse stream elements with a middle value, adding a start and end value.
12454
+ * Adds a start value, middle value, and end value around stream elements.
12398
12455
  *
12399
12456
  * **Details**
12400
12457
  *
@@ -12423,7 +12480,7 @@ export declare const intersperse: {
12423
12480
  */
12424
12481
  export declare const intersperseAffixes: {
12425
12482
  /**
12426
- * Intersperse stream elements with a middle value, adding a start and end value.
12483
+ * Adds a start value, middle value, and end value around stream elements.
12427
12484
  *
12428
12485
  * **Details**
12429
12486
  *
@@ -12456,7 +12513,7 @@ export declare const intersperseAffixes: {
12456
12513
  readonly end: A4;
12457
12514
  }): <A, E, R>(self: Stream<A, E, R>) => Stream<A2 | A3 | A4 | A, E, R>;
12458
12515
  /**
12459
- * Intersperse stream elements with a middle value, adding a start and end value.
12516
+ * Adds a start value, middle value, and end value around stream elements.
12460
12517
  *
12461
12518
  * **Details**
12462
12519
  *
@@ -12793,7 +12850,21 @@ export declare const interruptWhen: {
12793
12850
  <A, E, R, X, E2, R2>(self: Stream<A, E, R>, effect: Effect.Effect<X, E2, R2>): Stream<A, E | E2, R | R2>;
12794
12851
  };
12795
12852
  /**
12796
- * Halts evaluation after the current element once the provided effect completes; the effect is forked, its success is discarded, failures fail the stream, and it does not interrupt an in-progress pull (use `interruptWhen` for that).
12853
+ * Stops a stream after the current element when an effect completes.
12854
+ *
12855
+ * **When to use**
12856
+ *
12857
+ * Use to stop before the next pull after an external signal completes.
12858
+ *
12859
+ * **Details**
12860
+ *
12861
+ * The effect is forked, its success value is discarded, and its failure fails
12862
+ * the stream.
12863
+ *
12864
+ * **Gotchas**
12865
+ *
12866
+ * This does not interrupt an in-progress pull. Use {@link interruptWhen} when
12867
+ * the stream should be interrupted immediately.
12797
12868
  *
12798
12869
  * **Example** (Halting a stream after an effect completes)
12799
12870
  *
@@ -12820,7 +12891,21 @@ export declare const interruptWhen: {
12820
12891
  */
12821
12892
  export declare const haltWhen: {
12822
12893
  /**
12823
- * Halts evaluation after the current element once the provided effect completes; the effect is forked, its success is discarded, failures fail the stream, and it does not interrupt an in-progress pull (use `interruptWhen` for that).
12894
+ * Stops a stream after the current element when an effect completes.
12895
+ *
12896
+ * **When to use**
12897
+ *
12898
+ * Use to stop before the next pull after an external signal completes.
12899
+ *
12900
+ * **Details**
12901
+ *
12902
+ * The effect is forked, its success value is discarded, and its failure fails
12903
+ * the stream.
12904
+ *
12905
+ * **Gotchas**
12906
+ *
12907
+ * This does not interrupt an in-progress pull. Use {@link interruptWhen} when
12908
+ * the stream should be interrupted immediately.
12824
12909
  *
12825
12910
  * **Example** (Halting a stream after an effect completes)
12826
12911
  *
@@ -12847,7 +12932,21 @@ export declare const haltWhen: {
12847
12932
  */
12848
12933
  <X, E2, R2>(effect: Effect.Effect<X, E2, R2>): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E2 | E, R2 | R>;
12849
12934
  /**
12850
- * Halts evaluation after the current element once the provided effect completes; the effect is forked, its success is discarded, failures fail the stream, and it does not interrupt an in-progress pull (use `interruptWhen` for that).
12935
+ * Stops a stream after the current element when an effect completes.
12936
+ *
12937
+ * **When to use**
12938
+ *
12939
+ * Use to stop before the next pull after an external signal completes.
12940
+ *
12941
+ * **Details**
12942
+ *
12943
+ * The effect is forked, its success value is discarded, and its failure fails
12944
+ * the stream.
12945
+ *
12946
+ * **Gotchas**
12947
+ *
12948
+ * This does not interrupt an in-progress pull. Use {@link interruptWhen} when
12949
+ * the stream should be interrupted immediately.
12851
12950
  *
12852
12951
  * **Example** (Halting a stream after an effect completes)
12853
12952
  *
@@ -15463,7 +15562,7 @@ export declare const runIntoPubSub: {
15463
15562
  } | undefined): Effect.Effect<void, never, R>;
15464
15563
  };
15465
15564
  /**
15466
- * Converts a stream to a PubSub for concurrent consumption.
15565
+ * Converts a stream to a PubSub of emitted values for concurrent consumption.
15467
15566
  *
15468
15567
  * **Details**
15469
15568
  *
@@ -15491,7 +15590,7 @@ export declare const runIntoPubSub: {
15491
15590
  */
15492
15591
  export declare const toPubSub: {
15493
15592
  /**
15494
- * Converts a stream to a PubSub for concurrent consumption.
15593
+ * Converts a stream to a PubSub of emitted values for concurrent consumption.
15495
15594
  *
15496
15595
  * **Details**
15497
15596
  *
@@ -15528,7 +15627,7 @@ export declare const toPubSub: {
15528
15627
  readonly shutdownOnEnd?: boolean | undefined;
15529
15628
  }): <A, E, R>(self: Stream<A, E, R>) => Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>;
15530
15629
  /**
15531
- * Converts a stream to a PubSub for concurrent consumption.
15630
+ * Converts a stream to a PubSub of emitted values for concurrent consumption.
15532
15631
  *
15533
15632
  * **Details**
15534
15633
  *
@@ -15566,7 +15665,7 @@ export declare const toPubSub: {
15566
15665
  }): Effect.Effect<PubSub.PubSub<A>, never, R | Scope.Scope>;
15567
15666
  };
15568
15667
  /**
15569
- * Converts a stream to a PubSub for concurrent consumption.
15668
+ * Converts a stream to a PubSub of `Take` values for concurrent consumption.
15570
15669
  *
15571
15670
  * **Details**
15572
15671
  *
@@ -15595,7 +15694,7 @@ export declare const toPubSub: {
15595
15694
  */
15596
15695
  export declare const toPubSubTake: {
15597
15696
  /**
15598
- * Converts a stream to a PubSub for concurrent consumption.
15697
+ * Converts a stream to a PubSub of `Take` values for concurrent consumption.
15599
15698
  *
15600
15699
  * **Details**
15601
15700
  *
@@ -15631,7 +15730,7 @@ export declare const toPubSubTake: {
15631
15730
  readonly replay?: number | undefined;
15632
15731
  }): <A, E, R>(self: Stream<A, E, R>) => Effect.Effect<PubSub.PubSub<Take.Take<A, E>>, never, R | Scope.Scope>;
15633
15732
  /**
15634
- * Converts a stream to a PubSub for concurrent consumption.
15733
+ * Converts a stream to a PubSub of `Take` values for concurrent consumption.
15635
15734
  *
15636
15735
  * **Details**
15637
15736
  *