effect 4.0.0-beta.73 → 4.0.0-beta.75

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 (930) hide show
  1. package/dist/Array.d.ts +745 -627
  2. package/dist/Array.d.ts.map +1 -1
  3. package/dist/Array.js +277 -217
  4. package/dist/Array.js.map +1 -1
  5. package/dist/BigDecimal.d.ts +37 -30
  6. package/dist/BigDecimal.d.ts.map +1 -1
  7. package/dist/BigDecimal.js +19 -16
  8. package/dist/BigDecimal.js.map +1 -1
  9. package/dist/BigInt.d.ts +34 -40
  10. package/dist/BigInt.d.ts.map +1 -1
  11. package/dist/BigInt.js +16 -16
  12. package/dist/BigInt.js.map +1 -1
  13. package/dist/Boolean.d.ts +10 -10
  14. package/dist/Boolean.js +6 -6
  15. package/dist/Brand.d.ts +13 -11
  16. package/dist/Brand.d.ts.map +1 -1
  17. package/dist/Brand.js +10 -8
  18. package/dist/Brand.js.map +1 -1
  19. package/dist/Cause.d.ts +21 -23
  20. package/dist/Cause.d.ts.map +1 -1
  21. package/dist/Cause.js +21 -23
  22. package/dist/Cause.js.map +1 -1
  23. package/dist/Channel.d.ts +282 -72
  24. package/dist/Channel.d.ts.map +1 -1
  25. package/dist/Channel.js +108 -28
  26. package/dist/Channel.js.map +1 -1
  27. package/dist/ChannelSchema.d.ts +11 -11
  28. package/dist/ChannelSchema.js +5 -5
  29. package/dist/Chunk.d.ts +86 -33
  30. package/dist/Chunk.d.ts.map +1 -1
  31. package/dist/Chunk.js +48 -13
  32. package/dist/Chunk.js.map +1 -1
  33. package/dist/Clock.d.ts +3 -3
  34. package/dist/Clock.js +3 -3
  35. package/dist/Combiner.d.ts +9 -13
  36. package/dist/Combiner.d.ts.map +1 -1
  37. package/dist/Combiner.js +9 -13
  38. package/dist/Combiner.js.map +1 -1
  39. package/dist/Config.d.ts +49 -56
  40. package/dist/Config.d.ts.map +1 -1
  41. package/dist/Config.js +40 -43
  42. package/dist/Config.js.map +1 -1
  43. package/dist/ConfigProvider.d.ts +34 -44
  44. package/dist/ConfigProvider.d.ts.map +1 -1
  45. package/dist/ConfigProvider.js +24 -32
  46. package/dist/ConfigProvider.js.map +1 -1
  47. package/dist/Console.d.ts +2 -2
  48. package/dist/Console.js +2 -2
  49. package/dist/Context.d.ts +63 -75
  50. package/dist/Context.d.ts.map +1 -1
  51. package/dist/Context.js +29 -33
  52. package/dist/Context.js.map +1 -1
  53. package/dist/Cron.d.ts +6 -6
  54. package/dist/Cron.js +6 -6
  55. package/dist/Crypto.d.ts +4 -4
  56. package/dist/Crypto.js +4 -4
  57. package/dist/Data.d.ts +21 -15
  58. package/dist/Data.d.ts.map +1 -1
  59. package/dist/Data.js +7 -7
  60. package/dist/Data.js.map +1 -1
  61. package/dist/DateTime.d.ts +35 -16
  62. package/dist/DateTime.d.ts.map +1 -1
  63. package/dist/DateTime.js +35 -8
  64. package/dist/DateTime.js.map +1 -1
  65. package/dist/Deferred.d.ts +61 -52
  66. package/dist/Deferred.d.ts.map +1 -1
  67. package/dist/Deferred.js +21 -18
  68. package/dist/Deferred.js.map +1 -1
  69. package/dist/Duration.d.ts +50 -37
  70. package/dist/Duration.d.ts.map +1 -1
  71. package/dist/Duration.js +24 -13
  72. package/dist/Duration.js.map +1 -1
  73. package/dist/Effect.d.ts +574 -474
  74. package/dist/Effect.d.ts.map +1 -1
  75. package/dist/Effect.js +273 -213
  76. package/dist/Effect.js.map +1 -1
  77. package/dist/Encoding.d.ts +5 -0
  78. package/dist/Encoding.d.ts.map +1 -1
  79. package/dist/Encoding.js +5 -0
  80. package/dist/Encoding.js.map +1 -1
  81. package/dist/Equal.d.ts +28 -41
  82. package/dist/Equal.d.ts.map +1 -1
  83. package/dist/Equal.js +12 -19
  84. package/dist/Equal.js.map +1 -1
  85. package/dist/Equivalence.d.ts +72 -100
  86. package/dist/Equivalence.d.ts.map +1 -1
  87. package/dist/Equivalence.js +54 -74
  88. package/dist/Equivalence.js.map +1 -1
  89. package/dist/ErrorReporter.d.ts +1 -1
  90. package/dist/ErrorReporter.js +1 -1
  91. package/dist/ExecutionPlan.d.ts +2 -2
  92. package/dist/ExecutionPlan.js +1 -1
  93. package/dist/Exit.d.ts +79 -96
  94. package/dist/Exit.d.ts.map +1 -1
  95. package/dist/Exit.js +57 -64
  96. package/dist/Exit.js.map +1 -1
  97. package/dist/Fiber.d.ts +8 -6
  98. package/dist/Fiber.d.ts.map +1 -1
  99. package/dist/Fiber.js +8 -6
  100. package/dist/Fiber.js.map +1 -1
  101. package/dist/FiberHandle.d.ts +25 -0
  102. package/dist/FiberHandle.d.ts.map +1 -1
  103. package/dist/FiberHandle.js +15 -0
  104. package/dist/FiberHandle.js.map +1 -1
  105. package/dist/FiberMap.d.ts +35 -0
  106. package/dist/FiberMap.d.ts.map +1 -1
  107. package/dist/FiberMap.js +15 -0
  108. package/dist/FiberMap.js.map +1 -1
  109. package/dist/FiberSet.d.ts +20 -0
  110. package/dist/FiberSet.d.ts.map +1 -1
  111. package/dist/FiberSet.js +10 -0
  112. package/dist/FiberSet.js.map +1 -1
  113. package/dist/FileSystem.d.ts +6 -6
  114. package/dist/FileSystem.js +2 -2
  115. package/dist/Filter.d.ts +4 -4
  116. package/dist/Filter.js +4 -4
  117. package/dist/Formatter.d.ts +14 -19
  118. package/dist/Formatter.d.ts.map +1 -1
  119. package/dist/Formatter.js +14 -19
  120. package/dist/Formatter.js.map +1 -1
  121. package/dist/Function.d.ts +20 -21
  122. package/dist/Function.d.ts.map +1 -1
  123. package/dist/Function.js +14 -15
  124. package/dist/Function.js.map +1 -1
  125. package/dist/Graph.d.ts +13 -13
  126. package/dist/Graph.js +7 -7
  127. package/dist/HKT.d.ts +3 -3
  128. package/dist/Hash.d.ts +2 -1
  129. package/dist/Hash.d.ts.map +1 -1
  130. package/dist/Hash.js +2 -1
  131. package/dist/Hash.js.map +1 -1
  132. package/dist/HashMap.d.ts +18 -3
  133. package/dist/HashMap.d.ts.map +1 -1
  134. package/dist/HashMap.js +5 -0
  135. package/dist/HashMap.js.map +1 -1
  136. package/dist/HashRing.d.ts +9 -9
  137. package/dist/HashRing.js +3 -3
  138. package/dist/HashSet.d.ts +1 -1
  139. package/dist/Iterable.d.ts +39 -27
  140. package/dist/Iterable.d.ts.map +1 -1
  141. package/dist/Iterable.js +21 -11
  142. package/dist/Iterable.js.map +1 -1
  143. package/dist/JsonPatch.d.ts +2 -3
  144. package/dist/JsonPatch.d.ts.map +1 -1
  145. package/dist/JsonPatch.js +2 -3
  146. package/dist/JsonPatch.js.map +1 -1
  147. package/dist/JsonPointer.d.ts +2 -6
  148. package/dist/JsonPointer.d.ts.map +1 -1
  149. package/dist/JsonPointer.js +2 -6
  150. package/dist/JsonPointer.js.map +1 -1
  151. package/dist/JsonSchema.d.ts +17 -13
  152. package/dist/JsonSchema.d.ts.map +1 -1
  153. package/dist/JsonSchema.js +17 -13
  154. package/dist/JsonSchema.js.map +1 -1
  155. package/dist/Latch.d.ts +4 -3
  156. package/dist/Latch.d.ts.map +1 -1
  157. package/dist/Latch.js +4 -3
  158. package/dist/Latch.js.map +1 -1
  159. package/dist/Layer.d.ts +108 -130
  160. package/dist/Layer.d.ts.map +1 -1
  161. package/dist/Layer.js +43 -51
  162. package/dist/Layer.js.map +1 -1
  163. package/dist/Logger.d.ts +16 -19
  164. package/dist/Logger.d.ts.map +1 -1
  165. package/dist/Logger.js +15 -18
  166. package/dist/Logger.js.map +1 -1
  167. package/dist/ManagedRuntime.d.ts +2 -2
  168. package/dist/Match.d.ts +22 -22
  169. package/dist/Match.js +18 -18
  170. package/dist/Metric.d.ts +105 -125
  171. package/dist/Metric.d.ts.map +1 -1
  172. package/dist/Metric.js +54 -64
  173. package/dist/Metric.js.map +1 -1
  174. package/dist/MutableHashMap.d.ts +21 -12
  175. package/dist/MutableHashMap.d.ts.map +1 -1
  176. package/dist/MutableHashMap.js +7 -4
  177. package/dist/MutableHashMap.js.map +1 -1
  178. package/dist/MutableList.d.ts +15 -0
  179. package/dist/MutableList.d.ts.map +1 -1
  180. package/dist/MutableList.js +15 -0
  181. package/dist/MutableList.js.map +1 -1
  182. package/dist/MutableRef.d.ts +56 -42
  183. package/dist/MutableRef.d.ts.map +1 -1
  184. package/dist/MutableRef.js +28 -22
  185. package/dist/MutableRef.js.map +1 -1
  186. package/dist/Newtype.d.ts +10 -7
  187. package/dist/Newtype.d.ts.map +1 -1
  188. package/dist/Newtype.js +10 -7
  189. package/dist/Newtype.js.map +1 -1
  190. package/dist/Number.d.ts +23 -11
  191. package/dist/Number.d.ts.map +1 -1
  192. package/dist/Number.js +9 -5
  193. package/dist/Number.js.map +1 -1
  194. package/dist/Optic.d.ts +16 -16
  195. package/dist/Optic.d.ts.map +1 -1
  196. package/dist/Optic.js +10 -9
  197. package/dist/Optic.js.map +1 -1
  198. package/dist/Option.d.ts +232 -204
  199. package/dist/Option.d.ts.map +1 -1
  200. package/dist/Option.js +113 -96
  201. package/dist/Option.js.map +1 -1
  202. package/dist/Order.d.ts +119 -180
  203. package/dist/Order.d.ts.map +1 -1
  204. package/dist/Order.js +93 -145
  205. package/dist/Order.js.map +1 -1
  206. package/dist/PartitionedSemaphore.d.ts +14 -14
  207. package/dist/PartitionedSemaphore.js +6 -6
  208. package/dist/Path.d.ts +3 -3
  209. package/dist/Path.js +3 -3
  210. package/dist/Pipeable.d.ts +3 -3
  211. package/dist/Pipeable.js +3 -3
  212. package/dist/PlatformError.d.ts +4 -4
  213. package/dist/PlatformError.js +4 -4
  214. package/dist/Pool.d.ts +7 -11
  215. package/dist/Pool.d.ts.map +1 -1
  216. package/dist/Pool.js +3 -5
  217. package/dist/Pool.js.map +1 -1
  218. package/dist/Predicate.d.ts +279 -268
  219. package/dist/Predicate.d.ts.map +1 -1
  220. package/dist/Predicate.js +128 -123
  221. package/dist/Predicate.js.map +1 -1
  222. package/dist/PubSub.d.ts +33 -23
  223. package/dist/PubSub.d.ts.map +1 -1
  224. package/dist/PubSub.js +21 -11
  225. package/dist/PubSub.js.map +1 -1
  226. package/dist/Pull.d.ts +4 -4
  227. package/dist/Pull.js +4 -4
  228. package/dist/Queue.d.ts +70 -31
  229. package/dist/Queue.d.ts.map +1 -1
  230. package/dist/Queue.js +66 -27
  231. package/dist/Queue.js.map +1 -1
  232. package/dist/RcRef.d.ts +0 -4
  233. package/dist/RcRef.d.ts.map +1 -1
  234. package/dist/RcRef.js.map +1 -1
  235. package/dist/Record.d.ts +15 -15
  236. package/dist/Record.js +5 -5
  237. package/dist/Redactable.d.ts +2 -2
  238. package/dist/Redactable.js +2 -2
  239. package/dist/Redacted.d.ts +5 -5
  240. package/dist/Redacted.js +4 -4
  241. package/dist/Reducer.d.ts +2 -3
  242. package/dist/Reducer.d.ts.map +1 -1
  243. package/dist/Reducer.js +2 -3
  244. package/dist/Reducer.js.map +1 -1
  245. package/dist/Ref.d.ts +23 -22
  246. package/dist/Ref.d.ts.map +1 -1
  247. package/dist/Ref.js +21 -20
  248. package/dist/Ref.js.map +1 -1
  249. package/dist/References.d.ts +4 -4
  250. package/dist/References.js +4 -4
  251. package/dist/RegExp.d.ts +1 -1
  252. package/dist/RegExp.js +1 -1
  253. package/dist/Request.d.ts +22 -22
  254. package/dist/Request.js +6 -6
  255. package/dist/RequestResolver.d.ts +6 -6
  256. package/dist/RequestResolver.js +2 -2
  257. package/dist/Resource.d.ts +3 -3
  258. package/dist/Resource.js +3 -3
  259. package/dist/Result.d.ts +95 -51
  260. package/dist/Result.d.ts.map +1 -1
  261. package/dist/Result.js +53 -30
  262. package/dist/Result.js.map +1 -1
  263. package/dist/Runtime.d.ts +11 -8
  264. package/dist/Runtime.d.ts.map +1 -1
  265. package/dist/Runtime.js +11 -8
  266. package/dist/Runtime.js.map +1 -1
  267. package/dist/Schedule.d.ts +151 -89
  268. package/dist/Schedule.d.ts.map +1 -1
  269. package/dist/Schedule.js +59 -47
  270. package/dist/Schedule.js.map +1 -1
  271. package/dist/Scheduler.d.ts +6 -4
  272. package/dist/Scheduler.d.ts.map +1 -1
  273. package/dist/Scheduler.js +6 -4
  274. package/dist/Scheduler.js.map +1 -1
  275. package/dist/Schema.d.ts +620 -830
  276. package/dist/Schema.d.ts.map +1 -1
  277. package/dist/Schema.js +543 -452
  278. package/dist/Schema.js.map +1 -1
  279. package/dist/SchemaAST.d.ts +43 -22
  280. package/dist/SchemaAST.d.ts.map +1 -1
  281. package/dist/SchemaAST.js +80 -59
  282. package/dist/SchemaAST.js.map +1 -1
  283. package/dist/SchemaGetter.d.ts +139 -119
  284. package/dist/SchemaGetter.d.ts.map +1 -1
  285. package/dist/SchemaGetter.js +133 -113
  286. package/dist/SchemaGetter.js.map +1 -1
  287. package/dist/SchemaIssue.d.ts +37 -39
  288. package/dist/SchemaIssue.d.ts.map +1 -1
  289. package/dist/SchemaIssue.js +16 -17
  290. package/dist/SchemaIssue.js.map +1 -1
  291. package/dist/SchemaParser.d.ts +75 -156
  292. package/dist/SchemaParser.d.ts.map +1 -1
  293. package/dist/SchemaParser.js +75 -148
  294. package/dist/SchemaParser.js.map +1 -1
  295. package/dist/SchemaRepresentation.d.ts +30 -21
  296. package/dist/SchemaRepresentation.d.ts.map +1 -1
  297. package/dist/SchemaRepresentation.js +26 -22
  298. package/dist/SchemaRepresentation.js.map +1 -1
  299. package/dist/SchemaTransformation.d.ts +169 -145
  300. package/dist/SchemaTransformation.d.ts.map +1 -1
  301. package/dist/SchemaTransformation.js +183 -159
  302. package/dist/SchemaTransformation.js.map +1 -1
  303. package/dist/SchemaUtils.js +2 -2
  304. package/dist/SchemaUtils.js.map +1 -1
  305. package/dist/Scope.d.ts +16 -1
  306. package/dist/Scope.d.ts.map +1 -1
  307. package/dist/Scope.js +16 -1
  308. package/dist/Scope.js.map +1 -1
  309. package/dist/ScopedCache.d.ts +1 -1
  310. package/dist/ScopedCache.js +1 -1
  311. package/dist/ScopedRef.d.ts +14 -18
  312. package/dist/ScopedRef.d.ts.map +1 -1
  313. package/dist/ScopedRef.js +6 -8
  314. package/dist/ScopedRef.js.map +1 -1
  315. package/dist/Semaphore.d.ts +9 -9
  316. package/dist/Semaphore.js +3 -3
  317. package/dist/Sink.d.ts +18 -18
  318. package/dist/Sink.d.ts.map +1 -1
  319. package/dist/Sink.js +12 -12
  320. package/dist/Sink.js.map +1 -1
  321. package/dist/Stdio.d.ts +4 -5
  322. package/dist/Stdio.d.ts.map +1 -1
  323. package/dist/Stdio.js +4 -5
  324. package/dist/Stdio.js.map +1 -1
  325. package/dist/Stream.d.ts +376 -99
  326. package/dist/Stream.d.ts.map +1 -1
  327. package/dist/Stream.js +158 -43
  328. package/dist/Stream.js.map +1 -1
  329. package/dist/String.d.ts +11 -14
  330. package/dist/String.d.ts.map +1 -1
  331. package/dist/String.js +5 -6
  332. package/dist/String.js.map +1 -1
  333. package/dist/Struct.d.ts +23 -21
  334. package/dist/Struct.d.ts.map +1 -1
  335. package/dist/Struct.js +14 -12
  336. package/dist/Struct.js.map +1 -1
  337. package/dist/SubscriptionRef.d.ts +24 -19
  338. package/dist/SubscriptionRef.d.ts.map +1 -1
  339. package/dist/SubscriptionRef.js +12 -7
  340. package/dist/SubscriptionRef.js.map +1 -1
  341. package/dist/SynchronizedRef.d.ts +145 -120
  342. package/dist/SynchronizedRef.d.ts.map +1 -1
  343. package/dist/SynchronizedRef.js +51 -42
  344. package/dist/SynchronizedRef.js.map +1 -1
  345. package/dist/Terminal.d.ts +1 -1
  346. package/dist/Terminal.js +1 -1
  347. package/dist/Tracer.d.ts +9 -9
  348. package/dist/Tracer.js +6 -6
  349. package/dist/Trie.d.ts +15 -0
  350. package/dist/Trie.d.ts.map +1 -1
  351. package/dist/Trie.js +5 -0
  352. package/dist/Trie.js.map +1 -1
  353. package/dist/Tuple.d.ts +39 -33
  354. package/dist/Tuple.d.ts.map +1 -1
  355. package/dist/Tuple.js +23 -19
  356. package/dist/Tuple.js.map +1 -1
  357. package/dist/TxHashMap.d.ts +3 -3
  358. package/dist/TxHashSet.d.ts +1 -1
  359. package/dist/TxReentrantLock.d.ts +6 -3
  360. package/dist/TxReentrantLock.d.ts.map +1 -1
  361. package/dist/TxReentrantLock.js +2 -1
  362. package/dist/TxReentrantLock.js.map +1 -1
  363. package/dist/TxRef.d.ts +16 -16
  364. package/dist/TxRef.js +8 -8
  365. package/dist/TxSubscriptionRef.d.ts +43 -27
  366. package/dist/TxSubscriptionRef.d.ts.map +1 -1
  367. package/dist/TxSubscriptionRef.js +19 -13
  368. package/dist/TxSubscriptionRef.js.map +1 -1
  369. package/dist/Types.d.ts +12 -38
  370. package/dist/Types.d.ts.map +1 -1
  371. package/dist/Types.js +0 -2
  372. package/dist/UndefinedOr.d.ts +15 -14
  373. package/dist/UndefinedOr.d.ts.map +1 -1
  374. package/dist/UndefinedOr.js +11 -10
  375. package/dist/UndefinedOr.js.map +1 -1
  376. package/dist/Unify.d.ts +9 -9
  377. package/dist/Unify.js +1 -1
  378. package/dist/internal/schema/annotations.js.map +1 -1
  379. package/dist/internal/schema/arbitrary.js +9 -9
  380. package/dist/internal/schema/arbitrary.js.map +1 -1
  381. package/dist/internal/schema/equivalence.js +9 -9
  382. package/dist/internal/schema/equivalence.js.map +1 -1
  383. package/dist/internal/schema/representation.js +14 -14
  384. package/dist/internal/schema/representation.js.map +1 -1
  385. package/dist/internal/schema/schema.js +11 -11
  386. package/dist/internal/schema/schema.js.map +1 -1
  387. package/dist/testing/TestClock.d.ts +5 -5
  388. package/dist/testing/TestClock.js +4 -4
  389. package/dist/testing/TestConsole.d.ts +3 -3
  390. package/dist/testing/TestConsole.js +3 -3
  391. package/dist/testing/TestSchema.d.ts +10 -10
  392. package/dist/testing/TestSchema.d.ts.map +1 -1
  393. package/dist/testing/TestSchema.js +9 -9
  394. package/dist/testing/TestSchema.js.map +1 -1
  395. package/dist/unstable/ai/AiError.d.ts +4 -2
  396. package/dist/unstable/ai/AiError.d.ts.map +1 -1
  397. package/dist/unstable/ai/AiError.js +4 -2
  398. package/dist/unstable/ai/AiError.js.map +1 -1
  399. package/dist/unstable/ai/AnthropicStructuredOutput.d.ts +17 -20
  400. package/dist/unstable/ai/AnthropicStructuredOutput.d.ts.map +1 -1
  401. package/dist/unstable/ai/AnthropicStructuredOutput.js +36 -39
  402. package/dist/unstable/ai/AnthropicStructuredOutput.js.map +1 -1
  403. package/dist/unstable/ai/Chat.d.ts +6 -7
  404. package/dist/unstable/ai/Chat.d.ts.map +1 -1
  405. package/dist/unstable/ai/Chat.js +6 -7
  406. package/dist/unstable/ai/Chat.js.map +1 -1
  407. package/dist/unstable/ai/EmbeddingModel.d.ts +5 -5
  408. package/dist/unstable/ai/EmbeddingModel.js +4 -4
  409. package/dist/unstable/ai/IdGenerator.d.ts +4 -5
  410. package/dist/unstable/ai/IdGenerator.d.ts.map +1 -1
  411. package/dist/unstable/ai/IdGenerator.js +3 -4
  412. package/dist/unstable/ai/IdGenerator.js.map +1 -1
  413. package/dist/unstable/ai/LanguageModel.d.ts +7 -6
  414. package/dist/unstable/ai/LanguageModel.d.ts.map +1 -1
  415. package/dist/unstable/ai/LanguageModel.js +6 -5
  416. package/dist/unstable/ai/LanguageModel.js.map +1 -1
  417. package/dist/unstable/ai/McpSchema.d.ts +14 -12
  418. package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
  419. package/dist/unstable/ai/McpSchema.js +19 -17
  420. package/dist/unstable/ai/McpSchema.js.map +1 -1
  421. package/dist/unstable/ai/McpServer.d.ts +11 -4
  422. package/dist/unstable/ai/McpServer.d.ts.map +1 -1
  423. package/dist/unstable/ai/McpServer.js +8 -5
  424. package/dist/unstable/ai/McpServer.js.map +1 -1
  425. package/dist/unstable/ai/OpenAiStructuredOutput.d.ts +20 -18
  426. package/dist/unstable/ai/OpenAiStructuredOutput.d.ts.map +1 -1
  427. package/dist/unstable/ai/OpenAiStructuredOutput.js +45 -43
  428. package/dist/unstable/ai/OpenAiStructuredOutput.js.map +1 -1
  429. package/dist/unstable/ai/Prompt.d.ts +17 -17
  430. package/dist/unstable/ai/Prompt.js +4 -4
  431. package/dist/unstable/ai/Prompt.js.map +1 -1
  432. package/dist/unstable/ai/ResponseIdTracker.d.ts +3 -2
  433. package/dist/unstable/ai/ResponseIdTracker.d.ts.map +1 -1
  434. package/dist/unstable/ai/ResponseIdTracker.js +3 -2
  435. package/dist/unstable/ai/ResponseIdTracker.js.map +1 -1
  436. package/dist/unstable/ai/Telemetry.d.ts +26 -11
  437. package/dist/unstable/ai/Telemetry.d.ts.map +1 -1
  438. package/dist/unstable/ai/Telemetry.js +9 -4
  439. package/dist/unstable/ai/Telemetry.js.map +1 -1
  440. package/dist/unstable/ai/Tokenizer.d.ts +1 -1
  441. package/dist/unstable/ai/Tokenizer.js +1 -1
  442. package/dist/unstable/ai/Tool.d.ts +13 -12
  443. package/dist/unstable/ai/Tool.d.ts.map +1 -1
  444. package/dist/unstable/ai/Tool.js +14 -13
  445. package/dist/unstable/ai/Tool.js.map +1 -1
  446. package/dist/unstable/ai/Toolkit.d.ts +2 -2
  447. package/dist/unstable/ai/Toolkit.js +2 -2
  448. package/dist/unstable/cli/Command.d.ts +37 -16
  449. package/dist/unstable/cli/Command.d.ts.map +1 -1
  450. package/dist/unstable/cli/Command.js +16 -9
  451. package/dist/unstable/cli/Command.js.map +1 -1
  452. package/dist/unstable/cli/Completions.d.ts +1 -1
  453. package/dist/unstable/cli/Completions.js +1 -1
  454. package/dist/unstable/cli/Flag.d.ts +7 -6
  455. package/dist/unstable/cli/Flag.d.ts.map +1 -1
  456. package/dist/unstable/cli/Flag.js +7 -6
  457. package/dist/unstable/cli/Flag.js.map +1 -1
  458. package/dist/unstable/cli/GlobalFlag.d.ts +6 -1
  459. package/dist/unstable/cli/GlobalFlag.d.ts.map +1 -1
  460. package/dist/unstable/cli/GlobalFlag.js +7 -2
  461. package/dist/unstable/cli/GlobalFlag.js.map +1 -1
  462. package/dist/unstable/cli/Param.d.ts +4 -4
  463. package/dist/unstable/cli/Param.d.ts.map +1 -1
  464. package/dist/unstable/cli/Param.js +13 -10
  465. package/dist/unstable/cli/Param.js.map +1 -1
  466. package/dist/unstable/cli/Primitive.d.ts +6 -5
  467. package/dist/unstable/cli/Primitive.d.ts.map +1 -1
  468. package/dist/unstable/cli/Primitive.js +4 -3
  469. package/dist/unstable/cli/Primitive.js.map +1 -1
  470. package/dist/unstable/cli/Prompt.d.ts +11 -11
  471. package/dist/unstable/cli/internal/parser.js +145 -10
  472. package/dist/unstable/cli/internal/parser.js.map +1 -1
  473. package/dist/unstable/cluster/ClusterCron.d.ts +1 -2
  474. package/dist/unstable/cluster/ClusterCron.d.ts.map +1 -1
  475. package/dist/unstable/cluster/ClusterCron.js.map +1 -1
  476. package/dist/unstable/cluster/ClusterMetrics.d.ts +5 -0
  477. package/dist/unstable/cluster/ClusterMetrics.d.ts.map +1 -1
  478. package/dist/unstable/cluster/ClusterMetrics.js +5 -0
  479. package/dist/unstable/cluster/ClusterMetrics.js.map +1 -1
  480. package/dist/unstable/cluster/ClusterSchema.d.ts +3 -3
  481. package/dist/unstable/cluster/ClusterSchema.js +3 -3
  482. package/dist/unstable/cluster/ClusterWorkflowEngine.js +15 -15
  483. package/dist/unstable/cluster/ClusterWorkflowEngine.js.map +1 -1
  484. package/dist/unstable/cluster/Entity.d.ts +1 -1
  485. package/dist/unstable/cluster/Entity.js +1 -1
  486. package/dist/unstable/cluster/EntityResource.d.ts +10 -0
  487. package/dist/unstable/cluster/EntityResource.d.ts.map +1 -1
  488. package/dist/unstable/cluster/EntityResource.js +10 -0
  489. package/dist/unstable/cluster/EntityResource.js.map +1 -1
  490. package/dist/unstable/cluster/Envelope.d.ts +2 -2
  491. package/dist/unstable/cluster/Envelope.d.ts.map +1 -1
  492. package/dist/unstable/cluster/Envelope.js +2 -2
  493. package/dist/unstable/cluster/Envelope.js.map +1 -1
  494. package/dist/unstable/cluster/HttpRunner.d.ts +2 -2
  495. package/dist/unstable/cluster/HttpRunner.js +2 -2
  496. package/dist/unstable/cluster/K8sHttpClient.d.ts +1 -1
  497. package/dist/unstable/cluster/K8sHttpClient.js +1 -1
  498. package/dist/unstable/cluster/Reply.d.ts +2 -2
  499. package/dist/unstable/cluster/Reply.d.ts.map +1 -1
  500. package/dist/unstable/cluster/Reply.js +12 -12
  501. package/dist/unstable/cluster/Reply.js.map +1 -1
  502. package/dist/unstable/cluster/RunnerHealth.d.ts +2 -1
  503. package/dist/unstable/cluster/RunnerHealth.d.ts.map +1 -1
  504. package/dist/unstable/cluster/RunnerHealth.js +2 -1
  505. package/dist/unstable/cluster/RunnerHealth.js.map +1 -1
  506. package/dist/unstable/cluster/RunnerServer.d.ts +2 -2
  507. package/dist/unstable/cluster/RunnerServer.js +2 -2
  508. package/dist/unstable/cluster/Runners.d.ts +4 -4
  509. package/dist/unstable/cluster/Runners.js +4 -4
  510. package/dist/unstable/cluster/ShardId.js +3 -3
  511. package/dist/unstable/cluster/ShardId.js.map +1 -1
  512. package/dist/unstable/cluster/Sharding.d.ts +4 -4
  513. package/dist/unstable/cluster/Sharding.js +4 -4
  514. package/dist/unstable/cluster/ShardingConfig.d.ts +4 -4
  515. package/dist/unstable/cluster/ShardingConfig.js +4 -4
  516. package/dist/unstable/cluster/SingletonAddress.d.ts +1 -1
  517. package/dist/unstable/cluster/SingletonAddress.js +1 -1
  518. package/dist/unstable/cluster/Snowflake.d.ts +6 -6
  519. package/dist/unstable/cluster/Snowflake.js +8 -8
  520. package/dist/unstable/cluster/Snowflake.js.map +1 -1
  521. package/dist/unstable/cluster/internal/entityManager.js +2 -2
  522. package/dist/unstable/cluster/internal/entityManager.js.map +1 -1
  523. package/dist/unstable/devtools/DevToolsClient.d.ts +1 -1
  524. package/dist/unstable/devtools/DevToolsClient.js +1 -1
  525. package/dist/unstable/encoding/Msgpack.d.ts +2 -2
  526. package/dist/unstable/encoding/Msgpack.d.ts.map +1 -1
  527. package/dist/unstable/encoding/Msgpack.js +5 -5
  528. package/dist/unstable/encoding/Msgpack.js.map +1 -1
  529. package/dist/unstable/encoding/Ndjson.d.ts +5 -0
  530. package/dist/unstable/encoding/Ndjson.d.ts.map +1 -1
  531. package/dist/unstable/encoding/Ndjson.js +5 -0
  532. package/dist/unstable/encoding/Ndjson.js.map +1 -1
  533. package/dist/unstable/encoding/Sse.d.ts +2 -2
  534. package/dist/unstable/encoding/Sse.d.ts.map +1 -1
  535. package/dist/unstable/encoding/Sse.js +2 -2
  536. package/dist/unstable/encoding/Sse.js.map +1 -1
  537. package/dist/unstable/eventlog/EventGroup.d.ts +2 -1
  538. package/dist/unstable/eventlog/EventGroup.d.ts.map +1 -1
  539. package/dist/unstable/eventlog/EventGroup.js +2 -1
  540. package/dist/unstable/eventlog/EventGroup.js.map +1 -1
  541. package/dist/unstable/eventlog/EventJournal.d.ts +10 -0
  542. package/dist/unstable/eventlog/EventJournal.d.ts.map +1 -1
  543. package/dist/unstable/eventlog/EventJournal.js +10 -0
  544. package/dist/unstable/eventlog/EventJournal.js.map +1 -1
  545. package/dist/unstable/eventlog/EventLog.d.ts +4 -4
  546. package/dist/unstable/eventlog/EventLog.js +4 -4
  547. package/dist/unstable/eventlog/EventLogEncryption.d.ts +1 -1
  548. package/dist/unstable/eventlog/EventLogEncryption.js +1 -1
  549. package/dist/unstable/eventlog/EventLogRemote.d.ts +1 -1
  550. package/dist/unstable/eventlog/EventLogRemote.js +1 -1
  551. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts +2 -3
  552. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts.map +1 -1
  553. package/dist/unstable/eventlog/EventLogServerEncrypted.js +2 -3
  554. package/dist/unstable/eventlog/EventLogServerEncrypted.js.map +1 -1
  555. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +8 -10
  556. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts.map +1 -1
  557. package/dist/unstable/eventlog/EventLogServerUnencrypted.js +8 -10
  558. package/dist/unstable/eventlog/EventLogServerUnencrypted.js.map +1 -1
  559. package/dist/unstable/eventlog/EventLogSessionAuth.d.ts +4 -4
  560. package/dist/unstable/eventlog/EventLogSessionAuth.js +4 -4
  561. package/dist/unstable/http/Cookies.d.ts +1 -1
  562. package/dist/unstable/http/Cookies.js +4 -4
  563. package/dist/unstable/http/Cookies.js.map +1 -1
  564. package/dist/unstable/http/Etag.d.ts +3 -4
  565. package/dist/unstable/http/Etag.d.ts.map +1 -1
  566. package/dist/unstable/http/Etag.js +3 -4
  567. package/dist/unstable/http/Etag.js.map +1 -1
  568. package/dist/unstable/http/FetchHttpClient.d.ts +2 -2
  569. package/dist/unstable/http/FetchHttpClient.js +2 -2
  570. package/dist/unstable/http/Headers.js +2 -2
  571. package/dist/unstable/http/Headers.js.map +1 -1
  572. package/dist/unstable/http/HttpBody.js +2 -2
  573. package/dist/unstable/http/HttpBody.js.map +1 -1
  574. package/dist/unstable/http/HttpClient.d.ts +3 -3
  575. package/dist/unstable/http/HttpClient.js +3 -3
  576. package/dist/unstable/http/HttpClientRequest.d.ts +32 -5
  577. package/dist/unstable/http/HttpClientRequest.d.ts.map +1 -1
  578. package/dist/unstable/http/HttpClientRequest.js +10 -1
  579. package/dist/unstable/http/HttpClientRequest.js.map +1 -1
  580. package/dist/unstable/http/HttpMiddleware.d.ts +1 -1
  581. package/dist/unstable/http/HttpMiddleware.js +1 -1
  582. package/dist/unstable/http/HttpPlatform.d.ts +1 -1
  583. package/dist/unstable/http/HttpPlatform.js +1 -1
  584. package/dist/unstable/http/HttpRouter.d.ts +5 -5
  585. package/dist/unstable/http/HttpRouter.js +5 -5
  586. package/dist/unstable/http/HttpServerResponse.d.ts +28 -23
  587. package/dist/unstable/http/HttpServerResponse.d.ts.map +1 -1
  588. package/dist/unstable/http/HttpServerResponse.js +13 -8
  589. package/dist/unstable/http/HttpServerResponse.js.map +1 -1
  590. package/dist/unstable/http/Multipart.js +3 -3
  591. package/dist/unstable/http/Multipart.js.map +1 -1
  592. package/dist/unstable/http/Url.d.ts +33 -33
  593. package/dist/unstable/http/Url.js +11 -11
  594. package/dist/unstable/http/UrlParams.d.ts +30 -0
  595. package/dist/unstable/http/UrlParams.d.ts.map +1 -1
  596. package/dist/unstable/http/UrlParams.js +16 -6
  597. package/dist/unstable/http/UrlParams.js.map +1 -1
  598. package/dist/unstable/httpapi/HttpApi.d.ts +4 -3
  599. package/dist/unstable/httpapi/HttpApi.d.ts.map +1 -1
  600. package/dist/unstable/httpapi/HttpApi.js +4 -3
  601. package/dist/unstable/httpapi/HttpApi.js.map +1 -1
  602. package/dist/unstable/httpapi/HttpApiBuilder.d.ts.map +1 -1
  603. package/dist/unstable/httpapi/HttpApiBuilder.js +10 -8
  604. package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
  605. package/dist/unstable/httpapi/HttpApiClient.js +15 -15
  606. package/dist/unstable/httpapi/HttpApiClient.js.map +1 -1
  607. package/dist/unstable/httpapi/HttpApiError.d.ts +13 -13
  608. package/dist/unstable/httpapi/HttpApiError.js +13 -13
  609. package/dist/unstable/httpapi/HttpApiMiddleware.d.ts +3 -3
  610. package/dist/unstable/httpapi/HttpApiMiddleware.js +3 -3
  611. package/dist/unstable/httpapi/HttpApiSchema.d.ts +2 -2
  612. package/dist/unstable/httpapi/HttpApiSchema.d.ts.map +1 -1
  613. package/dist/unstable/httpapi/HttpApiSchema.js +9 -9
  614. package/dist/unstable/httpapi/HttpApiSchema.js.map +1 -1
  615. package/dist/unstable/httpapi/OpenApi.js +11 -11
  616. package/dist/unstable/httpapi/OpenApi.js.map +1 -1
  617. package/dist/unstable/observability/OtlpResource.d.ts +5 -0
  618. package/dist/unstable/observability/OtlpResource.d.ts.map +1 -1
  619. package/dist/unstable/observability/OtlpResource.js +5 -0
  620. package/dist/unstable/observability/OtlpResource.js.map +1 -1
  621. package/dist/unstable/observability/PrometheusMetrics.d.ts +8 -6
  622. package/dist/unstable/observability/PrometheusMetrics.d.ts.map +1 -1
  623. package/dist/unstable/observability/PrometheusMetrics.js +6 -4
  624. package/dist/unstable/observability/PrometheusMetrics.js.map +1 -1
  625. package/dist/unstable/persistence/KeyValueStore.d.ts +3 -3
  626. package/dist/unstable/persistence/KeyValueStore.js +1 -1
  627. package/dist/unstable/persistence/Persistable.d.ts +2 -2
  628. package/dist/unstable/persistence/Persistable.js +2 -2
  629. package/dist/unstable/persistence/PersistedQueue.d.ts +8 -8
  630. package/dist/unstable/persistence/PersistedQueue.js +8 -8
  631. package/dist/unstable/persistence/RateLimiter.d.ts +1 -1
  632. package/dist/unstable/persistence/RateLimiter.js +1 -1
  633. package/dist/unstable/process/ChildProcess.d.ts +5 -5
  634. package/dist/unstable/process/ChildProcess.js +2 -2
  635. package/dist/unstable/reactivity/AsyncResult.d.ts +4 -4
  636. package/dist/unstable/reactivity/AsyncResult.js +1 -1
  637. package/dist/unstable/reactivity/Atom.d.ts +4 -4
  638. package/dist/unstable/reactivity/Atom.js +4 -4
  639. package/dist/unstable/reactivity/AtomRegistry.d.ts +1 -1
  640. package/dist/unstable/reactivity/AtomRegistry.js +1 -1
  641. package/dist/unstable/reactivity/Reactivity.d.ts +1 -1
  642. package/dist/unstable/reactivity/Reactivity.js +1 -1
  643. package/dist/unstable/rpc/Rpc.d.ts +5 -5
  644. package/dist/unstable/rpc/Rpc.js +1 -1
  645. package/dist/unstable/rpc/RpcMiddleware.d.ts +1 -1
  646. package/dist/unstable/rpc/RpcMiddleware.js +1 -1
  647. package/dist/unstable/rpc/RpcSchema.d.ts +5 -5
  648. package/dist/unstable/rpc/RpcSchema.d.ts.map +1 -1
  649. package/dist/unstable/rpc/RpcSchema.js +2 -2
  650. package/dist/unstable/rpc/RpcSerialization.d.ts +2 -2
  651. package/dist/unstable/rpc/RpcSerialization.js +2 -2
  652. package/dist/unstable/schema/Model.d.ts +2 -2
  653. package/dist/unstable/schema/Model.js +6 -6
  654. package/dist/unstable/schema/Model.js.map +1 -1
  655. package/dist/unstable/schema/VariantSchema.d.ts +2 -2
  656. package/dist/unstable/schema/VariantSchema.d.ts.map +1 -1
  657. package/dist/unstable/socket/Socket.d.ts +3 -3
  658. package/dist/unstable/socket/Socket.js +3 -3
  659. package/dist/unstable/socket/SocketServer.d.ts +1 -1
  660. package/dist/unstable/socket/SocketServer.js +1 -1
  661. package/dist/unstable/sql/Migrator.d.ts +1 -1
  662. package/dist/unstable/sql/SqlClient.d.ts +3 -3
  663. package/dist/unstable/sql/SqlClient.js +2 -2
  664. package/dist/unstable/sql/SqlConnection.d.ts +1 -1
  665. package/dist/unstable/sql/SqlConnection.js +1 -1
  666. package/dist/unstable/sql/SqlSchema.d.ts +4 -4
  667. package/dist/unstable/sql/SqlSchema.js +4 -4
  668. package/dist/unstable/sql/Statement.d.ts +2 -2
  669. package/dist/unstable/sql/Statement.js +2 -2
  670. package/dist/unstable/workers/Transferable.d.ts +3 -3
  671. package/dist/unstable/workers/Transferable.d.ts.map +1 -1
  672. package/dist/unstable/workers/Transferable.js +6 -6
  673. package/dist/unstable/workers/Transferable.js.map +1 -1
  674. package/dist/unstable/workers/Worker.d.ts +1 -1
  675. package/dist/unstable/workers/Worker.js +1 -1
  676. package/dist/unstable/workflow/Activity.d.ts +1 -1
  677. package/dist/unstable/workflow/Activity.js +1 -1
  678. package/dist/unstable/workflow/DurableDeferred.d.ts +1 -1
  679. package/dist/unstable/workflow/DurableDeferred.js +8 -8
  680. package/dist/unstable/workflow/DurableDeferred.js.map +1 -1
  681. package/dist/unstable/workflow/DurableQueue.d.ts +1 -2
  682. package/dist/unstable/workflow/DurableQueue.d.ts.map +1 -1
  683. package/dist/unstable/workflow/DurableQueue.js +1 -2
  684. package/dist/unstable/workflow/DurableQueue.js.map +1 -1
  685. package/dist/unstable/workflow/Workflow.d.ts +35 -15
  686. package/dist/unstable/workflow/Workflow.d.ts.map +1 -1
  687. package/dist/unstable/workflow/Workflow.js +94 -72
  688. package/dist/unstable/workflow/Workflow.js.map +1 -1
  689. package/dist/unstable/workflow/WorkflowEngine.d.ts +10 -2
  690. package/dist/unstable/workflow/WorkflowEngine.d.ts.map +1 -1
  691. package/dist/unstable/workflow/WorkflowEngine.js +16 -8
  692. package/dist/unstable/workflow/WorkflowEngine.js.map +1 -1
  693. package/dist/unstable/workflow/WorkflowProxy.d.ts +2 -4
  694. package/dist/unstable/workflow/WorkflowProxy.d.ts.map +1 -1
  695. package/dist/unstable/workflow/WorkflowProxy.js +9 -11
  696. package/dist/unstable/workflow/WorkflowProxy.js.map +1 -1
  697. package/dist/unstable/workflow/WorkflowProxyServer.js +7 -7
  698. package/dist/unstable/workflow/WorkflowProxyServer.js.map +1 -1
  699. package/package.json +1 -1
  700. package/src/Array.ts +745 -627
  701. package/src/BigDecimal.ts +37 -30
  702. package/src/BigInt.ts +34 -40
  703. package/src/Boolean.ts +10 -10
  704. package/src/Brand.ts +16 -14
  705. package/src/Cause.ts +21 -23
  706. package/src/Channel.ts +316 -76
  707. package/src/ChannelSchema.ts +11 -11
  708. package/src/Chunk.ts +87 -34
  709. package/src/Clock.ts +3 -3
  710. package/src/Combiner.ts +9 -13
  711. package/src/Config.ts +60 -67
  712. package/src/ConfigProvider.ts +34 -44
  713. package/src/Console.ts +2 -2
  714. package/src/Context.ts +64 -76
  715. package/src/Cron.ts +6 -6
  716. package/src/Crypto.ts +4 -4
  717. package/src/Data.ts +21 -15
  718. package/src/DateTime.ts +35 -16
  719. package/src/Deferred.ts +61 -52
  720. package/src/Duration.ts +50 -37
  721. package/src/Effect.ts +574 -474
  722. package/src/Encoding.ts +5 -0
  723. package/src/Equal.ts +28 -41
  724. package/src/Equivalence.ts +72 -100
  725. package/src/ErrorReporter.ts +1 -1
  726. package/src/ExecutionPlan.ts +2 -2
  727. package/src/Exit.ts +79 -96
  728. package/src/Fiber.ts +8 -6
  729. package/src/FiberHandle.ts +25 -0
  730. package/src/FiberMap.ts +35 -0
  731. package/src/FiberSet.ts +20 -0
  732. package/src/FileSystem.ts +6 -6
  733. package/src/Filter.ts +4 -4
  734. package/src/Formatter.ts +14 -19
  735. package/src/Function.ts +20 -21
  736. package/src/Graph.ts +13 -13
  737. package/src/HKT.ts +3 -3
  738. package/src/Hash.ts +2 -1
  739. package/src/HashMap.ts +18 -3
  740. package/src/HashRing.ts +9 -9
  741. package/src/HashSet.ts +1 -1
  742. package/src/Iterable.ts +39 -27
  743. package/src/JsonPatch.ts +2 -3
  744. package/src/JsonPointer.ts +2 -6
  745. package/src/JsonSchema.ts +17 -13
  746. package/src/Latch.ts +4 -3
  747. package/src/Layer.ts +108 -130
  748. package/src/Logger.ts +22 -25
  749. package/src/ManagedRuntime.ts +2 -2
  750. package/src/Match.ts +22 -22
  751. package/src/Metric.ts +129 -157
  752. package/src/MutableHashMap.ts +35 -20
  753. package/src/MutableList.ts +15 -0
  754. package/src/MutableRef.ts +56 -42
  755. package/src/Newtype.ts +10 -7
  756. package/src/Number.ts +23 -11
  757. package/src/Optic.ts +25 -22
  758. package/src/Option.ts +232 -204
  759. package/src/Order.ts +119 -180
  760. package/src/PartitionedSemaphore.ts +14 -14
  761. package/src/Path.ts +3 -3
  762. package/src/Pipeable.ts +3 -3
  763. package/src/PlatformError.ts +4 -4
  764. package/src/Pool.ts +7 -11
  765. package/src/Predicate.ts +279 -268
  766. package/src/PubSub.ts +33 -23
  767. package/src/Pull.ts +4 -4
  768. package/src/Queue.ts +70 -31
  769. package/src/RcRef.ts +0 -4
  770. package/src/Record.ts +15 -15
  771. package/src/Redactable.ts +2 -2
  772. package/src/Redacted.ts +5 -5
  773. package/src/Reducer.ts +2 -3
  774. package/src/Ref.ts +61 -58
  775. package/src/References.ts +4 -4
  776. package/src/RegExp.ts +1 -1
  777. package/src/Request.ts +22 -22
  778. package/src/RequestResolver.ts +8 -8
  779. package/src/Resource.ts +3 -3
  780. package/src/Result.ts +105 -51
  781. package/src/Runtime.ts +11 -8
  782. package/src/Schedule.ts +157 -90
  783. package/src/Scheduler.ts +6 -4
  784. package/src/Schema.ts +1020 -1108
  785. package/src/SchemaAST.ts +149 -118
  786. package/src/SchemaGetter.ts +155 -134
  787. package/src/SchemaIssue.ts +39 -41
  788. package/src/SchemaParser.ts +176 -232
  789. package/src/SchemaRepresentation.ts +38 -28
  790. package/src/SchemaTransformation.ts +233 -207
  791. package/src/SchemaUtils.ts +2 -2
  792. package/src/Scope.ts +16 -1
  793. package/src/ScopedCache.ts +1 -1
  794. package/src/ScopedRef.ts +14 -18
  795. package/src/Semaphore.ts +9 -9
  796. package/src/Sink.ts +18 -18
  797. package/src/Stdio.ts +4 -5
  798. package/src/Stream.ts +411 -114
  799. package/src/String.ts +11 -14
  800. package/src/Struct.ts +23 -21
  801. package/src/SubscriptionRef.ts +24 -19
  802. package/src/SynchronizedRef.ts +145 -120
  803. package/src/Terminal.ts +1 -1
  804. package/src/Tracer.ts +9 -9
  805. package/src/Trie.ts +15 -0
  806. package/src/Tuple.ts +39 -33
  807. package/src/TxHashMap.ts +3 -3
  808. package/src/TxHashSet.ts +1 -1
  809. package/src/TxReentrantLock.ts +6 -3
  810. package/src/TxRef.ts +16 -16
  811. package/src/TxSubscriptionRef.ts +43 -27
  812. package/src/Types.ts +12 -39
  813. package/src/UndefinedOr.ts +15 -14
  814. package/src/Unify.ts +9 -9
  815. package/src/internal/schema/annotations.ts +4 -4
  816. package/src/internal/schema/arbitrary.ts +16 -16
  817. package/src/internal/schema/equivalence.ts +11 -11
  818. package/src/internal/schema/representation.ts +23 -23
  819. package/src/internal/schema/schema.ts +17 -17
  820. package/src/testing/TestClock.ts +5 -5
  821. package/src/testing/TestConsole.ts +3 -3
  822. package/src/testing/TestSchema.ts +20 -20
  823. package/src/unstable/ai/AiError.ts +4 -2
  824. package/src/unstable/ai/AnthropicStructuredOutput.ts +59 -56
  825. package/src/unstable/ai/Chat.ts +6 -7
  826. package/src/unstable/ai/EmbeddingModel.ts +5 -5
  827. package/src/unstable/ai/IdGenerator.ts +4 -5
  828. package/src/unstable/ai/LanguageModel.ts +9 -8
  829. package/src/unstable/ai/McpSchema.ts +19 -17
  830. package/src/unstable/ai/McpServer.ts +14 -7
  831. package/src/unstable/ai/OpenAiStructuredOutput.ts +72 -61
  832. package/src/unstable/ai/Prompt.ts +20 -20
  833. package/src/unstable/ai/ResponseIdTracker.ts +3 -2
  834. package/src/unstable/ai/Telemetry.ts +26 -11
  835. package/src/unstable/ai/Tokenizer.ts +1 -1
  836. package/src/unstable/ai/Tool.ts +17 -16
  837. package/src/unstable/ai/Toolkit.ts +2 -2
  838. package/src/unstable/cli/Command.ts +42 -17
  839. package/src/unstable/cli/Completions.ts +1 -1
  840. package/src/unstable/cli/Flag.ts +7 -6
  841. package/src/unstable/cli/GlobalFlag.ts +7 -1
  842. package/src/unstable/cli/Param.ts +24 -19
  843. package/src/unstable/cli/Primitive.ts +6 -5
  844. package/src/unstable/cli/Prompt.ts +11 -11
  845. package/src/unstable/cli/internal/parser.ts +204 -10
  846. package/src/unstable/cluster/ClusterCron.ts +1 -2
  847. package/src/unstable/cluster/ClusterMetrics.ts +5 -0
  848. package/src/unstable/cluster/ClusterSchema.ts +3 -3
  849. package/src/unstable/cluster/ClusterWorkflowEngine.ts +15 -15
  850. package/src/unstable/cluster/Entity.ts +1 -1
  851. package/src/unstable/cluster/EntityResource.ts +10 -0
  852. package/src/unstable/cluster/Envelope.ts +3 -3
  853. package/src/unstable/cluster/HttpRunner.ts +2 -2
  854. package/src/unstable/cluster/K8sHttpClient.ts +1 -1
  855. package/src/unstable/cluster/Reply.ts +14 -12
  856. package/src/unstable/cluster/RunnerHealth.ts +2 -1
  857. package/src/unstable/cluster/RunnerServer.ts +2 -2
  858. package/src/unstable/cluster/Runners.ts +4 -4
  859. package/src/unstable/cluster/ShardId.ts +3 -3
  860. package/src/unstable/cluster/Sharding.ts +4 -4
  861. package/src/unstable/cluster/ShardingConfig.ts +4 -4
  862. package/src/unstable/cluster/SingletonAddress.ts +1 -1
  863. package/src/unstable/cluster/Snowflake.ts +8 -8
  864. package/src/unstable/cluster/internal/entityManager.ts +2 -2
  865. package/src/unstable/devtools/DevToolsClient.ts +1 -1
  866. package/src/unstable/encoding/Msgpack.ts +6 -6
  867. package/src/unstable/encoding/Ndjson.ts +5 -0
  868. package/src/unstable/encoding/Sse.ts +2 -2
  869. package/src/unstable/eventlog/EventGroup.ts +2 -1
  870. package/src/unstable/eventlog/EventJournal.ts +10 -0
  871. package/src/unstable/eventlog/EventLog.ts +4 -4
  872. package/src/unstable/eventlog/EventLogEncryption.ts +1 -1
  873. package/src/unstable/eventlog/EventLogRemote.ts +1 -1
  874. package/src/unstable/eventlog/EventLogServerEncrypted.ts +2 -3
  875. package/src/unstable/eventlog/EventLogServerUnencrypted.ts +8 -10
  876. package/src/unstable/eventlog/EventLogSessionAuth.ts +4 -4
  877. package/src/unstable/http/Cookies.ts +5 -5
  878. package/src/unstable/http/Etag.ts +3 -4
  879. package/src/unstable/http/FetchHttpClient.ts +2 -2
  880. package/src/unstable/http/Headers.ts +2 -2
  881. package/src/unstable/http/HttpBody.ts +2 -2
  882. package/src/unstable/http/HttpClient.ts +3 -3
  883. package/src/unstable/http/HttpClientRequest.ts +32 -5
  884. package/src/unstable/http/HttpMiddleware.ts +1 -1
  885. package/src/unstable/http/HttpPlatform.ts +1 -1
  886. package/src/unstable/http/HttpRouter.ts +5 -5
  887. package/src/unstable/http/HttpServerResponse.ts +28 -23
  888. package/src/unstable/http/Multipart.ts +3 -3
  889. package/src/unstable/http/Url.ts +33 -33
  890. package/src/unstable/http/UrlParams.ts +36 -6
  891. package/src/unstable/httpapi/HttpApi.ts +6 -5
  892. package/src/unstable/httpapi/HttpApiBuilder.ts +14 -13
  893. package/src/unstable/httpapi/HttpApiClient.ts +16 -16
  894. package/src/unstable/httpapi/HttpApiError.ts +13 -13
  895. package/src/unstable/httpapi/HttpApiMiddleware.ts +3 -3
  896. package/src/unstable/httpapi/HttpApiSchema.ts +15 -15
  897. package/src/unstable/httpapi/OpenApi.ts +18 -18
  898. package/src/unstable/observability/OtlpResource.ts +5 -0
  899. package/src/unstable/observability/PrometheusMetrics.ts +8 -6
  900. package/src/unstable/persistence/KeyValueStore.ts +3 -3
  901. package/src/unstable/persistence/Persistable.ts +2 -2
  902. package/src/unstable/persistence/PersistedQueue.ts +8 -8
  903. package/src/unstable/persistence/RateLimiter.ts +1 -1
  904. package/src/unstable/process/ChildProcess.ts +5 -5
  905. package/src/unstable/reactivity/AsyncResult.ts +4 -4
  906. package/src/unstable/reactivity/Atom.ts +4 -4
  907. package/src/unstable/reactivity/AtomRegistry.ts +1 -1
  908. package/src/unstable/reactivity/Reactivity.ts +1 -1
  909. package/src/unstable/rpc/Rpc.ts +5 -5
  910. package/src/unstable/rpc/RpcMiddleware.ts +1 -1
  911. package/src/unstable/rpc/RpcSchema.ts +5 -5
  912. package/src/unstable/rpc/RpcSerialization.ts +2 -2
  913. package/src/unstable/schema/Model.ts +7 -7
  914. package/src/unstable/schema/VariantSchema.ts +2 -2
  915. package/src/unstable/socket/Socket.ts +3 -3
  916. package/src/unstable/socket/SocketServer.ts +1 -1
  917. package/src/unstable/sql/Migrator.ts +1 -1
  918. package/src/unstable/sql/SqlClient.ts +3 -3
  919. package/src/unstable/sql/SqlConnection.ts +1 -1
  920. package/src/unstable/sql/SqlSchema.ts +4 -4
  921. package/src/unstable/sql/Statement.ts +2 -2
  922. package/src/unstable/workers/Transferable.ts +7 -7
  923. package/src/unstable/workers/Worker.ts +1 -1
  924. package/src/unstable/workflow/Activity.ts +1 -1
  925. package/src/unstable/workflow/DurableDeferred.ts +8 -8
  926. package/src/unstable/workflow/DurableQueue.ts +1 -2
  927. package/src/unstable/workflow/Workflow.ts +159 -114
  928. package/src/unstable/workflow/WorkflowEngine.ts +16 -8
  929. package/src/unstable/workflow/WorkflowProxy.ts +9 -11
  930. package/src/unstable/workflow/WorkflowProxyServer.ts +7 -7
@@ -5,14 +5,14 @@ import type { TupleOf, TupleOfAtLeast } from "./Types.ts";
5
5
  *
6
6
  * **When to use**
7
7
  *
8
- * Use when you want a reusable boolean check for `A`.
9
- * - You plan to combine checks with {@link and}/{@link or}.
10
- * - You want a simple filter predicate for arrays or iterables.
8
+ * Use when you want a reusable boolean check for `A`, especially when you plan
9
+ * to combine checks with {@link and}/{@link or} or pass a predicate to arrays
10
+ * and iterables.
11
11
  *
12
12
  * **Details**
13
13
  *
14
- * - Returns `true` or `false`; never throws by itself.
15
- * - Does not narrow types unless you use {@link Refinement}.
14
+ * A predicate returns `true` or `false` and never throws by itself. It does not
15
+ * narrow types unless you use `Refinement`.
16
16
  *
17
17
  * **Example** (Define a predicate)
18
18
  *
@@ -38,13 +38,13 @@ export interface Predicate<in A> {
38
38
  *
39
39
  * **When to use**
40
40
  *
41
- * Use when you are defining APIs that abstract over predicates with HKTs.
42
- * - You need a `TypeLambda` instance for predicate-based type classes.
41
+ * Use when you are defining APIs that abstract over predicates with HKTs and
42
+ * need a `TypeLambda` instance for predicate-based type classes.
43
43
  *
44
44
  * **Details**
45
45
  *
46
- * - Type-only; no runtime value is created.
47
- * - Does not affect emitted JavaScript.
46
+ * This is type-only, creates no runtime value, and does not affect emitted
47
+ * JavaScript.
48
48
  *
49
49
  * **Example** (Type-level usage)
50
50
  *
@@ -67,14 +67,14 @@ export interface PredicateTypeLambda extends TypeLambda {
67
67
  *
68
68
  * **When to use**
69
69
  *
70
- * Use when you want a runtime check that refines `A` to `B` for TypeScript.
71
- * - You want to compose multiple type guards with {@link compose}.
72
- * - You need to guard `unknown` values safely.
70
+ * Use when you want a runtime check that refines `A` to `B` for TypeScript,
71
+ * especially when composing type guards with {@link compose} or safely
72
+ * checking `unknown` values.
73
73
  *
74
74
  * **Details**
75
75
  *
76
- * - Returns a type predicate (`a is B`).
77
- * - Use with `if`/`filter` to narrow types.
76
+ * A refinement returns a type predicate (`a is B`). Use it with `if` or
77
+ * `filter` to narrow types.
78
78
  *
79
79
  * **Example** (Narrow unknown)
80
80
  *
@@ -103,13 +103,13 @@ export interface Refinement<in A, out B extends A> {
103
103
  *
104
104
  * **When to use**
105
105
  *
106
- * Use when you need to extract input types from predicate signatures.
107
- * - You want to write generic helpers over predicate types.
106
+ * Use when you need to extract input types from predicate signatures while
107
+ * writing generic helpers over predicate types.
108
108
  *
109
109
  * **Details**
110
110
  *
111
- * - Type-only; no runtime value is created.
112
- * - The namespace is erased at runtime.
111
+ * These utilities are type-only, create no runtime values, and the namespace is
112
+ * erased at runtime.
113
113
  *
114
114
  * **Example** (Extract predicate input)
115
115
  *
@@ -130,13 +130,13 @@ export declare namespace Predicate {
130
130
  *
131
131
  * **When to use**
132
132
  *
133
- * Use when you want to infer the input type from a predicate type.
134
- * - You are defining generic utilities over predicates.
133
+ * Use when you want to infer the input type from a predicate type while
134
+ * defining generic utilities over predicates.
135
135
  *
136
136
  * **Details**
137
137
  *
138
- * - Type-only; no runtime value is created.
139
- * - Resolves to `never` if the type does not match `Predicate`.
138
+ * This is type-only and creates no runtime value. It resolves to `never` if
139
+ * the type does not match `Predicate`.
140
140
  *
141
141
  * **Example** (Infer input)
142
142
  *
@@ -149,7 +149,7 @@ export declare namespace Predicate {
149
149
  *
150
150
  * @see {@link Predicate.Any}
151
151
  * @see {@link Refinement.In}
152
- * @category type-level
152
+ * @category utility types
153
153
  * @since 3.6.0
154
154
  */
155
155
  type In<T extends Any> = [T] extends [Predicate<infer _A>] ? _A : never;
@@ -162,7 +162,7 @@ export declare namespace Predicate {
162
162
  *
163
163
  * **Details**
164
164
  *
165
- * - Type-only; no runtime value is created.
165
+ * This is type-only and creates no runtime value.
166
166
  *
167
167
  * **Example** (Generic constraint)
168
168
  *
@@ -173,7 +173,7 @@ export declare namespace Predicate {
173
173
  * ```
174
174
  *
175
175
  * @see {@link Predicate.In}
176
- * @category type-level
176
+ * @category utility types
177
177
  * @since 3.6.0
178
178
  */
179
179
  type Any = Predicate<any>;
@@ -183,13 +183,13 @@ export declare namespace Predicate {
183
183
  *
184
184
  * **When to use**
185
185
  *
186
- * Use when you need to extract input/output types from refinement signatures.
187
- * - You want to write generic helpers over refinements.
186
+ * Use when you need to extract input and output types from refinement
187
+ * signatures while writing generic helpers over refinements.
188
188
  *
189
189
  * **Details**
190
190
  *
191
- * - Type-only; no runtime value is created.
192
- * - The namespace is erased at runtime.
191
+ * These utilities are type-only, create no runtime values, and the namespace is
192
+ * erased at runtime.
193
193
  *
194
194
  * **Example** (Extract refinement types)
195
195
  *
@@ -215,8 +215,8 @@ export declare namespace Refinement {
215
215
  *
216
216
  * **Details**
217
217
  *
218
- * - Type-only; no runtime value is created.
219
- * - Resolves to `never` if the type does not match `Refinement`.
218
+ * This is type-only and creates no runtime value. It resolves to `never` if
219
+ * the type does not match `Refinement`.
220
220
  *
221
221
  * **Example** (Infer input)
222
222
  *
@@ -229,7 +229,7 @@ export declare namespace Refinement {
229
229
  *
230
230
  * @see {@link Refinement.Out}
231
231
  * @see {@link Predicate.In}
232
- * @category type-level
232
+ * @category utility types
233
233
  * @since 3.6.0
234
234
  */
235
235
  type In<T extends Any> = [T] extends [Refinement<infer _A, infer _>] ? _A : never;
@@ -242,8 +242,8 @@ export declare namespace Refinement {
242
242
  *
243
243
  * **Details**
244
244
  *
245
- * - Type-only; no runtime value is created.
246
- * - Resolves to `never` if the type does not match `Refinement`.
245
+ * This is type-only and creates no runtime value. It resolves to `never` if
246
+ * the type does not match `Refinement`.
247
247
  *
248
248
  * **Example** (Infer output)
249
249
  *
@@ -255,7 +255,7 @@ export declare namespace Refinement {
255
255
  * ```
256
256
  *
257
257
  * @see {@link Refinement.In}
258
- * @category type-level
258
+ * @category utility types
259
259
  * @since 3.6.0
260
260
  */
261
261
  type Out<T extends Any> = [T] extends [Refinement<infer _, infer _B>] ? _B : never;
@@ -268,7 +268,7 @@ export declare namespace Refinement {
268
268
  *
269
269
  * **Details**
270
270
  *
271
- * - Type-only; no runtime value is created.
271
+ * This is type-only and creates no runtime value.
272
272
  *
273
273
  * **Example** (Generic constraint)
274
274
  *
@@ -280,7 +280,7 @@ export declare namespace Refinement {
280
280
  *
281
281
  * @see {@link Refinement.In}
282
282
  * @see {@link Refinement.Out}
283
- * @category type-level
283
+ * @category utility types
284
284
  * @since 3.6.0
285
285
  */
286
286
  type Any = Refinement<any, any>;
@@ -290,13 +290,13 @@ export declare namespace Refinement {
290
290
  *
291
291
  * **When to use**
292
292
  *
293
- * Use when you have a predicate on `A` and want one on `B` via `B -> A`.
294
- * - You want to check derived values (lengths, projections, etc.).
293
+ * Use when you have a predicate on `A` and want to check `B` values by mapping
294
+ * each `B` to an `A`, such as checking lengths or projections.
295
295
  *
296
296
  * **Details**
297
297
  *
298
- * - Returns a new predicate that applies `f` before `self`.
299
- * - No short-circuit beyond what `self` does.
298
+ * Returns a new predicate that applies `f` before `self`. There is no
299
+ * additional short-circuiting beyond what `self` does.
300
300
  *
301
301
  * **Example** (Check string length)
302
302
  *
@@ -322,13 +322,13 @@ export declare const mapInput: {
322
322
  *
323
323
  * **When to use**
324
324
  *
325
- * Use when you have a predicate on `A` and want one on `B` via `B -> A`.
326
- * - You want to check derived values (lengths, projections, etc.).
325
+ * Use when you have a predicate on `A` and want to check `B` values by mapping
326
+ * each `B` to an `A`, such as checking lengths or projections.
327
327
  *
328
328
  * **Details**
329
329
  *
330
- * - Returns a new predicate that applies `f` before `self`.
331
- * - No short-circuit beyond what `self` does.
330
+ * Returns a new predicate that applies `f` before `self`. There is no
331
+ * additional short-circuiting beyond what `self` does.
332
332
  *
333
333
  * **Example** (Check string length)
334
334
  *
@@ -354,13 +354,13 @@ export declare const mapInput: {
354
354
  *
355
355
  * **When to use**
356
356
  *
357
- * Use when you have a predicate on `A` and want one on `B` via `B -> A`.
358
- * - You want to check derived values (lengths, projections, etc.).
357
+ * Use when you have a predicate on `A` and want to check `B` values by mapping
358
+ * each `B` to an `A`, such as checking lengths or projections.
359
359
  *
360
360
  * **Details**
361
361
  *
362
- * - Returns a new predicate that applies `f` before `self`.
363
- * - No short-circuit beyond what `self` does.
362
+ * Returns a new predicate that applies `f` before `self`. There is no
363
+ * additional short-circuiting beyond what `self` does.
364
364
  *
365
365
  * **Example** (Check string length)
366
366
  *
@@ -387,13 +387,13 @@ export declare const mapInput: {
387
387
  *
388
388
  * **When to use**
389
389
  *
390
- * Use when you need a runtime check for tuple length.
391
- * - You want to narrow `ReadonlyArray<T>` to `TupleOf<N, T>`.
390
+ * Use when you need a `Predicate` guard for exact tuple length that narrows
391
+ * `ReadonlyArray<T>` to `TupleOf<N, T>`.
392
392
  *
393
393
  * **Details**
394
394
  *
395
- * - Only checks length, not element types.
396
- * - Returns a refinement on the array type.
395
+ * This only checks length, not element types, and returns a refinement on the
396
+ * array type.
397
397
  *
398
398
  * **Example** (Exact length)
399
399
  *
@@ -416,13 +416,13 @@ export declare const isTupleOf: {
416
416
  *
417
417
  * **When to use**
418
418
  *
419
- * Use when you need a runtime check for tuple length.
420
- * - You want to narrow `ReadonlyArray<T>` to `TupleOf<N, T>`.
419
+ * Use when you need a `Predicate` guard for exact tuple length that narrows
420
+ * `ReadonlyArray<T>` to `TupleOf<N, T>`.
421
421
  *
422
422
  * **Details**
423
423
  *
424
- * - Only checks length, not element types.
425
- * - Returns a refinement on the array type.
424
+ * This only checks length, not element types, and returns a refinement on the
425
+ * array type.
426
426
  *
427
427
  * **Example** (Exact length)
428
428
  *
@@ -445,13 +445,13 @@ export declare const isTupleOf: {
445
445
  *
446
446
  * **When to use**
447
447
  *
448
- * Use when you need a runtime check for tuple length.
449
- * - You want to narrow `ReadonlyArray<T>` to `TupleOf<N, T>`.
448
+ * Use when you need a `Predicate` guard for exact tuple length that narrows
449
+ * `ReadonlyArray<T>` to `TupleOf<N, T>`.
450
450
  *
451
451
  * **Details**
452
452
  *
453
- * - Only checks length, not element types.
454
- * - Returns a refinement on the array type.
453
+ * This only checks length, not element types, and returns a refinement on the
454
+ * array type.
455
455
  *
456
456
  * **Example** (Exact length)
457
457
  *
@@ -475,13 +475,13 @@ export declare const isTupleOf: {
475
475
  *
476
476
  * **When to use**
477
477
  *
478
- * Use when you need a runtime check for tuple-like minimum length.
479
- * - You want to narrow `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
478
+ * Use when you need a `Predicate` guard for tuple-like minimum length that
479
+ * narrows `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
480
480
  *
481
481
  * **Details**
482
482
  *
483
- * - Only checks length, not element types.
484
- * - Returns a refinement on the array type.
483
+ * This only checks length, not element types, and returns a refinement on the
484
+ * array type.
485
485
  *
486
486
  * **Example** (Minimum length)
487
487
  *
@@ -504,13 +504,13 @@ export declare const isTupleOfAtLeast: {
504
504
  *
505
505
  * **When to use**
506
506
  *
507
- * Use when you need a runtime check for tuple-like minimum length.
508
- * - You want to narrow `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
507
+ * Use when you need a `Predicate` guard for tuple-like minimum length that
508
+ * narrows `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
509
509
  *
510
510
  * **Details**
511
511
  *
512
- * - Only checks length, not element types.
513
- * - Returns a refinement on the array type.
512
+ * This only checks length, not element types, and returns a refinement on the
513
+ * array type.
514
514
  *
515
515
  * **Example** (Minimum length)
516
516
  *
@@ -533,13 +533,13 @@ export declare const isTupleOfAtLeast: {
533
533
  *
534
534
  * **When to use**
535
535
  *
536
- * Use when you need a runtime check for tuple-like minimum length.
537
- * - You want to narrow `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
536
+ * Use when you need a `Predicate` guard for tuple-like minimum length that
537
+ * narrows `ReadonlyArray<T>` to `TupleOfAtLeast<N, T>`.
538
538
  *
539
539
  * **Details**
540
540
  *
541
- * - Only checks length, not element types.
542
- * - Returns a refinement on the array type.
541
+ * This only checks length, not element types, and returns a refinement on the
542
+ * array type.
543
543
  *
544
544
  * **Example** (Minimum length)
545
545
  *
@@ -563,13 +563,13 @@ export declare const isTupleOfAtLeast: {
563
563
  *
564
564
  * **When to use**
565
565
  *
566
- * Use when you want a predicate that mirrors JavaScript truthiness.
567
- * - You need to filter out falsy values like `0`, "", and `false`.
566
+ * Use when you want a predicate that mirrors JavaScript truthiness and filters
567
+ * out falsy values like `0`, `""`, and `false`.
568
568
  *
569
569
  * **Details**
570
570
  *
571
- * - Uses `!!input` under the hood.
572
- * - Treats `0`, "", `false`, `null`, and `undefined` as false.
571
+ * This uses `!!input` and treats `0`, `""`, `false`, `null`, and `undefined`
572
+ * as false.
573
573
  *
574
574
  * **Example** (Filter truthy)
575
575
  *
@@ -593,11 +593,11 @@ export declare function isTruthy(input: unknown): boolean;
593
593
  *
594
594
  * **When to use**
595
595
  *
596
- * Use when you need a runtime guard for `Set` values.
596
+ * Use when you need a `Predicate` runtime guard for `Set` values.
597
597
  *
598
598
  * **Details**
599
599
  *
600
- * - Uses `instanceof Set`.
600
+ * Uses `instanceof Set`.
601
601
  *
602
602
  * **Example** (Guard a Set)
603
603
  *
@@ -622,11 +622,11 @@ export declare function isSet(input: unknown): input is Set<unknown>;
622
622
  *
623
623
  * **When to use**
624
624
  *
625
- * Use when you need a runtime guard for `Map` values.
625
+ * Use when you need a `Predicate` runtime guard for `Map` values.
626
626
  *
627
627
  * **Details**
628
628
  *
629
- * - Uses `instanceof Map`.
629
+ * Uses `instanceof Map`.
630
630
  *
631
631
  * **Example** (Guard a Map)
632
632
  *
@@ -651,12 +651,12 @@ export declare function isMap(input: unknown): input is Map<unknown, unknown>;
651
651
  *
652
652
  * **When to use**
653
653
  *
654
- * Use when you need to guard an `unknown` value as a string.
655
- * - You want to narrow in `if` statements.
654
+ * Use when you need a `Predicate` guard to narrow an `unknown` value to a
655
+ * string.
656
656
  *
657
657
  * **Details**
658
658
  *
659
- * - Uses `typeof input === "string"`.
659
+ * Uses `typeof input === "string"`.
660
660
  *
661
661
  * **Example** (Guard string)
662
662
  *
@@ -682,12 +682,12 @@ export declare function isString(input: unknown): input is string;
682
682
  *
683
683
  * **When to use**
684
684
  *
685
- * Use when you need to guard an `unknown` value as a number.
685
+ * Use when you need a `Predicate` guard to narrow an `unknown` value to a
686
+ * number.
686
687
  *
687
688
  * **Details**
688
689
  *
689
- * - Uses `typeof input === "number"`.
690
- * - Does not exclude `NaN` or `Infinity`.
690
+ * Uses `typeof input === "number"` and does not exclude `NaN` or `Infinity`.
691
691
  *
692
692
  * **Example** (Guard number)
693
693
  *
@@ -712,11 +712,12 @@ export declare function isNumber(input: unknown): input is number;
712
712
  *
713
713
  * **When to use**
714
714
  *
715
- * Use when you need to guard an `unknown` value as a boolean.
715
+ * Use when you need a `Predicate` guard to narrow an `unknown` value to a
716
+ * boolean.
716
717
  *
717
718
  * **Details**
718
719
  *
719
- * - Uses `typeof input === "boolean"`.
720
+ * Uses `typeof input === "boolean"`.
720
721
  *
721
722
  * **Example** (Guard boolean)
722
723
  *
@@ -741,11 +742,12 @@ export declare function isBoolean(input: unknown): input is boolean;
741
742
  *
742
743
  * **When to use**
743
744
  *
744
- * Use when you need to guard an `unknown` value as a bigint.
745
+ * Use when you need a `Predicate` guard to narrow an `unknown` value to a
746
+ * bigint.
745
747
  *
746
748
  * **Details**
747
749
  *
748
- * - Uses `typeof input === "bigint"`.
750
+ * Uses `typeof input === "bigint"`.
749
751
  *
750
752
  * **Example** (Guard bigint)
751
753
  *
@@ -769,11 +771,12 @@ export declare function isBigInt(input: unknown): input is bigint;
769
771
  *
770
772
  * **When to use**
771
773
  *
772
- * Use when you need to guard an `unknown` value as a symbol.
774
+ * Use when you need a `Predicate` guard to narrow an `unknown` value to a
775
+ * symbol.
773
776
  *
774
777
  * **Details**
775
778
  *
776
- * - Uses `typeof input === "symbol"`.
779
+ * Uses `typeof input === "symbol"`.
777
780
  *
778
781
  * **Example** (Guard symbol)
779
782
  *
@@ -797,11 +800,12 @@ export declare function isSymbol(input: unknown): input is symbol;
797
800
  *
798
801
  * **When to use**
799
802
  *
800
- * Use when you need to guard unknown keys before indexing.
803
+ * Use when you need a `Predicate` guard for unknown property keys before
804
+ * indexing.
801
805
  *
802
806
  * **Details**
803
807
  *
804
- * - Uses {@link isString}, {@link isNumber}, and {@link isSymbol}.
808
+ * Uses `isString`, `isNumber`, and `isSymbol`.
805
809
  *
806
810
  * **Example** (Guard property key)
807
811
  *
@@ -828,11 +832,12 @@ export declare function isPropertyKey(u: unknown): u is PropertyKey;
828
832
  *
829
833
  * **When to use**
830
834
  *
831
- * Use when you need to guard an `unknown` value as callable.
835
+ * Use when you need a `Predicate` guard to narrow an `unknown` value to a
836
+ * callable function.
832
837
  *
833
838
  * **Details**
834
839
  *
835
- * - Uses `typeof input === "function"`.
840
+ * Uses `typeof input === "function"`.
836
841
  *
837
842
  * **Example** (Guard function)
838
843
  *
@@ -856,11 +861,12 @@ export declare function isFunction(input: unknown): input is Function;
856
861
  *
857
862
  * **When to use**
858
863
  *
859
- * Use when you need a guard for optional values.
864
+ * Use when you need a `Predicate` guard for values that are exactly
865
+ * `undefined`.
860
866
  *
861
867
  * **Details**
862
868
  *
863
- * - Uses `input === undefined`.
869
+ * Uses `input === undefined`.
864
870
  *
865
871
  * **Example** (Guard undefined)
866
872
  *
@@ -883,11 +889,12 @@ export declare function isUndefined(input: unknown): input is undefined;
883
889
  *
884
890
  * **When to use**
885
891
  *
886
- * Use when you want to filter out `undefined` while preserving other falsy values.
892
+ * Use when you need a `Predicate` refinement that filters out `undefined`
893
+ * while preserving other falsy values.
887
894
  *
888
895
  * **Details**
889
896
  *
890
- * - Returns a refinement that excludes `undefined`.
897
+ * Returns a refinement that excludes `undefined`.
891
898
  *
892
899
  * **Example** (Filter undefined)
893
900
  *
@@ -911,11 +918,11 @@ export declare function isNotUndefined<A>(input: A): input is Exclude<A, undefin
911
918
  *
912
919
  * **When to use**
913
920
  *
914
- * Use when you need a guard for nullable values.
921
+ * Use when you need a `Predicate` guard for nullable values.
915
922
  *
916
923
  * **Details**
917
924
  *
918
- * - Uses `input === null`.
925
+ * Uses `input === null`.
919
926
  *
920
927
  * **Example** (Guard null)
921
928
  *
@@ -938,11 +945,12 @@ export declare function isNull(input: unknown): input is null;
938
945
  *
939
946
  * **When to use**
940
947
  *
941
- * Use when you want to filter out `null` while preserving other falsy values.
948
+ * Use when you need a `Predicate` refinement that filters out `null` while
949
+ * preserving other falsy values.
942
950
  *
943
951
  * **Details**
944
952
  *
945
- * - Returns a refinement that excludes `null`.
953
+ * Returns a refinement that excludes `null`.
946
954
  *
947
955
  * **Example** (Filter null)
948
956
  *
@@ -966,11 +974,11 @@ export declare function isNotNull<A>(input: A): input is Exclude<A, null>;
966
974
  *
967
975
  * **When to use**
968
976
  *
969
- * Use when you want to guard nullish values explicitly.
977
+ * Use when you need a `Predicate` guard for nullish values.
970
978
  *
971
979
  * **Details**
972
980
  *
973
- * - Uses `input === null || input === undefined`.
981
+ * Uses `input === null || input === undefined`.
974
982
  *
975
983
  * **Example** (Guard nullish)
976
984
  *
@@ -995,11 +1003,12 @@ export declare function isNullish<A>(input: A): input is A & (null | undefined);
995
1003
  *
996
1004
  * **When to use**
997
1005
  *
998
- * Use when you want to filter out nullish values but keep other falsy ones.
1006
+ * Use when you need a `Predicate` refinement that filters out nullish values
1007
+ * but keeps other falsy ones.
999
1008
  *
1000
1009
  * **Details**
1001
1010
  *
1002
- * - Uses `input != null`.
1011
+ * Uses `input != null`.
1003
1012
  *
1004
1013
  * **Example** (Filter non-nullish)
1005
1014
  *
@@ -1024,11 +1033,7 @@ export declare function isNotNullish<A>(input: A): input is NonNullable<A>;
1024
1033
  *
1025
1034
  * **When to use**
1026
1035
  *
1027
- * Use when you need a predicate that never accepts, e.g. in default branches.
1028
- *
1029
- * **Details**
1030
- *
1031
- * - Always returns `false`.
1036
+ * Use when you need a `Predicate` that never accepts, e.g. in default branches.
1032
1037
  *
1033
1038
  * **Example** (Never matches)
1034
1039
  *
@@ -1048,11 +1053,7 @@ export declare function isNever(_: unknown): _ is never;
1048
1053
  *
1049
1054
  * **When to use**
1050
1055
  *
1051
- * Use when you need a predicate that always accepts, e.g. as a placeholder.
1052
- *
1053
- * **Details**
1054
- *
1055
- * - Always returns `true`.
1056
+ * Use when you need a `Predicate` that always accepts, e.g. as a placeholder.
1056
1057
  *
1057
1058
  * **Example** (Always matches)
1058
1059
  *
@@ -1072,12 +1073,12 @@ export declare function isUnknown(_: unknown): _ is unknown;
1072
1073
  *
1073
1074
  * **When to use**
1074
1075
  *
1075
- * Use when you want to accept plain objects and arrays, but not `null`.
1076
+ * Use when you need a `Predicate` guard that accepts plain objects and arrays,
1077
+ * but not `null`.
1076
1078
  *
1077
1079
  * **Details**
1078
1080
  *
1079
- * - Uses `typeof input === "object" && input !== null`.
1080
- * - Includes arrays.
1081
+ * Uses `typeof input === "object" && input !== null` and includes arrays.
1081
1082
  *
1082
1083
  * **Example** (Object or array)
1083
1084
  *
@@ -1100,7 +1101,8 @@ export declare function isObjectOrArray(input: unknown): input is {
1100
1101
  *
1101
1102
  * **When to use**
1102
1103
  *
1103
- * Use to narrow unknown input to a non-null, non-array object.
1104
+ * Use to narrow unknown input to a non-null, non-array object with a
1105
+ * `Predicate` guard.
1104
1106
  *
1105
1107
  * **Details**
1106
1108
  *
@@ -1132,7 +1134,7 @@ export declare function isObject(input: unknown): input is {
1132
1134
  * **When to use**
1133
1135
  *
1134
1136
  * Use to narrow unknown input to a readonly view of a non-null, non-array
1135
- * object.
1137
+ * object with a `Predicate` guard.
1136
1138
  *
1137
1139
  * **Details**
1138
1140
  *
@@ -1162,11 +1164,12 @@ export declare function isReadonlyObject(input: unknown): input is {
1162
1164
  *
1163
1165
  * **When to use**
1164
1166
  *
1165
- * Use when you want to accept arrays and functions as well as objects.
1167
+ * Use when you need a `Predicate` guard that accepts arrays and functions as
1168
+ * well as objects.
1166
1169
  *
1167
1170
  * **Details**
1168
1171
  *
1169
- * - Returns `true` for arrays and functions, `false` for `null`.
1172
+ * Returns `true` for arrays and functions, and `false` for `null`.
1170
1173
  *
1171
1174
  * **Example** (Object keyword)
1172
1175
  *
@@ -1188,13 +1191,13 @@ export declare function isObjectKeyword(input: unknown): input is object;
1188
1191
  *
1189
1192
  * **When to use**
1190
1193
  *
1191
- * Use when you need to guard property access on `unknown` values.
1192
- * - You want a simple structural guard for objects.
1194
+ * Use when you need a `Predicate` guard for property access on `unknown`
1195
+ * values with a simple structural object check.
1193
1196
  *
1194
1197
  * **Details**
1195
1198
  *
1196
- * - Uses the `in` operator and {@link isObjectKeyword}.
1197
- * - Does not check property value types.
1199
+ * Uses the `in` operator and `isObjectKeyword`. This does not check property
1200
+ * value types.
1198
1201
  *
1199
1202
  * **Example** (Guard property)
1200
1203
  *
@@ -1220,13 +1223,13 @@ export declare const hasProperty: {
1220
1223
  *
1221
1224
  * **When to use**
1222
1225
  *
1223
- * Use when you need to guard property access on `unknown` values.
1224
- * - You want a simple structural guard for objects.
1226
+ * Use when you need a `Predicate` guard for property access on `unknown`
1227
+ * values with a simple structural object check.
1225
1228
  *
1226
1229
  * **Details**
1227
1230
  *
1228
- * - Uses the `in` operator and {@link isObjectKeyword}.
1229
- * - Does not check property value types.
1231
+ * Uses the `in` operator and `isObjectKeyword`. This does not check property
1232
+ * value types.
1230
1233
  *
1231
1234
  * **Example** (Guard property)
1232
1235
  *
@@ -1254,13 +1257,13 @@ export declare const hasProperty: {
1254
1257
  *
1255
1258
  * **When to use**
1256
1259
  *
1257
- * Use when you need to guard property access on `unknown` values.
1258
- * - You want a simple structural guard for objects.
1260
+ * Use when you need a `Predicate` guard for property access on `unknown`
1261
+ * values with a simple structural object check.
1259
1262
  *
1260
1263
  * **Details**
1261
1264
  *
1262
- * - Uses the `in` operator and {@link isObjectKeyword}.
1263
- * - Does not check property value types.
1265
+ * Uses the `in` operator and `isObjectKeyword`. This does not check property
1266
+ * value types.
1264
1267
  *
1265
1268
  * **Example** (Guard property)
1266
1269
  *
@@ -1289,12 +1292,12 @@ export declare const hasProperty: {
1289
1292
  *
1290
1293
  * **When to use**
1291
1294
  *
1292
- * Use when you model tagged unions with a `_tag` field.
1293
- * - You want a quick, structural guard for tagged values.
1295
+ * Use when you model tagged unions with a `_tag` field and want a quick
1296
+ * `Predicate` guard for tagged values.
1294
1297
  *
1295
1298
  * **Details**
1296
1299
  *
1297
- * - Uses {@link hasProperty} and strict equality on `_tag`.
1300
+ * Uses `hasProperty` and strict equality on `_tag`.
1298
1301
  *
1299
1302
  * **Example** (Guard tagged)
1300
1303
  *
@@ -1316,12 +1319,12 @@ export declare const isTagged: {
1316
1319
  *
1317
1320
  * **When to use**
1318
1321
  *
1319
- * Use when you model tagged unions with a `_tag` field.
1320
- * - You want a quick, structural guard for tagged values.
1322
+ * Use when you model tagged unions with a `_tag` field and want a quick
1323
+ * `Predicate` guard for tagged values.
1321
1324
  *
1322
1325
  * **Details**
1323
1326
  *
1324
- * - Uses {@link hasProperty} and strict equality on `_tag`.
1327
+ * Uses `hasProperty` and strict equality on `_tag`.
1325
1328
  *
1326
1329
  * **Example** (Guard tagged)
1327
1330
  *
@@ -1345,12 +1348,12 @@ export declare const isTagged: {
1345
1348
  *
1346
1349
  * **When to use**
1347
1350
  *
1348
- * Use when you model tagged unions with a `_tag` field.
1349
- * - You want a quick, structural guard for tagged values.
1351
+ * Use when you model tagged unions with a `_tag` field and want a quick
1352
+ * `Predicate` guard for tagged values.
1350
1353
  *
1351
1354
  * **Details**
1352
1355
  *
1353
- * - Uses {@link hasProperty} and strict equality on `_tag`.
1356
+ * Uses `hasProperty` and strict equality on `_tag`.
1354
1357
  *
1355
1358
  * **Example** (Guard tagged)
1356
1359
  *
@@ -1375,11 +1378,11 @@ export declare const isTagged: {
1375
1378
  *
1376
1379
  * **When to use**
1377
1380
  *
1378
- * Use when you need to guard errors caught from unknown sources.
1381
+ * Use when you need a `Predicate` guard for errors caught from unknown sources.
1379
1382
  *
1380
1383
  * **Details**
1381
1384
  *
1382
- * - Uses `instanceof Error`.
1385
+ * Uses `instanceof Error`.
1383
1386
  *
1384
1387
  * **Example** (Guard error)
1385
1388
  *
@@ -1401,11 +1404,11 @@ export declare function isError(input: unknown): input is Error;
1401
1404
  *
1402
1405
  * **When to use**
1403
1406
  *
1404
- * Use when you need to guard binary data at runtime.
1407
+ * Use when you need a `Predicate` runtime guard for binary data.
1405
1408
  *
1406
1409
  * **Details**
1407
1410
  *
1408
- * - Uses `instanceof Uint8Array`.
1411
+ * Uses `instanceof Uint8Array`.
1409
1412
  *
1410
1413
  * **Example** (Guard Uint8Array)
1411
1414
  *
@@ -1428,11 +1431,11 @@ export declare function isUint8Array(input: unknown): input is Uint8Array;
1428
1431
  *
1429
1432
  * **When to use**
1430
1433
  *
1431
- * Use when you need to guard dates at runtime.
1434
+ * Use when you need a `Predicate` runtime guard for dates.
1432
1435
  *
1433
1436
  * **Details**
1434
1437
  *
1435
- * - Uses `instanceof Date`.
1438
+ * Uses `instanceof Date`.
1436
1439
  *
1437
1440
  * **Example** (Guard Date)
1438
1441
  *
@@ -1454,12 +1457,11 @@ export declare function isDate(input: unknown): input is Date;
1454
1457
  *
1455
1458
  * **When to use**
1456
1459
  *
1457
- * Use when you need a guard before iterating an unknown value.
1460
+ * Use when you need a `Predicate` guard before iterating an unknown value.
1458
1461
  *
1459
1462
  * **Details**
1460
1463
  *
1461
- * - Accepts strings as iterable.
1462
- * - Uses {@link hasProperty} for `Symbol.iterator`.
1464
+ * Accepts strings as iterable and uses `hasProperty` for `Symbol.iterator`.
1463
1465
  *
1464
1466
  * **Example** (Guard iterable)
1465
1467
  *
@@ -1482,11 +1484,11 @@ export declare function isIterable(input: unknown): input is Iterable<unknown>;
1482
1484
  *
1483
1485
  * **When to use**
1484
1486
  *
1485
- * Use when you need to detect promise instances across realms.
1487
+ * Use when you need a `Predicate` guard for promise instances across realms.
1486
1488
  *
1487
1489
  * **Details**
1488
1490
  *
1489
- * - Structural check for `then` and `catch` functions.
1491
+ * Performs a structural check for `then` and `catch` functions.
1490
1492
  *
1491
1493
  * **Example** (Guard promise)
1492
1494
  *
@@ -1508,11 +1510,12 @@ export declare function isPromise(input: unknown): input is Promise<unknown>;
1508
1510
  *
1509
1511
  * **When to use**
1510
1512
  *
1511
- * Use when you only need `then` to interop with promise-like values.
1513
+ * Use when you need a `Predicate` guard for promise-like values with a
1514
+ * callable `then` method.
1512
1515
  *
1513
1516
  * **Details**
1514
1517
  *
1515
- * - Structural check for a callable `then`.
1518
+ * Performs a structural check for a callable `then`.
1516
1519
  *
1517
1520
  * **Example** (Guard promise-like)
1518
1521
  *
@@ -1534,11 +1537,11 @@ export declare function isPromiseLike(input: unknown): input is PromiseLike<unkn
1534
1537
  *
1535
1538
  * **When to use**
1536
1539
  *
1537
- * Use when you need a runtime guard for regular expressions.
1540
+ * Use when you need a `Predicate` runtime guard for regular expressions.
1538
1541
  *
1539
1542
  * **Details**
1540
1543
  *
1541
- * - Uses `instanceof RegExp`.
1544
+ * Uses `instanceof RegExp`.
1542
1545
  *
1543
1546
  * **Example** (Guard RegExp)
1544
1547
  *
@@ -1560,13 +1563,13 @@ export declare function isRegExp(input: unknown): input is RegExp;
1560
1563
  *
1561
1564
  * **When to use**
1562
1565
  *
1563
- * Use when you want to chain two refinements for progressive narrowing.
1564
- * - You want a predicate that applies two checks in sequence.
1566
+ * Use when you want to compose two `Predicate` checks in sequence, especially
1567
+ * when chaining refinements for progressive narrowing.
1565
1568
  *
1566
1569
  * **Details**
1567
1570
  *
1568
- * - For refinements, the output type is narrowed by both.
1569
- * - Short-circuits on the first `false`.
1571
+ * For refinements, the output type is narrowed by both checks. Evaluation
1572
+ * short-circuits on the first `false`.
1570
1573
  *
1571
1574
  * **Example** (Compose refinements)
1572
1575
  *
@@ -1592,13 +1595,13 @@ export declare const compose: {
1592
1595
  *
1593
1596
  * **When to use**
1594
1597
  *
1595
- * Use when you want to chain two refinements for progressive narrowing.
1596
- * - You want a predicate that applies two checks in sequence.
1598
+ * Use when you want to compose two `Predicate` checks in sequence, especially
1599
+ * when chaining refinements for progressive narrowing.
1597
1600
  *
1598
1601
  * **Details**
1599
1602
  *
1600
- * - For refinements, the output type is narrowed by both.
1601
- * - Short-circuits on the first `false`.
1603
+ * For refinements, the output type is narrowed by both checks. Evaluation
1604
+ * short-circuits on the first `false`.
1602
1605
  *
1603
1606
  * **Example** (Compose refinements)
1604
1607
  *
@@ -1624,13 +1627,13 @@ export declare const compose: {
1624
1627
  *
1625
1628
  * **When to use**
1626
1629
  *
1627
- * Use when you want to chain two refinements for progressive narrowing.
1628
- * - You want a predicate that applies two checks in sequence.
1630
+ * Use when you want to compose two `Predicate` checks in sequence, especially
1631
+ * when chaining refinements for progressive narrowing.
1629
1632
  *
1630
1633
  * **Details**
1631
1634
  *
1632
- * - For refinements, the output type is narrowed by both.
1633
- * - Short-circuits on the first `false`.
1635
+ * For refinements, the output type is narrowed by both checks. Evaluation
1636
+ * short-circuits on the first `false`.
1634
1637
  *
1635
1638
  * **Example** (Compose refinements)
1636
1639
  *
@@ -1656,13 +1659,13 @@ export declare const compose: {
1656
1659
  *
1657
1660
  * **When to use**
1658
1661
  *
1659
- * Use when you want to chain two refinements for progressive narrowing.
1660
- * - You want a predicate that applies two checks in sequence.
1662
+ * Use when you want to compose two `Predicate` checks in sequence, especially
1663
+ * when chaining refinements for progressive narrowing.
1661
1664
  *
1662
1665
  * **Details**
1663
1666
  *
1664
- * - For refinements, the output type is narrowed by both.
1665
- * - Short-circuits on the first `false`.
1667
+ * For refinements, the output type is narrowed by both checks. Evaluation
1668
+ * short-circuits on the first `false`.
1666
1669
  *
1667
1670
  * **Example** (Compose refinements)
1668
1671
  *
@@ -1688,13 +1691,13 @@ export declare const compose: {
1688
1691
  *
1689
1692
  * **When to use**
1690
1693
  *
1691
- * Use when you want to chain two refinements for progressive narrowing.
1692
- * - You want a predicate that applies two checks in sequence.
1694
+ * Use when you want to compose two `Predicate` checks in sequence, especially
1695
+ * when chaining refinements for progressive narrowing.
1693
1696
  *
1694
1697
  * **Details**
1695
1698
  *
1696
- * - For refinements, the output type is narrowed by both.
1697
- * - Short-circuits on the first `false`.
1699
+ * For refinements, the output type is narrowed by both checks. Evaluation
1700
+ * short-circuits on the first `false`.
1698
1701
  *
1699
1702
  * **Example** (Compose refinements)
1700
1703
  *
@@ -1721,13 +1724,13 @@ export declare const compose: {
1721
1724
  *
1722
1725
  * **When to use**
1723
1726
  *
1724
- * Use when you want to validate tuple positions independently.
1725
- * - You want to lift element predicates into a tuple predicate.
1727
+ * Use when you want to validate tuple positions independently by lifting
1728
+ * element predicates into a tuple predicate.
1726
1729
  *
1727
1730
  * **Details**
1728
1731
  *
1729
- * - Returns a refinement if any element predicate is a refinement.
1730
- * - Stops at the first failing element.
1732
+ * Returns a refinement if any element predicate is a refinement. Evaluation
1733
+ * stops at the first failing element.
1731
1734
  *
1732
1735
  * **Example** (Tuple predicate)
1733
1736
  *
@@ -1756,13 +1759,13 @@ export declare function Tuple<const T extends ReadonlyArray<Predicate.Any>>(elem
1756
1759
  *
1757
1760
  * **When to use**
1758
1761
  *
1759
- * Use when you want to validate a record shape at runtime.
1760
- * - You want to lift property predicates into an object predicate.
1762
+ * Use when you want to validate a record shape at runtime by lifting property
1763
+ * predicates into an object predicate.
1761
1764
  *
1762
1765
  * **Details**
1763
1766
  *
1764
- * - Returns a refinement if any field predicate is a refinement.
1765
- * - Checks only the specified keys; extra keys are ignored.
1767
+ * Returns a refinement if any field predicate is a refinement. Only the
1768
+ * specified keys are checked, and extra keys are ignored.
1766
1769
  *
1767
1770
  * **Example** (Struct predicate)
1768
1771
  *
@@ -1798,7 +1801,7 @@ export declare function Struct<R extends Record<string, Predicate.Any>>(fields:
1798
1801
  *
1799
1802
  * **Details**
1800
1803
  *
1801
- * - Returns a new predicate that flips the boolean result.
1804
+ * Returns a new predicate that flips the boolean result.
1802
1805
  *
1803
1806
  * **Example** (Negate)
1804
1807
  *
@@ -1822,13 +1825,13 @@ export declare function not<A>(self: Predicate<A>): Predicate<A>;
1822
1825
  *
1823
1826
  * **When to use**
1824
1827
  *
1825
- * Use when you want to accept values that satisfy at least one condition.
1826
- * - You want to combine refinements with union narrowing.
1828
+ * Use when you want to combine `Predicate`s with OR, accepting values that
1829
+ * satisfy at least one condition, including refinements that narrow to a union.
1827
1830
  *
1828
1831
  * **Details**
1829
1832
  *
1830
- * - Short-circuits on the first `true`.
1831
- * - For refinements, the output type is a union.
1833
+ * Evaluation short-circuits on the first `true`. For refinements, the output
1834
+ * type is a union.
1832
1835
  *
1833
1836
  * **Example** (Either condition)
1834
1837
  *
@@ -1851,13 +1854,13 @@ export declare const or: {
1851
1854
  *
1852
1855
  * **When to use**
1853
1856
  *
1854
- * Use when you want to accept values that satisfy at least one condition.
1855
- * - You want to combine refinements with union narrowing.
1857
+ * Use when you want to combine `Predicate`s with OR, accepting values that
1858
+ * satisfy at least one condition, including refinements that narrow to a union.
1856
1859
  *
1857
1860
  * **Details**
1858
1861
  *
1859
- * - Short-circuits on the first `true`.
1860
- * - For refinements, the output type is a union.
1862
+ * Evaluation short-circuits on the first `true`. For refinements, the output
1863
+ * type is a union.
1861
1864
  *
1862
1865
  * **Example** (Either condition)
1863
1866
  *
@@ -1880,13 +1883,13 @@ export declare const or: {
1880
1883
  *
1881
1884
  * **When to use**
1882
1885
  *
1883
- * Use when you want to accept values that satisfy at least one condition.
1884
- * - You want to combine refinements with union narrowing.
1886
+ * Use when you want to combine `Predicate`s with OR, accepting values that
1887
+ * satisfy at least one condition, including refinements that narrow to a union.
1885
1888
  *
1886
1889
  * **Details**
1887
1890
  *
1888
- * - Short-circuits on the first `true`.
1889
- * - For refinements, the output type is a union.
1891
+ * Evaluation short-circuits on the first `true`. For refinements, the output
1892
+ * type is a union.
1890
1893
  *
1891
1894
  * **Example** (Either condition)
1892
1895
  *
@@ -1909,13 +1912,13 @@ export declare const or: {
1909
1912
  *
1910
1913
  * **When to use**
1911
1914
  *
1912
- * Use when you want to accept values that satisfy at least one condition.
1913
- * - You want to combine refinements with union narrowing.
1915
+ * Use when you want to combine `Predicate`s with OR, accepting values that
1916
+ * satisfy at least one condition, including refinements that narrow to a union.
1914
1917
  *
1915
1918
  * **Details**
1916
1919
  *
1917
- * - Short-circuits on the first `true`.
1918
- * - For refinements, the output type is a union.
1920
+ * Evaluation short-circuits on the first `true`. For refinements, the output
1921
+ * type is a union.
1919
1922
  *
1920
1923
  * **Example** (Either condition)
1921
1924
  *
@@ -1938,13 +1941,13 @@ export declare const or: {
1938
1941
  *
1939
1942
  * **When to use**
1940
1943
  *
1941
- * Use when you want to accept values that satisfy at least one condition.
1942
- * - You want to combine refinements with union narrowing.
1944
+ * Use when you want to combine `Predicate`s with OR, accepting values that
1945
+ * satisfy at least one condition, including refinements that narrow to a union.
1943
1946
  *
1944
1947
  * **Details**
1945
1948
  *
1946
- * - Short-circuits on the first `true`.
1947
- * - For refinements, the output type is a union.
1949
+ * Evaluation short-circuits on the first `true`. For refinements, the output
1950
+ * type is a union.
1948
1951
  *
1949
1952
  * **Example** (Either condition)
1950
1953
  *
@@ -1968,13 +1971,14 @@ export declare const or: {
1968
1971
  *
1969
1972
  * **When to use**
1970
1973
  *
1971
- * Use when you want to accept values that satisfy multiple conditions.
1972
- * - You want to combine refinements with intersection narrowing.
1974
+ * Use when you want to combine `Predicate`s with AND, accepting values that
1975
+ * satisfy multiple conditions, including refinements that narrow to an
1976
+ * intersection.
1973
1977
  *
1974
1978
  * **Details**
1975
1979
  *
1976
- * - Short-circuits on the first `false`.
1977
- * - For refinements, the output type is an intersection.
1980
+ * Evaluation short-circuits on the first `false`. For refinements, the output
1981
+ * type is an intersection.
1978
1982
  *
1979
1983
  * **Example** (Both conditions)
1980
1984
  *
@@ -2005,13 +2009,14 @@ export declare const and: {
2005
2009
  *
2006
2010
  * **When to use**
2007
2011
  *
2008
- * Use when you want to accept values that satisfy multiple conditions.
2009
- * - You want to combine refinements with intersection narrowing.
2012
+ * Use when you want to combine `Predicate`s with AND, accepting values that
2013
+ * satisfy multiple conditions, including refinements that narrow to an
2014
+ * intersection.
2010
2015
  *
2011
2016
  * **Details**
2012
2017
  *
2013
- * - Short-circuits on the first `false`.
2014
- * - For refinements, the output type is an intersection.
2018
+ * Evaluation short-circuits on the first `false`. For refinements, the output
2019
+ * type is an intersection.
2015
2020
  *
2016
2021
  * **Example** (Both conditions)
2017
2022
  *
@@ -2042,13 +2047,14 @@ export declare const and: {
2042
2047
  *
2043
2048
  * **When to use**
2044
2049
  *
2045
- * Use when you want to accept values that satisfy multiple conditions.
2046
- * - You want to combine refinements with intersection narrowing.
2050
+ * Use when you want to combine `Predicate`s with AND, accepting values that
2051
+ * satisfy multiple conditions, including refinements that narrow to an
2052
+ * intersection.
2047
2053
  *
2048
2054
  * **Details**
2049
2055
  *
2050
- * - Short-circuits on the first `false`.
2051
- * - For refinements, the output type is an intersection.
2056
+ * Evaluation short-circuits on the first `false`. For refinements, the output
2057
+ * type is an intersection.
2052
2058
  *
2053
2059
  * **Example** (Both conditions)
2054
2060
  *
@@ -2079,13 +2085,14 @@ export declare const and: {
2079
2085
  *
2080
2086
  * **When to use**
2081
2087
  *
2082
- * Use when you want to accept values that satisfy multiple conditions.
2083
- * - You want to combine refinements with intersection narrowing.
2088
+ * Use when you want to combine `Predicate`s with AND, accepting values that
2089
+ * satisfy multiple conditions, including refinements that narrow to an
2090
+ * intersection.
2084
2091
  *
2085
2092
  * **Details**
2086
2093
  *
2087
- * - Short-circuits on the first `false`.
2088
- * - For refinements, the output type is an intersection.
2094
+ * Evaluation short-circuits on the first `false`. For refinements, the output
2095
+ * type is an intersection.
2089
2096
  *
2090
2097
  * **Example** (Both conditions)
2091
2098
  *
@@ -2116,13 +2123,14 @@ export declare const and: {
2116
2123
  *
2117
2124
  * **When to use**
2118
2125
  *
2119
- * Use when you want to accept values that satisfy multiple conditions.
2120
- * - You want to combine refinements with intersection narrowing.
2126
+ * Use when you want to combine `Predicate`s with AND, accepting values that
2127
+ * satisfy multiple conditions, including refinements that narrow to an
2128
+ * intersection.
2121
2129
  *
2122
2130
  * **Details**
2123
2131
  *
2124
- * - Short-circuits on the first `false`.
2125
- * - For refinements, the output type is an intersection.
2132
+ * Evaluation short-circuits on the first `false`. For refinements, the output
2133
+ * type is an intersection.
2126
2134
  *
2127
2135
  * **Example** (Both conditions)
2128
2136
  *
@@ -2154,11 +2162,11 @@ export declare const and: {
2154
2162
  *
2155
2163
  * **When to use**
2156
2164
  *
2157
- * Use when you want an exclusive-or between two conditions.
2165
+ * Use when you want to combine two `Predicate`s with exclusive-or semantics.
2158
2166
  *
2159
2167
  * **Details**
2160
2168
  *
2161
- * - Returns `true` when results differ.
2169
+ * Returns `true` when results differ.
2162
2170
  *
2163
2171
  * **Example** (Exclusive or)
2164
2172
  *
@@ -2183,11 +2191,11 @@ export declare const xor: {
2183
2191
  *
2184
2192
  * **When to use**
2185
2193
  *
2186
- * Use when you want an exclusive-or between two conditions.
2194
+ * Use when you want to combine two `Predicate`s with exclusive-or semantics.
2187
2195
  *
2188
2196
  * **Details**
2189
2197
  *
2190
- * - Returns `true` when results differ.
2198
+ * Returns `true` when results differ.
2191
2199
  *
2192
2200
  * **Example** (Exclusive or)
2193
2201
  *
@@ -2212,11 +2220,11 @@ export declare const xor: {
2212
2220
  *
2213
2221
  * **When to use**
2214
2222
  *
2215
- * Use when you want an exclusive-or between two conditions.
2223
+ * Use when you want to combine two `Predicate`s with exclusive-or semantics.
2216
2224
  *
2217
2225
  * **Details**
2218
2226
  *
2219
- * - Returns `true` when results differ.
2227
+ * Returns `true` when results differ.
2220
2228
  *
2221
2229
  * **Example** (Exclusive or)
2222
2230
  *
@@ -2242,11 +2250,11 @@ export declare const xor: {
2242
2250
  *
2243
2251
  * **When to use**
2244
2252
  *
2245
- * Use when you want to check equivalence of two predicates.
2253
+ * Use when you want to check equivalence of two `Predicate`s.
2246
2254
  *
2247
2255
  * **Details**
2248
2256
  *
2249
- * - Returns `true` when both results are equal.
2257
+ * Returns `true` when both results are equal.
2250
2258
  *
2251
2259
  * **Example** (Equivalence)
2252
2260
  *
@@ -2269,11 +2277,11 @@ export declare const eqv: {
2269
2277
  *
2270
2278
  * **When to use**
2271
2279
  *
2272
- * Use when you want to check equivalence of two predicates.
2280
+ * Use when you want to check equivalence of two `Predicate`s.
2273
2281
  *
2274
2282
  * **Details**
2275
2283
  *
2276
- * - Returns `true` when both results are equal.
2284
+ * Returns `true` when both results are equal.
2277
2285
  *
2278
2286
  * **Example** (Equivalence)
2279
2287
  *
@@ -2296,11 +2304,11 @@ export declare const eqv: {
2296
2304
  *
2297
2305
  * **When to use**
2298
2306
  *
2299
- * Use when you want to check equivalence of two predicates.
2307
+ * Use when you want to check equivalence of two `Predicate`s.
2300
2308
  *
2301
2309
  * **Details**
2302
2310
  *
2303
- * - Returns `true` when both results are equal.
2311
+ * Returns `true` when both results are equal.
2304
2312
  *
2305
2313
  * **Example** (Equivalence)
2306
2314
  *
@@ -2324,12 +2332,13 @@ export declare const eqv: {
2324
2332
  *
2325
2333
  * **When to use**
2326
2334
  *
2327
- * Use when you want a rule that only applies when a precondition holds.
2328
- * - You model constraints like "if A then B".
2335
+ * Use when you need to encode logical implication between `Predicate` rules,
2336
+ * where one rule only applies when a precondition holds.
2329
2337
  *
2330
2338
  * **Details**
2331
2339
  *
2332
- * - Returns `true` when the antecedent is `false`.
2340
+ * Models constraints like "if A then B" and returns `true` when the antecedent
2341
+ * is `false`.
2333
2342
  *
2334
2343
  * **Example** (Implication)
2335
2344
  *
@@ -2354,12 +2363,13 @@ export declare const implies: {
2354
2363
  *
2355
2364
  * **When to use**
2356
2365
  *
2357
- * Use when you want a rule that only applies when a precondition holds.
2358
- * - You model constraints like "if A then B".
2366
+ * Use when you need to encode logical implication between `Predicate` rules,
2367
+ * where one rule only applies when a precondition holds.
2359
2368
  *
2360
2369
  * **Details**
2361
2370
  *
2362
- * - Returns `true` when the antecedent is `false`.
2371
+ * Models constraints like "if A then B" and returns `true` when the antecedent
2372
+ * is `false`.
2363
2373
  *
2364
2374
  * **Example** (Implication)
2365
2375
  *
@@ -2384,12 +2394,13 @@ export declare const implies: {
2384
2394
  *
2385
2395
  * **When to use**
2386
2396
  *
2387
- * Use when you want a rule that only applies when a precondition holds.
2388
- * - You model constraints like "if A then B".
2397
+ * Use when you need to encode logical implication between `Predicate` rules,
2398
+ * where one rule only applies when a precondition holds.
2389
2399
  *
2390
2400
  * **Details**
2391
2401
  *
2392
- * - Returns `true` when the antecedent is `false`.
2402
+ * Models constraints like "if A then B" and returns `true` when the antecedent
2403
+ * is `false`.
2393
2404
  *
2394
2405
  * **Example** (Implication)
2395
2406
  *
@@ -2415,11 +2426,11 @@ export declare const implies: {
2415
2426
  *
2416
2427
  * **When to use**
2417
2428
  *
2418
- * Use when you want the logical NOR of two conditions.
2429
+ * Use when you want to combine two `Predicate`s with logical NOR semantics.
2419
2430
  *
2420
2431
  * **Details**
2421
2432
  *
2422
- * - Returns the negation of {@link or}.
2433
+ * Returns the negation of `or`.
2423
2434
  *
2424
2435
  * **Example** (NOR)
2425
2436
  *
@@ -2442,11 +2453,11 @@ export declare const nor: {
2442
2453
  *
2443
2454
  * **When to use**
2444
2455
  *
2445
- * Use when you want the logical NOR of two conditions.
2456
+ * Use when you want to combine two `Predicate`s with logical NOR semantics.
2446
2457
  *
2447
2458
  * **Details**
2448
2459
  *
2449
- * - Returns the negation of {@link or}.
2460
+ * Returns the negation of `or`.
2450
2461
  *
2451
2462
  * **Example** (NOR)
2452
2463
  *
@@ -2469,11 +2480,11 @@ export declare const nor: {
2469
2480
  *
2470
2481
  * **When to use**
2471
2482
  *
2472
- * Use when you want the logical NOR of two conditions.
2483
+ * Use when you want to combine two `Predicate`s with logical NOR semantics.
2473
2484
  *
2474
2485
  * **Details**
2475
2486
  *
2476
- * - Returns the negation of {@link or}.
2487
+ * Returns the negation of `or`.
2477
2488
  *
2478
2489
  * **Example** (NOR)
2479
2490
  *
@@ -2497,11 +2508,11 @@ export declare const nor: {
2497
2508
  *
2498
2509
  * **When to use**
2499
2510
  *
2500
- * Use when you want the logical NAND of two conditions.
2511
+ * Use when you want to combine two `Predicate`s with logical NAND semantics.
2501
2512
  *
2502
2513
  * **Details**
2503
2514
  *
2504
- * - Returns the negation of {@link and}.
2515
+ * Returns the negation of `and`.
2505
2516
  *
2506
2517
  * **Example** (NAND)
2507
2518
  *
@@ -2524,11 +2535,11 @@ export declare const nand: {
2524
2535
  *
2525
2536
  * **When to use**
2526
2537
  *
2527
- * Use when you want the logical NAND of two conditions.
2538
+ * Use when you want to combine two `Predicate`s with logical NAND semantics.
2528
2539
  *
2529
2540
  * **Details**
2530
2541
  *
2531
- * - Returns the negation of {@link and}.
2542
+ * Returns the negation of `and`.
2532
2543
  *
2533
2544
  * **Example** (NAND)
2534
2545
  *
@@ -2551,11 +2562,11 @@ export declare const nand: {
2551
2562
  *
2552
2563
  * **When to use**
2553
2564
  *
2554
- * Use when you want the logical NAND of two conditions.
2565
+ * Use when you want to combine two `Predicate`s with logical NAND semantics.
2555
2566
  *
2556
2567
  * **Details**
2557
2568
  *
2558
- * - Returns the negation of {@link and}.
2569
+ * Returns the negation of `and`.
2559
2570
  *
2560
2571
  * **Example** (NAND)
2561
2572
  *
@@ -2583,8 +2594,8 @@ export declare const nand: {
2583
2594
  *
2584
2595
  * **Details**
2585
2596
  *
2586
- * - Short-circuits on the first `false`.
2587
- * - Iterates the collection each time the predicate is called.
2597
+ * Evaluation short-circuits on the first `false`. The collection is iterated
2598
+ * each time the predicate is called.
2588
2599
  *
2589
2600
  * **Example** (All checks)
2590
2601
  *
@@ -2611,8 +2622,8 @@ export declare function every<A>(collection: Iterable<Predicate<A>>): Predicate<
2611
2622
  *
2612
2623
  * **Details**
2613
2624
  *
2614
- * - Short-circuits on the first `true`.
2615
- * - Iterates the collection each time the predicate is called.
2625
+ * Evaluation short-circuits on the first `true`. The collection is iterated
2626
+ * each time the predicate is called.
2616
2627
  *
2617
2628
  * **Example** (Any check)
2618
2629
  *