effect 4.0.0-beta.70 → 4.0.0-beta.72

package/src/Channel.ts

@@ -1,60 +1,72 @@
 /**
- * The `Channel` module provides a powerful abstraction for bi-directional communication
- * and streaming operations. A `Channel` is a nexus of I/O operations that supports both
- * reading and writing, forming the foundation for Effect's Stream and Sink abstractions.
- *
- * ## What is a Channel?
- *
- * A `Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>` represents:
- * - **OutElem**: The type of elements the channel outputs
- * - **OutErr**: The type of errors the channel can produce
- * - **OutDone**: The type of the final value when the channel completes
- * - **InElem**: The type of elements the channel reads
- * - **InErr**: The type of errors the channel can receive
- * - **InDone**: The type of the final value from upstream
- * - **Env**: The environment/context required by the channel
- *
- * ## Key Features
- *
- * - **Bi-directional**: Channels can both read and write
- * - **Composable**: Channels can be piped, sequenced, and concatenated
- * - **Resource-safe**: Automatic cleanup and resource management
- * - **Error-handling**: Built-in error propagation and handling
- * - **Concurrent**: Support for concurrent operations
- *
- * ## Composition Patterns
- *
- * 1. **Piping**: Connect channels where output of one becomes input of another
- * 2. **Sequencing**: Use the result of one channel to create another
- * 3. **Concatenating**: Combine multiple channels into a single channel
- *
- * **Example** (Creating a simple channel)
+ * The `Channel` module provides the low-level stream processing primitive used
+ * to build Effect streams, sinks, and stream operators.
+ *
+ * A `Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>` describes a
+ * scoped process that can read elements from an upstream input, emit elements
+ * downstream, fail with a typed error, or complete with a typed done value.
+ * Most application code works with higher-level stream APIs; channels are for
+ * implementing reusable streaming primitives, adapting pull-based sources, and
+ * controlling how input, output, errors, final values, and resources compose.
+ *
+ * **Mental model**
+ *
+ * - `OutElem`, `OutErr`, and `OutDone` describe the values, failures, and final
+ *   value produced by the channel.
+ * - `InElem`, `InErr`, and `InDone` describe the upstream protocol consumed by
+ *   the channel when it is piped after another channel.
+ * - `Env` is the Effect environment required while the channel is interpreted.
+ * - Constructors such as {@link fromArray}, {@link fromIterable},
+ *   {@link fromEffect}, {@link succeed}, and {@link fail} create sources.
+ * - Combinators such as {@link map}, {@link mapEffect}, {@link flatMap}, and
+ *   {@link pipeTo} transform, sequence, and connect channels.
+ * - Execution functions such as {@link runCollect} and {@link runDrain}
+ *   interpret channels that no longer require upstream input.
+ *
+ * **Common tasks**
+ *
+ * - Build finite sources from values, arrays, iterables, queues, pub/sub
+ *   subscriptions, effects, or pulls.
+ * - Transform output elements with pure or effectful functions.
+ * - Connect channels with {@link pipeTo} when one channel's output protocol
+ *   should become another channel's input protocol.
+ * - Sequence dependent channels with {@link flatMap}, or concatenate channels
+ *   with {@link concat}.
+ * - Manage channel-scoped resources with {@link acquireRelease} and
+ *   {@link ensuring}.
+ * - Bridge to lower-level pull loops with {@link toPull} and {@link fromPull}.
+ *
+ * **Example** (Collecting transformed output)
  *
  * ```ts
- * import { Channel } from "effect"
- *
- * // Simple channel that outputs numbers
- * const numberChannel = Channel.succeed(42)
+ * import { Channel, Effect } from "effect"
  *
- * // Transform channel that doubles values
- * const doubleChannel = Channel.map(numberChannel, (n) => n * 2)
+ * const program = Channel.fromArray([1, 2, 3]).pipe(
+ *   Channel.map((n) => n * 2),
+ *   Channel.runCollect
+ * )
  *
- * // Running the channel would output: 84
+ * Effect.runPromise(program).then(console.log)
  * ```
  *
- * **Example** (Transforming array-backed channels)
+ * **Gotchas**
  *
- * ```ts
- * import { Channel } from "effect"
- *
- * // Channel from an array of values
- * const arrayChannel = Channel.fromArray([1, 2, 3, 4, 5])
+ * - A channel's done value is distinct from its emitted elements; use
+ *   done-focused APIs when the final value matters.
+ * - `pipeTo` connects the output side of the left channel to the input side of
+ *   the right channel, so type errors usually mean those protocols do not line
+ *   up.
+ * - Resource finalizers run when the channel scope closes, not when a channel
+ *   value is merely constructed.
+ * - Prefer stream and sink APIs unless you are implementing lower-level
+ *   streaming behavior.
  *
- * // Transform the channel by mapping over values
- * const transformedChannel = Channel.map(arrayChannel, (n) => n * 2)
+ * **See also**
  *
- * // This channel will output: 2, 4, 6, 8, 10
- * ```
+ * - {@link Channel} for the type parameters and variance of channel values.
+ * - {@link pipeTo} for wiring one channel into another.
+ * - {@link runCollect}, {@link runDrain}, and {@link runDone} for common
+ *   execution modes.
  *
  * @since 2.0.0
  */
@@ -97,7 +109,7 @@ import type * as Unify from "./Unify.ts"
 /**
  * String literal type used as the unique brand for `Channel` values.
  *
- * @category Type Identifiers
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~effect/Channel"
@@ -106,13 +118,13 @@ export type TypeId = "~effect/Channel"
  * Runtime identifier stored on `Channel` values and used by `isChannel` to
  * recognize them.
  *
- * @category Type Identifiers
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~effect/Channel"
 
 /**
- * Tests if a value is a `Channel`.
+ * Checks whether a value is a `Channel`.
  *
  * **Example** (Checking for channels)
  *
@@ -424,6 +436,13 @@ export const fromPull = <OutElem, OutErr, OutDone, EX, EnvX, Env>(
  * pulls, but also provides a forked scope that closes when the resulting
  * Channel completes.
  *
+ * **When to use**
+ *
+ * Use when building channels that require scoped resource lifecycle management,
+ * providing both the channel scope and a forked scope that automatically closes
+ * when the channel completes.
+ *
+ * @see {@link fromTransform} for a simpler transformation without a forked scope
  * @category constructors
  * @since 4.0.0
  */
@@ -953,7 +972,7 @@ export const endSync = <A>(evaluate: LazyArg<A>): Channel<never, never, A> =>
 export const sync = <A>(evaluate: LazyArg<A>): Channel<A> => fromEffect(Effect.sync(evaluate))
 
 /**
- * Represents an Channel that emits no elements
+ * Represents a `Channel` that emits no elements.
  *
  * **Example** (Using empty channels)
  *
@@ -978,7 +997,7 @@ export const sync = <A>(evaluate: LazyArg<A>): Channel<A> => fromEffect(Effect.s
 export const empty: Channel<never> = fromPull(Effect.succeed(Cause.done()))
 
 /**
- * Represents an Channel that never completes
+ * Represents a `Channel` that never completes.
  *
  * **Example** (Using non-terminating channels)
  *
@@ -1153,7 +1172,7 @@ export const failCauseSync = <E>(
 export const die = (defect: unknown): Channel<never, never, never> => failCause(Cause.die(defect))
 
 /**
- * Use an effect to write a single value to the channel.
+ * Uses an effect to write a single value to the channel.
  *
  * **Example** (Creating channels from effects)
  *
@@ -1220,7 +1239,7 @@ export const fromEffectDone = <A, E, R>(
   fromPull(Effect.succeed(Effect.flatMap(effect, Cause.done)))
 
 /**
- * Use an effect and discard its result.
+ * Uses an effect and discards its result.
  *
  * @category constructors
  * @since 4.0.0
@@ -1247,7 +1266,7 @@ export const fromEffectTake = <A, E, Done, E2, R>(
   fromPull(Effect.succeed(Effect.flatMap(effect, Take.toPull)))
 
 /**
- * Create a channel from a queue
+ * Creates a channel from a queue.
  *
  * **Example** (Creating channels from queues)
  *
@@ -1290,7 +1309,7 @@ export const fromQueue = <A, E>(
 ): Channel<A, Exclude<E, Cause.Done>> => fromPull(Effect.succeed(Queue.take(queue)))
 
 /**
- * Create a channel from a queue that emits arrays of elements
+ * Creates a channel from a queue that emits arrays of elements.
  *
  * **Example** (Creating batched channels from queues)
  *
@@ -1347,7 +1366,7 @@ export const identity = <Elem, Err, Done>(): Channel<Elem, Err, Done, Elem, Err,
   fromTransform((upstream, _scope) => Effect.succeed(upstream))
 
 /**
- * Create a channel from a PubSub subscription
+ * Creates a channel from a PubSub subscription.
  *
  * **Example** (Creating channels from subscriptions)
  *
@@ -1395,7 +1414,7 @@ export const fromSubscription = <A>(
 ): Channel<A> => fromPull(Effect.succeed(Effect.onInterrupt(PubSub.take(subscription), () => Cause.done())))
 
 /**
- * Create a channel from a PubSub subscription that outputs arrays of values.
+ * Creates a channel from a PubSub subscription that outputs arrays of values.
  *
  * **Details**
  *
@@ -1502,7 +1521,7 @@ export const fromSubscriptionArray = <A>(
   fromPull(Effect.succeed(Effect.onInterrupt(PubSub.takeAll(subscription), () => Cause.done())))
 
 /**
- * Create a channel from a PubSub that outputs individual values.
+ * Creates a channel from a PubSub that outputs individual values.
  *
  * **Details**
  *
@@ -1599,7 +1618,7 @@ export const fromPubSub = <A>(
 ): Channel<A> => unwrap(Effect.map(PubSub.subscribe(pubsub), fromSubscription))
 
 /**
- * Create a channel from a PubSub that outputs arrays of values.
+ * Creates a channel from a PubSub that outputs arrays of values.
  *
  * **Details**
  *
@@ -3133,22 +3152,36 @@ export const concat: {
 > => concatWith(self, (_) => that))
 
 /**
- * Combines the elements from this channel and the specified channel by
- * repeatedly applying the function `f` to extract an element using both sides
- * and conceptually "offer" it to the destination channel. `f` can maintain
- * some internal state to control the combining process, with the initial
- * state being specified by `s`.
+ * Combines two channels with a stateful pull function.
+ *
+ * **When to use**
+ *
+ * Use to coordinate pulling from two channels when each output element depends
+ * on both sides and local state.
+ *
+ * **Details**
+ *
+ * The combining function receives the current state and pull functions for the
+ * left and right channels. It returns the next output element together with the
+ * next state.
  *
  * @category sequencing
  * @since 4.0.0
  */
 export const combine: {
   /**
-   * Combines the elements from this channel and the specified channel by
-   * repeatedly applying the function `f` to extract an element using both sides
-   * and conceptually "offer" it to the destination channel. `f` can maintain
-   * some internal state to control the combining process, with the initial
-   * state being specified by `s`.
+   * Combines two channels with a stateful pull function.
+   *
+   * **When to use**
+   *
+   * Use to coordinate pulling from two channels when each output element depends
+   * on both sides and local state.
+   *
+   * **Details**
+   *
+   * The combining function receives the current state and pull functions for the
+   * left and right channels. It returns the next output element together with the
+   * next state.
    *
    * @category sequencing
    * @since 4.0.0
@@ -3171,11 +3204,18 @@ export const combine: {
     Env | Env2 | R
   >
   /**
-   * Combines the elements from this channel and the specified channel by
-   * repeatedly applying the function `f` to extract an element using both sides
-   * and conceptually "offer" it to the destination channel. `f` can maintain
-   * some internal state to control the combining process, with the initial
-   * state being specified by `s`.
+   * Combines two channels with a stateful pull function.
+   *
+   * **When to use**
+   *
+   * Use to coordinate pulling from two channels when each output element depends
+   * on both sides and local state.
+   *
+   * **Details**
+   *
+   * The combining function receives the current state and pull functions for the
+   * left and right channels. It returns the next output element together with the
+   * next state.
    *
    * @category sequencing
    * @since 4.0.0
@@ -3402,7 +3442,7 @@ export const orElseIfEmpty: {
   ))
 
 /**
- * Flatten a channel of channels.
+ * Flattens a channel of channels.
  *
  * **Example** (Flattening nested channels)
  *
@@ -3920,12 +3960,21 @@ export const filter: {
 /**
  * Filters and maps output elements using a `Filter`.
  *
+ * **When to use**
+ *
+ * Use to keep only channel output elements accepted by a `Filter` and emit
+ * each filter success value.
+ *
  * **Details**
  *
  * Successful filter results are emitted as mapped values. Failed filter
  * results are discarded. The source channel's errors and done value are
  * preserved.
  *
+ * @see {@link filter} for keeping original output elements with a predicate
+ * @see {@link filterMapEffect} for using an effectful `Filter`
+ * @see {@link filterMapArray} for filtering arrays of output elements
+ *
  * @category filtering
  * @since 4.0.0
  */
@@ -3933,12 +3982,21 @@ export const filterMap: {
   /**
    * Filters and maps output elements using a `Filter`.
    *
+   * **When to use**
+   *
+   * Use to keep only channel output elements accepted by a `Filter` and emit
+   * each filter success value.
+   *
    * **Details**
    *
    * Successful filter results are emitted as mapped values. Failed filter
    * results are discarded. The source channel's errors and done value are
    * preserved.
    *
+   * @see {@link filter} for keeping original output elements with a predicate
+   * @see {@link filterMapEffect} for using an effectful `Filter`
+   * @see {@link filterMapArray} for filtering arrays of output elements
+   *
    * @category filtering
    * @since 4.0.0
    */
@@ -3948,12 +4006,21 @@ export const filterMap: {
   /**
    * Filters and maps output elements using a `Filter`.
    *
+   * **When to use**
+   *
+   * Use to keep only channel output elements accepted by a `Filter` and emit
+   * each filter success value.
+   *
    * **Details**
    *
    * Successful filter results are emitted as mapped values. Failed filter
    * results are discarded. The source channel's errors and done value are
    * preserved.
    *
+   * @see {@link filter} for keeping original output elements with a predicate
+   * @see {@link filterMapEffect} for using an effectful `Filter`
+   * @see {@link filterMapArray} for filtering arrays of output elements
+   *
    * @category filtering
    * @since 4.0.0
    */
@@ -4045,12 +4112,22 @@ export const filterEffect: {
 /**
  * Filters and maps output elements using an effectful `Filter`.
  *
+ * **When to use**
+ *
+ * Use to apply effectful logic that can discard channel output elements and
+ * emit transformed values for the elements that pass.
+ *
  * **Details**
  *
  * Successful filter results are emitted as mapped values. Failed filter
  * results are discarded. Failures from the effectful filter fail the returned
  * channel.
  *
+ * @see {@link filterMap} for using a synchronous `Filter`
+ * @see {@link filterEffect} for effectfully keeping original output elements
+ * @see {@link mapEffect} for effectfully transforming every output element
+ * @see {@link filterMapArrayEffect} for effectful filtering of array outputs
+ *
  * @category filtering
  * @since 4.0.0
  */
@@ -4058,12 +4135,22 @@ export const filterMapEffect: {
   /**
    * Filters and maps output elements using an effectful `Filter`.
    *
+   * **When to use**
+   *
+   * Use to apply effectful logic that can discard channel output elements and
+   * emit transformed values for the elements that pass.
+   *
    * **Details**
    *
    * Successful filter results are emitted as mapped values. Failed filter
    * results are discarded. Failures from the effectful filter fail the returned
    * channel.
    *
+   * @see {@link filterMap} for using a synchronous `Filter`
+   * @see {@link filterEffect} for effectfully keeping original output elements
+   * @see {@link mapEffect} for effectfully transforming every output element
+   * @see {@link filterMapArrayEffect} for effectful filtering of array outputs
+   *
    * @category filtering
    * @since 4.0.0
    */
@@ -4073,12 +4160,22 @@ export const filterMapEffect: {
   /**
    * Filters and maps output elements using an effectful `Filter`.
    *
+   * **When to use**
+   *
+   * Use to apply effectful logic that can discard channel output elements and
+   * emit transformed values for the elements that pass.
+   *
    * **Details**
    *
    * Successful filter results are emitted as mapped values. Failed filter
    * results are discarded. Failures from the effectful filter fail the returned
    * channel.
    *
+   * @see {@link filterMap} for using a synchronous `Filter`
+   * @see {@link filterEffect} for effectfully keeping original output elements
+   * @see {@link mapEffect} for effectfully transforming every output element
+   * @see {@link filterMapArrayEffect} for effectful filtering of array outputs
+   *
    * @category filtering
    * @since 4.0.0
    */
@@ -4515,7 +4612,7 @@ export const filterMapArrayEffect: {
     ))))
 
 /**
- * Statefully maps over a channel with an accumulator, where each element can produce multiple output values.
+ * Maps over a channel statefully with an accumulator, where each element can produce multiple output values.
  *
  * **Example** (Mapping with accumulated state)
  *
@@ -4554,7 +4651,7 @@ export const filterMapArrayEffect: {
  */
 export const mapAccum: {
   /**
-   * Statefully maps over a channel with an accumulator, where each element can produce multiple output values.
+   * Maps over a channel statefully with an accumulator, where each element can produce multiple output values.
    *
    * **Example** (Mapping with accumulated state)
    *
@@ -4619,7 +4716,7 @@ export const mapAccum: {
     Env | R
   >
   /**
-   * Statefully maps over a channel with an accumulator, where each element can produce multiple output values.
+   * Maps over a channel statefully with an accumulator, where each element can produce multiple output values.
    *
    * **Example** (Mapping with accumulated state)
    *
@@ -4732,7 +4829,7 @@ export const mapAccum: {
 )
 
 /**
- * Statefully transforms a channel by scanning over its output with an accumulator function.
+ * Transforms a channel statefully by scanning over its output with an accumulator function.
  * Emits the intermediate results of the scan operation.
  *
  * **Example** (Scanning channel output)
@@ -4763,7 +4860,7 @@ export const mapAccum: {
  */
 export const scan: {
   /**
-   * Statefully transforms a channel by scanning over its output with an accumulator function.
+   * Transforms a channel statefully by scanning over its output with an accumulator function.
    * Emits the intermediate results of the scan operation.
    *
    * **Example** (Scanning channel output)
@@ -4809,7 +4906,7 @@ export const scan: {
     Env
   >
   /**
-   * Statefully transforms a channel by scanning over its output with an accumulator function.
+   * Transforms a channel statefully by scanning over its output with an accumulator function.
    * Emits the intermediate results of the scan operation.
    *
    * **Example** (Scanning channel output)
@@ -4851,7 +4948,7 @@ export const scan: {
   scanEffect(self, initial, (s, a) => Effect.succeed(f(s, a))))
 
 /**
- * Statefully transforms a channel by scanning over its output with an effectful accumulator function.
+ * Transforms a channel statefully by scanning over its output with an effectful accumulator function.
  * Emits the intermediate results of the scan operation.
  *
  * **Example** (Scanning channel output with effects)
@@ -4897,7 +4994,7 @@ export const scan: {
  */
 export const scanEffect: {
   /**
-   * Statefully transforms a channel by scanning over its output with an effectful accumulator function.
+   * Transforms a channel statefully by scanning over its output with an effectful accumulator function.
    * Emits the intermediate results of the scan operation.
    *
    * **Example** (Scanning channel output with effects)
@@ -4958,7 +5055,7 @@ export const scanEffect: {
     Env | R
   >
   /**
-   * Statefully transforms a channel by scanning over its output with an effectful accumulator function.
+   * Transforms a channel statefully by scanning over its output with an effectful accumulator function.
    * Emits the intermediate results of the scan operation.
    *
    * **Example** (Scanning channel output with effects)
@@ -5340,6 +5437,21 @@ export const tapCause: {
  * Catches causes of failure that match a specific filter, allowing
  * conditional error recovery based on the type of failure.
  *
+ * **When to use**
+ *
+ * Use to recover a channel only when its full `Cause` satisfies a boolean
+ * predicate.
+ *
+ * **Details**
+ *
+ * When the predicate matches, the recovery function receives the original
+ * cause. When it does not match, the returned channel fails with the original
+ * cause.
+ *
+ * @see {@link catchCauseFilter} for selecting causes with a `Filter`
+ * @see {@link catchCause} for recovering from every cause
+ * @see {@link catchIf} for recovering from typed channel errors
+ *
  * @category error handling
  * @since 4.0.0
  */
@@ -5348,6 +5460,21 @@ export const catchCauseIf: {
    * Catches causes of failure that match a specific filter, allowing
    * conditional error recovery based on the type of failure.
    *
+   * **When to use**
+   *
+   * Use to recover a channel only when its full `Cause` satisfies a boolean
+   * predicate.
+   *
+   * **Details**
+   *
+   * When the predicate matches, the recovery function receives the original
+   * cause. When it does not match, the returned channel fails with the original
+   * cause.
+   *
+   * @see {@link catchCauseFilter} for selecting causes with a `Filter`
+   * @see {@link catchCause} for recovering from every cause
+   * @see {@link catchIf} for recovering from typed channel errors
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -5383,6 +5510,21 @@ export const catchCauseIf: {
    * Catches causes of failure that match a specific filter, allowing
    * conditional error recovery based on the type of failure.
    *
+   * **When to use**
+   *
+   * Use to recover a channel only when its full `Cause` satisfies a boolean
+   * predicate.
+   *
+   * **Details**
+   *
+   * When the predicate matches, the recovery function receives the original
+   * cause. When it does not match, the returned channel fails with the original
+   * cause.
+   *
+   * @see {@link catchCauseFilter} for selecting causes with a `Filter`
+   * @see {@link catchCause} for recovering from every cause
+   * @see {@link catchIf} for recovering from typed channel errors
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -5464,12 +5606,22 @@ export const catchCauseIf: {
 /**
  * Recovers from channel failures whose full `Cause` is selected by a `Filter`.
  *
+ * **When to use**
+ *
+ * Use when you need to recover a channel only from causes selected by a
+ * `Filter`, and the recovery needs both the selected value and the original
+ * `Cause`.
+ *
  * **Details**
  *
  * When the filter succeeds, the recovery function receives the selected value
  * and the original cause. When the filter fails, the returned channel fails
  * with the residual cause produced by the filter.
  *
+ * @see {@link catchCauseIf} for selecting causes with a predicate
+ * @see {@link catchFilter} for selecting typed errors with a `Filter`
+ * @see {@link catchCause} for recovering from every cause
+ *
  * @category error handling
  * @since 4.0.0
  */
@@ -5477,12 +5629,22 @@ export const catchCauseFilter: {
   /**
    * Recovers from channel failures whose full `Cause` is selected by a `Filter`.
    *
+   * **When to use**
+   *
+   * Use when you need to recover a channel only from causes selected by a
+   * `Filter`, and the recovery needs both the selected value and the original
+   * `Cause`.
+   *
    * **Details**
    *
    * When the filter succeeds, the recovery function receives the selected value
    * and the original cause. When the filter fails, the returned channel fails
    * with the residual cause produced by the filter.
    *
+   * @see {@link catchCauseIf} for selecting causes with a predicate
+   * @see {@link catchFilter} for selecting typed errors with a `Filter`
+   * @see {@link catchCause} for recovering from every cause
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -5522,12 +5684,22 @@ export const catchCauseFilter: {
   /**
    * Recovers from channel failures whose full `Cause` is selected by a `Filter`.
    *
+   * **When to use**
+   *
+   * Use when you need to recover a channel only from causes selected by a
+   * `Filter`, and the recovery needs both the selected value and the original
+   * `Cause`.
+   *
    * **Details**
    *
    * When the filter succeeds, the recovery function receives the selected value
    * and the original cause. When the filter fails, the returned channel fails
    * with the residual cause produced by the filter.
    *
+   * @see {@link catchCauseIf} for selecting causes with a predicate
+   * @see {@link catchFilter} for selecting typed errors with a `Filter`
+   * @see {@link catchCause} for recovering from every cause
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -5812,12 +5984,22 @@ export const tapError: {
 /**
  * Recovers from typed channel errors that match a predicate or refinement.
  *
+ * **When to use**
+ *
+ * Use to recover from typed channel errors when a predicate or refinement
+ * selects the failures that should switch to a recovery channel.
+ *
  * **Details**
  *
  * Matching errors are handled by the recovery function. Non-matching errors
  * are handled by `orElse` when provided. Without `orElse`, non-matching errors
  * are re-failed.
  *
+ * @see {@link catch_ catch} for recovering from every typed channel error
+ * @see {@link catchFilter} for selecting typed errors with a `Filter`
+ * @see {@link catchTag} for selecting tagged typed errors
+ * @see {@link catchCauseFilter} for selecting full causes with a `Filter`
+ *
  * @category error handling
  * @since 4.0.0
  */
@@ -5825,12 +6007,22 @@ export const catchIf: {
   /**
    * Recovers from typed channel errors that match a predicate or refinement.
    *
+   * **When to use**
+   *
+   * Use to recover from typed channel errors when a predicate or refinement
+   * selects the failures that should switch to a recovery channel.
+   *
    * **Details**
    *
    * Matching errors are handled by the recovery function. Non-matching errors
    * are handled by `orElse` when provided. Without `orElse`, non-matching errors
    * are re-failed.
    *
+   * @see {@link catch_ catch} for recovering from every typed channel error
+   * @see {@link catchFilter} for selecting typed errors with a `Filter`
+   * @see {@link catchTag} for selecting tagged typed errors
+   * @see {@link catchCauseFilter} for selecting full causes with a `Filter`
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -5844,8 +6036,8 @@ export const catchIf: {
     InErr1,
     InDone1,
     Env1,
-    OutElem2 = never,
-    OutErr2 = Exclude<OutErr, EB>,
+    OutElem2 = Types.unassigned,
+    OutErr2 = never,
     OutDone2 = never,
     InElem2 = unknown,
     InErr2 = unknown,
@@ -5867,8 +6059,8 @@ export const catchIf: {
     InDone,
     Env
   >(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<
-    OutElem | OutElem1 | OutElem2,
-    OutErr1 | OutErr2,
+    OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
+    OutErr1 | OutErr2 | (OutElem2 extends Types.unassigned ? Exclude<OutErr, EB> : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -5878,12 +6070,22 @@ export const catchIf: {
   /**
    * Recovers from typed channel errors that match a predicate or refinement.
    *
+   * **When to use**
+   *
+   * Use to recover from typed channel errors when a predicate or refinement
+   * selects the failures that should switch to a recovery channel.
+   *
    * **Details**
    *
    * Matching errors are handled by the recovery function. Non-matching errors
    * are handled by `orElse` when provided. Without `orElse`, non-matching errors
    * are re-failed.
    *
+   * @see {@link catch_ catch} for recovering from every typed channel error
+   * @see {@link catchFilter} for selecting typed errors with a `Filter`
+   * @see {@link catchTag} for selecting tagged typed errors
+   * @see {@link catchCauseFilter} for selecting full causes with a `Filter`
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -5896,8 +6098,8 @@ export const catchIf: {
     InErr1,
     InDone1,
     Env1,
-    OutElem2 = never,
-    OutErr2 = OutErr,
+    OutElem2 = Types.unassigned,
+    OutErr2 = never,
     OutDone2 = never,
     InElem2 = unknown,
     InErr2 = unknown,
@@ -5919,8 +6121,8 @@ export const catchIf: {
     InDone,
     Env
   >(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<
-    OutElem | OutElem1 | OutElem2,
-    OutErr1 | OutErr2,
+    OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
+    OutErr1 | OutErr2 | (OutElem2 extends Types.unassigned ? OutErr : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -5930,12 +6132,22 @@ export const catchIf: {
   /**
    * Recovers from typed channel errors that match a predicate or refinement.
    *
+   * **When to use**
+   *
+   * Use to recover from typed channel errors when a predicate or refinement
+   * selects the failures that should switch to a recovery channel.
+   *
    * **Details**
    *
    * Matching errors are handled by the recovery function. Non-matching errors
    * are handled by `orElse` when provided. Without `orElse`, non-matching errors
    * are re-failed.
    *
+   * @see {@link catch_ catch} for recovering from every typed channel error
+   * @see {@link catchFilter} for selecting typed errors with a `Filter`
+   * @see {@link catchTag} for selecting tagged typed errors
+   * @see {@link catchCauseFilter} for selecting full causes with a `Filter`
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -5955,8 +6167,8 @@ export const catchIf: {
     InErr1,
     InDone1,
     Env1,
-    OutElem2 = never,
-    OutErr2 = Exclude<OutErr, EB>,
+    OutElem2 = Types.unassigned,
+    OutErr2 = never,
     OutDone2 = never,
     InElem2 = unknown,
     InErr2 = unknown,
@@ -5972,8 +6184,8 @@ export const catchIf: {
       ) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>)
       | undefined
   ): Channel<
-    OutElem | OutElem1 | OutElem2,
-    OutErr1 | OutErr2,
+    OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
+    OutErr1 | OutErr2 | (OutElem2 extends Types.unassigned ? Exclude<OutErr, EB> : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -5983,12 +6195,22 @@ export const catchIf: {
   /**
    * Recovers from typed channel errors that match a predicate or refinement.
    *
+   * **When to use**
+   *
+   * Use to recover from typed channel errors when a predicate or refinement
+   * selects the failures that should switch to a recovery channel.
+   *
    * **Details**
    *
    * Matching errors are handled by the recovery function. Non-matching errors
    * are handled by `orElse` when provided. Without `orElse`, non-matching errors
    * are re-failed.
    *
+   * @see {@link catch_ catch} for recovering from every typed channel error
+   * @see {@link catchFilter} for selecting typed errors with a `Filter`
+   * @see {@link catchTag} for selecting tagged typed errors
+   * @see {@link catchCauseFilter} for selecting full causes with a `Filter`
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -6007,8 +6229,8 @@ export const catchIf: {
     InErr1,
     InDone1,
     Env1,
-    OutElem2 = never,
-    OutErr2 = OutErr,
+    OutElem2 = Types.unassigned,
+    OutErr2 = never,
     OutDone2 = never,
     InElem2 = unknown,
     InErr2 = unknown,
@@ -6024,8 +6246,8 @@ export const catchIf: {
       ) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>)
       | undefined
   ): Channel<
-    OutElem | OutElem1 | OutElem2,
-    OutErr1 | OutErr2,
+    OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
+    OutErr1 | OutErr2 | (OutElem2 extends Types.unassigned ? OutErr : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -6094,12 +6316,21 @@ export const catchIf: {
 /**
  * Recovers from typed channel errors selected by a `Filter`.
  *
+ * **When to use**
+ *
+ * Use to recover from channel errors with a reusable `Filter` when matching
+ * can also narrow or transform the error before choosing the recovery channel.
+ *
  * **Details**
  *
  * Successful filter results are handled by the recovery function. Failed
  * filter results are handled by `orElse` when provided. Without `orElse`,
  * failed filter results are re-failed.
  *
+ * @see {@link catchIf} for selecting typed errors with a predicate
+ * @see {@link catchTag} for selecting tagged typed errors
+ * @see {@link catchCauseFilter} for selecting full causes with a `Filter`
+ *
  * @category error handling
  * @since 4.0.0
  */
@@ -6107,12 +6338,21 @@ export const catchFilter: {
   /**
    * Recovers from typed channel errors selected by a `Filter`.
    *
+   * **When to use**
+   *
+   * Use to recover from channel errors with a reusable `Filter` when matching
+   * can also narrow or transform the error before choosing the recovery channel.
+   *
    * **Details**
    *
    * Successful filter results are handled by the recovery function. Failed
    * filter results are handled by `orElse` when provided. Without `orElse`,
    * failed filter results are re-failed.
    *
+   * @see {@link catchIf} for selecting typed errors with a predicate
+   * @see {@link catchTag} for selecting tagged typed errors
+   * @see {@link catchCauseFilter} for selecting full causes with a `Filter`
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -6127,8 +6367,8 @@ export const catchFilter: {
     InErr1,
     InDone1,
     Env1,
-    OutElem2 = never,
-    OutErr2 = X,
+    OutElem2 = Types.unassigned,
+    OutErr2 = never,
     OutDone2 = never,
     InElem2 = unknown,
     InErr2 = unknown,
@@ -6150,8 +6390,8 @@ export const catchFilter: {
     InDone,
     Env
   >(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<
-    OutElem | OutElem1 | OutElem2,
-    OutErr1 | OutErr2,
+    OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
+    OutErr1 | OutErr2 | (OutElem2 extends Types.unassigned ? X : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -6161,12 +6401,21 @@ export const catchFilter: {
   /**
    * Recovers from typed channel errors selected by a `Filter`.
    *
+   * **When to use**
+   *
+   * Use to recover from channel errors with a reusable `Filter` when matching
+   * can also narrow or transform the error before choosing the recovery channel.
+   *
    * **Details**
    *
    * Successful filter results are handled by the recovery function. Failed
    * filter results are handled by `orElse` when provided. Without `orElse`,
    * failed filter results are re-failed.
    *
+   * @see {@link catchIf} for selecting typed errors with a predicate
+   * @see {@link catchTag} for selecting tagged typed errors
+   * @see {@link catchCauseFilter} for selecting full causes with a `Filter`
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -6187,8 +6436,8 @@ export const catchFilter: {
     InErr1,
     InDone1,
     Env1,
-    OutElem2 = never,
-    OutErr2 = X,
+    OutElem2 = Types.unassigned,
+    OutErr2 = never,
     OutDone2 = never,
     InElem2 = unknown,
     InErr2 = unknown,
@@ -6204,8 +6453,8 @@ export const catchFilter: {
       ) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>)
       | undefined
   ): Channel<
-    OutElem | OutElem1 | OutElem2,
-    OutErr1 | OutErr2,
+    OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
+    OutErr1 | OutErr2 | (OutElem2 extends Types.unassigned ? X : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -6309,8 +6558,8 @@ export const catchTag: {
     InErr1,
     InDone1,
     Env1,
-    OutElem2 = never,
-    OutErr2 = Types.ExcludeTag<OutErr, K extends Arr.NonEmptyReadonlyArray<string> ? K[number] : K>,
+    OutElem2 = Types.unassigned,
+    OutErr2 = never,
     OutDone2 = never,
     InElem2 = unknown,
     InErr2 = unknown,
@@ -6334,8 +6583,12 @@ export const catchTag: {
     InDone,
     Env
   >(self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>) => Channel<
-    OutElem | OutElem1 | OutElem2,
-    OutErr1 | OutErr2,
+    OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
+    | OutErr1
+    | OutErr2
+    | (OutElem2 extends Types.unassigned
+      ? Types.ExcludeTag<OutErr, K extends Arr.NonEmptyReadonlyArray<string> ? K[number] : K>
+      : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -6370,8 +6623,8 @@ export const catchTag: {
     InErr1,
     InDone1,
     Env1,
-    OutElem2 = never,
-    OutErr2 = Types.ExcludeTag<OutErr, K extends Arr.NonEmptyReadonlyArray<string> ? K[number] : K>,
+    OutElem2 = Types.unassigned,
+    OutErr2 = never,
     OutDone2 = never,
     InElem2 = unknown,
     InErr2 = unknown,
@@ -6389,8 +6642,12 @@ export const catchTag: {
       ) => Channel<OutElem2, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>)
       | undefined
   ): Channel<
-    OutElem | OutElem1 | OutElem2,
-    OutErr1 | OutErr2,
+    OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
+    | OutErr1
+    | OutErr2
+    | (OutElem2 extends Types.unassigned
+      ? Types.ExcludeTag<OutErr, K extends Arr.NonEmptyReadonlyArray<string> ? K[number] : K>
+      : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -6557,7 +6814,10 @@ export const catchReason: {
     self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>
   ) => Channel<
     OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
-    (OutElem2 extends Types.unassigned ? OutErr : Types.ExcludeTag<OutErr, K>) | OutErr1 | OutErr2,
+    | Types.ExcludeTag<OutErr, K>
+    | OutErr1
+    | OutErr2
+    | (OutElem2 extends Types.unassigned ? Types.ExtractTag<OutErr, K> : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -6638,7 +6898,10 @@ export const catchReason: {
       | undefined
   ): Channel<
     OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
-    (OutElem2 extends Types.unassigned ? OutErr : Types.ExcludeTag<OutErr, K>) | OutErr1 | OutErr2,
+    | Types.ExcludeTag<OutErr, K>
+    | OutErr1
+    | OutErr2
+    | (OutElem2 extends Types.unassigned ? Types.ExtractTag<OutErr, K> : never),
     OutDone | OutDone1 | OutDone2,
     InElem & InElem1 & InElem2,
     InErr & InErr1 & InErr2,
@@ -6685,7 +6948,10 @@ export const catchReason: {
     | undefined
 ): Channel<
   OutElem | OutElem1 | Exclude<OutElem2, Types.unassigned>,
-  (OutElem2 extends Types.unassigned ? OutErr : Types.ExcludeTag<OutErr, K>) | OutErr1 | OutErr2,
+  | Types.ExcludeTag<OutErr, K>
+  | OutErr1
+  | OutErr2
+  | (OutElem2 extends Types.unassigned ? Types.ExtractTag<OutErr, K> : never),
   OutDone | OutDone1 | OutDone2,
   InElem & InElem1 & InElem2,
   InErr & InErr1 & InErr2,
@@ -6761,8 +7027,9 @@ export const catchReasons: {
       [RK in keyof Cases]: Cases[RK] extends
         (...args: Array<any>) => Channel<infer OutElem1, any, any, any, any, any, any> ? OutElem1 : never
     }[keyof Cases],
-    | (OutElem2 extends Types.unassigned ? OutErr : Types.ExcludeTag<OutErr, K>)
+    | Types.ExcludeTag<OutErr, K>
     | OutErr2
+    | (OutElem2 extends Types.unassigned ? Types.ExtractTag<OutErr, K> : never)
     | {
       [RK in keyof Cases]: Cases[RK] extends
         (...args: Array<any>) => Channel<any, infer OutErr1, any, any, any, any, any> ? OutErr1 : never
@@ -6843,8 +7110,9 @@ export const catchReasons: {
       [RK in keyof Cases]: Cases[RK] extends
         (...args: Array<any>) => Channel<infer OutElem1, any, any, any, any, any, any> ? OutElem1 : never
     }[keyof Cases],
-    | (OutElem2 extends Types.unassigned ? OutErr : Types.ExcludeTag<OutErr, K>)
+    | Types.ExcludeTag<OutErr, K>
     | OutErr2
+    | (OutElem2 extends Types.unassigned ? Types.ExtractTag<OutErr, K> : never)
     | {
       [RK in keyof Cases]: Cases[RK] extends
         (...args: Array<any>) => Channel<any, infer OutErr1, any, any, any, any, any> ? OutErr1 : never
@@ -8745,16 +9013,42 @@ export const embedInput: {
 )
 
 /**
- * Allows a faster producer to progress independently of a slower consumer by
- * buffering up to `capacity` elements in a queue.
+ * Buffers individual output elements in a queue with the configured `capacity`
+ * so a faster producer can progress independently of a slower consumer.
+ *
+ * **Details**
+ *
+ * Finite queues use the `strategy` option. The default `"suspend"` strategy
+ * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+ * elements when the queue is full. `"unbounded"` capacity does not use a finite
+ * capacity strategy.
+ *
+ * **Gotchas**
+ *
+ * Dropping and sliding strategies can lose output elements under backpressure.
+ *
+ * @see {@link bufferArray} for buffering elements from array outputs
  *
  * @category Buffering
  * @since 2.0.0
  */
 export const buffer: {
   /**
-   * Allows a faster producer to progress independently of a slower consumer by
-   * buffering up to `capacity` elements in a queue.
+   * Buffers individual output elements in a queue with the configured `capacity`
+   * so a faster producer can progress independently of a slower consumer.
+   *
+   * **Details**
+   *
+   * Finite queues use the `strategy` option. The default `"suspend"` strategy
+   * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+   * elements when the queue is full. `"unbounded"` capacity does not use a finite
+   * capacity strategy.
+   *
+   * **Gotchas**
+   *
+   * Dropping and sliding strategies can lose output elements under backpressure.
+   *
+   * @see {@link bufferArray} for buffering elements from array outputs
    *
    * @category Buffering
    * @since 2.0.0
@@ -8768,8 +9062,21 @@ export const buffer: {
     self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>
   ) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>
   /**
-   * Allows a faster producer to progress independently of a slower consumer by
-   * buffering up to `capacity` elements in a queue.
+   * Buffers individual output elements in a queue with the configured `capacity`
+   * so a faster producer can progress independently of a slower consumer.
+   *
+   * **Details**
+   *
+   * Finite queues use the `strategy` option. The default `"suspend"` strategy
+   * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+   * elements when the queue is full. `"unbounded"` capacity does not use a finite
+   * capacity strategy.
+   *
+   * **Gotchas**
+   *
+   * Dropping and sliding strategies can lose output elements under backpressure.
+   *
+   * @see {@link bufferArray} for buffering elements from array outputs
    *
    * @category Buffering
    * @since 2.0.0
@@ -8791,15 +9098,41 @@ export const buffer: {
   fromTransform(Effect.fnUntraced(function*(upstream, scope) {
     const pull = yield* toTransform(self)(upstream, scope)
     const queue = yield* Queue.make</**
-     * Allows a faster producer to progress independently of a slower consumer by
-     * buffering up to `capacity` elements in a queue.
+     * Buffers individual output elements in a queue with the configured `capacity`
+     * so a faster producer can progress independently of a slower consumer.
+     *
+     * **Details**
+     *
+     * Finite queues use the `strategy` option. The default `"suspend"` strategy
+     * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+     * elements when the queue is full. `"unbounded"` capacity does not use a finite
+     * capacity strategy.
+     *
+     * **Gotchas**
+     *
+     * Dropping and sliding strategies can lose output elements under backpressure.
+     *
+     * @see {@link bufferArray} for buffering elements from array outputs
      *
      * @category Buffering
      * @since 2.0.0
      */
     OutElem, /**
-     * Allows a faster producer to progress independently of a slower consumer by
-     * buffering up to `capacity` elements in a queue.
+     * Buffers individual output elements in a queue with the configured `capacity`
+     * so a faster producer can progress independently of a slower consumer.
+     *
+     * **Details**
+     *
+     * Finite queues use the `strategy` option. The default `"suspend"` strategy
+     * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+     * elements when the queue is full. `"unbounded"` capacity does not use a finite
+     * capacity strategy.
+     *
+     * **Gotchas**
+     *
+     * Dropping and sliding strategies can lose output elements under backpressure.
+     *
+     * @see {@link bufferArray} for buffering elements from array outputs
      *
      * @category Buffering
      * @since 2.0.0
@@ -8819,16 +9152,46 @@ export const buffer: {
   })))
 
 /**
- * Allows a faster producer to progress independently of a slower consumer by
- * buffering up to `capacity` elements in a queue.
+ * Buffers array output elements in a queue with the configured `capacity` so a
+ * faster producer can progress independently of a slower consumer.
+ *
+ * **Details**
+ *
+ * Finite queues use the `strategy` option. The default `"suspend"` strategy
+ * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+ * elements when the queue is full. `"unbounded"` capacity does not use a finite
+ * capacity strategy.
+ *
+ * **Gotchas**
+ *
+ * Input arrays are offered to the queue element-by-element and outputs are
+ * rebuilt from the currently available queued elements, so upstream array
+ * boundaries are not preserved.
+ *
+ * @see {@link buffer} for buffering output elements without flattening arrays
  *
  * @category Buffering
  * @since 4.0.0
  */
 export const bufferArray: {
   /**
-   * Allows a faster producer to progress independently of a slower consumer by
-   * buffering up to `capacity` elements in a queue.
+   * Buffers array output elements in a queue with the configured `capacity` so a
+   * faster producer can progress independently of a slower consumer.
+   *
+   * **Details**
+   *
+   * Finite queues use the `strategy` option. The default `"suspend"` strategy
+   * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+   * elements when the queue is full. `"unbounded"` capacity does not use a finite
+   * capacity strategy.
+   *
+   * **Gotchas**
+   *
+   * Input arrays are offered to the queue element-by-element and outputs are
+   * rebuilt from the currently available queued elements, so upstream array
+   * boundaries are not preserved.
+   *
+   * @see {@link buffer} for buffering output elements without flattening arrays
    *
    * @category Buffering
    * @since 4.0.0
@@ -8842,8 +9205,23 @@ export const bufferArray: {
     self: Channel<Arr.NonEmptyReadonlyArray<OutElem>, OutErr, OutDone, InElem, InErr, InDone, Env>
   ) => Channel<Arr.NonEmptyReadonlyArray<OutElem>, OutErr, OutDone, InElem, InErr, InDone, Env>
   /**
-   * Allows a faster producer to progress independently of a slower consumer by
-   * buffering up to `capacity` elements in a queue.
+   * Buffers array output elements in a queue with the configured `capacity` so a
+   * faster producer can progress independently of a slower consumer.
+   *
+   * **Details**
+   *
+   * Finite queues use the `strategy` option. The default `"suspend"` strategy
+   * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+   * elements when the queue is full. `"unbounded"` capacity does not use a finite
+   * capacity strategy.
+   *
+   * **Gotchas**
+   *
+   * Input arrays are offered to the queue element-by-element and outputs are
+   * rebuilt from the currently available queued elements, so upstream array
+   * boundaries are not preserved.
+   *
+   * @see {@link buffer} for buffering output elements without flattening arrays
    *
    * @category Buffering
    * @since 4.0.0
@@ -8865,15 +9243,45 @@ export const bufferArray: {
   fromTransform(Effect.fnUntraced(function*(upstream, scope) {
     const pull = yield* toTransform(self)(upstream, scope)
     const queue = yield* Queue.make</**
-     * Allows a faster producer to progress independently of a slower consumer by
-     * buffering up to `capacity` elements in a queue.
+     * Buffers array output elements in a queue with the configured `capacity` so a
+     * faster producer can progress independently of a slower consumer.
+     *
+     * **Details**
+     *
+     * Finite queues use the `strategy` option. The default `"suspend"` strategy
+     * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+     * elements when the queue is full. `"unbounded"` capacity does not use a finite
+     * capacity strategy.
+     *
+     * **Gotchas**
+     *
+     * Input arrays are offered to the queue element-by-element and outputs are
+     * rebuilt from the currently available queued elements, so upstream array
+     * boundaries are not preserved.
+     *
+     * @see {@link buffer} for buffering output elements without flattening arrays
      *
      * @category Buffering
      * @since 4.0.0
      */
     OutElem, /**
-     * Allows a faster producer to progress independently of a slower consumer by
-     * buffering up to `capacity` elements in a queue.
+     * Buffers array output elements in a queue with the configured `capacity` so a
+     * faster producer can progress independently of a slower consumer.
+     *
+     * **Details**
+     *
+     * Finite queues use the `strategy` option. The default `"suspend"` strategy
+     * applies backpressure, while `"dropping"` and `"sliding"` can discard output
+     * elements when the queue is full. `"unbounded"` capacity does not use a finite
+     * capacity strategy.
+     *
+     * **Gotchas**
+     *
+     * Input arrays are offered to the queue element-by-element and outputs are
+     * rebuilt from the currently available queued elements, so upstream array
+     * boundaries are not preserved.
+     *
+     * @see {@link buffer} for buffering output elements without flattening arrays
      *
      * @category Buffering
      * @since 4.0.0
@@ -8893,26 +9301,36 @@ export const bufferArray: {
   })))
 
 /**
- * Returns a new channel, which is the same as this one, except it will be
- * interrupted when the specified effect completes. If the effect completes
- * successfully before the underlying channel is done, then the returned
- * channel will yield the success value of the effect as its terminal value.
- * On the other hand, if the underlying channel finishes first, then the
- * returned channel will yield the success value of the underlying channel as
- * its terminal value.
+ * Interrupts a channel when another effect completes.
+ *
+ * **When to use**
+ *
+ * Use to race channel execution against an external effect whose success can
+ * become the channel's done value.
+ *
+ * **Details**
+ *
+ * If the effect completes first, its success value becomes the returned
+ * channel's done value. If the channel completes first, the original channel's
+ * done value is preserved.
  *
  * @category utils
  * @since 2.0.0
  */
 export const interruptWhen: {
   /**
-   * Returns a new channel, which is the same as this one, except it will be
-   * interrupted when the specified effect completes. If the effect completes
-   * successfully before the underlying channel is done, then the returned
-   * channel will yield the success value of the effect as its terminal value.
-   * On the other hand, if the underlying channel finishes first, then the
-   * returned channel will yield the success value of the underlying channel as
-   * its terminal value.
+   * Interrupts a channel when another effect completes.
+   *
+   * **When to use**
+   *
+   * Use to race channel execution against an external effect whose success can
+   * become the channel's done value.
+   *
+   * **Details**
+   *
+   * If the effect completes first, its success value becomes the returned
+   * channel's done value. If the channel completes first, the original channel's
+   * done value is preserved.
    *
    * @category utils
    * @since 2.0.0
@@ -8921,13 +9339,18 @@ export const interruptWhen: {
     self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>
   ) => Channel<OutElem, OutErr | OutErr2, OutDone | OutDone2, InElem, InErr, InDone, Env2 | Env>
   /**
-   * Returns a new channel, which is the same as this one, except it will be
-   * interrupted when the specified effect completes. If the effect completes
-   * successfully before the underlying channel is done, then the returned
-   * channel will yield the success value of the effect as its terminal value.
-   * On the other hand, if the underlying channel finishes first, then the
-   * returned channel will yield the success value of the underlying channel as
-   * its terminal value.
+   * Interrupts a channel when another effect completes.
+   *
+   * **When to use**
+   *
+   * Use to race channel execution against an external effect whose success can
+   * become the channel's done value.
+   *
+   * **Details**
+   *
+   * If the effect completes first, its success value becomes the returned
+   * channel's done value. If the channel completes first, the original channel's
+   * done value is preserved.
    *
    * @category utils
    * @since 2.0.0
@@ -8947,7 +9370,7 @@ export const interruptWhen: {
   ))
 
 /**
- * Halts a channel when the specified effect completes or fails.
+ * Stops a channel when the specified effect completes or fails.
  *
  * **Details**
  *
@@ -8961,7 +9384,7 @@ export const interruptWhen: {
  */
 export const haltWhen: {
   /**
-   * Halts a channel when the specified effect completes or fails.
+   * Stops a channel when the specified effect completes or fails.
    *
    * **Details**
    *
@@ -8977,7 +9400,7 @@ export const haltWhen: {
     self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>
   ) => Channel<OutElem, OutErr | OutErr2, OutDone | OutDone2, InElem, InErr, InDone, Env2 | Env>
   /**
-   * Halts a channel when the specified effect completes or fails.
+   * Stops a channel when the specified effect completes or fails.
    *
    * **Details**
    *
@@ -9062,9 +9485,8 @@ export const onError: {
   onExit(self, (exit) => Exit.isFailure(exit) ? finalizer(exit.cause) : Effect.void))
 
 /**
- * Returns a new channel with an attached finalizer. The finalizer is
- * guaranteed to be executed so long as the channel begins execution (and
- * regardless of whether or not it completes).
+ * Returns a channel with an exit-aware finalizer that is guaranteed to run once
+ * the channel begins execution, whether it succeeds or fails.
  *
  * **Example** (Running exit finalizers)
  *
@@ -9093,9 +9515,8 @@ export const onError: {
  */
 export const onExit: {
   /**
-   * Returns a new channel with an attached finalizer. The finalizer is
-   * guaranteed to be executed so long as the channel begins execution (and
-   * regardless of whether or not it completes).
+   * Returns a channel with an exit-aware finalizer that is guaranteed to run once
+   * the channel begins execution, whether it succeeds or fails.
    *
    * **Example** (Running exit finalizers)
    *
@@ -9128,9 +9549,8 @@ export const onExit: {
     self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>
   ) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env2 | Env>
   /**
-   * Returns a new channel with an attached finalizer. The finalizer is
-   * guaranteed to be executed so long as the channel begins execution (and
-   * regardless of whether or not it completes).
+   * Returns a channel with an exit-aware finalizer that is guaranteed to run once
+   * the channel begins execution, whether it succeeds or fails.
    *
    * **Example** (Running exit finalizers)
    *
@@ -9330,9 +9750,8 @@ export const onEnd: {
     ))))
 
 /**
- * Returns a new channel with an attached finalizer. The finalizer is
- * guaranteed to be executed so long as the channel begins execution (and
- * regardless of whether or not it completes).
+ * Returns a channel with a finalizer effect that is guaranteed to run once the
+ * channel begins execution, whether it succeeds or fails.
  *
  * **Example** (Ensuring cleanup runs)
  *
@@ -9358,9 +9777,8 @@ export const onEnd: {
  */
 export const ensuring: {
   /**
-   * Returns a new channel with an attached finalizer. The finalizer is
-   * guaranteed to be executed so long as the channel begins execution (and
-   * regardless of whether or not it completes).
+   * Returns a channel with a finalizer effect that is guaranteed to run once the
+   * channel begins execution, whether it succeeds or fails.
    *
    * **Example** (Ensuring cleanup runs)
    *
@@ -9388,9 +9806,8 @@ export const ensuring: {
     self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>
   ) => Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env2 | Env>
   /**
-   * Returns a new channel with an attached finalizer. The finalizer is
-   * guaranteed to be executed so long as the channel begins execution (and
-   * regardless of whether or not it completes).
+   * Returns a channel with a finalizer effect that is guaranteed to run once the
+   * channel begins execution, whether it succeeds or fails.
    *
    * **Example** (Ensuring cleanup runs)
    *
@@ -9447,7 +9864,7 @@ const runWith = <
   })
 
 /**
- * Create a channel from the specified services.
+ * Creates a channel from the specified services.
  *
  * @category services
  * @since 2.0.0
@@ -9542,8 +9959,12 @@ export const provideService: {
   ))
 
 /**
- * Evaluates an effect to obtain a service, then provides that service to the
- * channel.
+ * Provides a service to the channel after obtaining it from an effect.
+ *
+ * **When to use**
+ *
+ * Use to supply a channel dependency when constructing the service itself is
+ * effectful or can fail.
  *
  * **Details**
  *
@@ -9555,8 +9976,12 @@ export const provideService: {
  */
 export const provideServiceEffect: {
   /**
-   * Evaluates an effect to obtain a service, then provides that service to the
-   * channel.
+   * Provides a service to the channel after obtaining it from an effect.
+   *
+   * **When to use**
+   *
+   * Use to supply a channel dependency when constructing the service itself is
+   * effectful or can fail.
    *
    * **Details**
    *
@@ -9570,8 +9995,12 @@ export const provideServiceEffect: {
     self: Channel<OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>
   ) => Channel<OutElem, OutErr | ES, OutDone, InElem, InErr, InDone, Exclude<Env, I> | RS>
   /**
-   * Evaluates an effect to obtain a service, then provides that service to the
-   * channel.
+   * Provides a service to the channel after obtaining it from an effect.
+   *
+   * **When to use**
+   *
+   * Use to supply a channel dependency when constructing the service itself is
+   * effectful or can fail.
    *
    * **Details**
    *
@@ -10047,6 +10476,15 @@ export const bind: {
 /**
  * Wraps each output element in an object under the specified field name.
  *
+ * **When to use**
+ *
+ * Use when starting a Channel Do-notation chain from an existing output value
+ * by assigning that value to a field name.
+ *
+ * @see {@link Do} for starting Do notation from an empty object
+ * @see {@link bind} for adding a field produced by another channel
+ * @see {@link let_ let} for adding a computed field
+ *
  * @category Do notation
  * @since 4.0.0
  */
@@ -10054,6 +10492,15 @@ export const bindTo: {
   /**
    * Wraps each output element in an object under the specified field name.
    *
+   * **When to use**
+   *
+   * Use when starting a Channel Do-notation chain from an existing output value
+   * by assigning that value to a field name.
+   *
+   * @see {@link Do} for starting Do notation from an empty object
+   * @see {@link bind} for adding a field produced by another channel
+   * @see {@link let_ let} for adding a computed field
+   *
    * @category Do notation
    * @since 4.0.0
    */
@@ -10071,6 +10518,15 @@ export const bindTo: {
   /**
    * Wraps each output element in an object under the specified field name.
    *
+   * **When to use**
+   *
+   * Use when starting a Channel Do-notation chain from an existing output value
+   * by assigning that value to a field name.
+   *
+   * @see {@link Do} for starting Do notation from an empty object
+   * @see {@link bind} for adding a field produced by another channel
+   * @see {@link let_ let} for adding a computed field
+   *
    * @category Do notation
    * @since 4.0.0
    */