effect 3.8.4 → 3.9.0

package/dist/dts/Channel.d.ts

@@ -158,7 +158,15 @@ export declare const acquireUseRelease: <Acquired, OutErr, Env, OutElem1, InElem
  * @category constructors
  */
 export declare const acquireReleaseOut: {
+    /**
+     * @since 2.0.0
+     * @category constructors
+     */
     <Z, R2>(release: (z: Z, e: Exit.Exit<unknown, unknown>) => Effect.Effect<unknown, never, R2>): <E, R>(self: Effect.Effect<Z, E, R>) => Channel<Z, unknown, E, unknown, void, unknown, R2 | R>;
+    /**
+     * @since 2.0.0
+     * @category constructors
+     */
     <Z, E, R, R2>(self: Effect.Effect<Z, E, R>, release: (z: Z, e: Exit.Exit<unknown, unknown>) => Effect.Effect<unknown, never, R2>): Channel<Z, unknown, E, unknown, void, unknown, R | R2>;
 };
 /**
@@ -172,7 +180,27 @@ export declare const acquireReleaseOut: {
  * @category mapping
  */
 export declare const as: {
+    /**
+     * Returns a new channel that is the same as this one, except the terminal
+     * value of the channel is the specified constant value.
+     *
+     * This method produces the same result as mapping this channel to the
+     * specified constant value.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutDone2>(value: OutDone2): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env>;
+    /**
+     * Returns a new channel that is the same as this one, except the terminal
+     * value of the channel is the specified constant value.
+     *
+     * This method produces the same result as mapping this channel to the
+     * specified constant value.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutDone2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, value: OutDone2): Channel<OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env>;
 };
 /**
@@ -207,7 +235,23 @@ export declare const bufferChunk: <InElem, InErr, InDone>(ref: Ref.Ref<Chunk.Chu
  * @category error handling
  */
 export declare const catchAll: {
+    /**
+     * Returns a new channel that is the same as this one, except if this channel
+     * errors for any typed error, then the returned channel will switch over to
+     * using the fallback channel returned by the specified error handler.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <OutErr, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(f: (error: OutErr) => Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>): <OutElem, InElem, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem, InElem & InElem1, OutErr1, InErr & InErr1, OutDone1 | OutDone, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel that is the same as this one, except if this channel
+     * errors for any typed error, then the returned channel will switch over to
+     * using the fallback channel returned by the specified error handler.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (error: OutErr) => Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>): Channel<OutElem | OutElem1, InElem & InElem1, OutErr1, InErr & InErr1, OutDone | OutDone1, InDone & InDone1, Env | Env1>;
 };
 /**
@@ -219,7 +263,23 @@ export declare const catchAll: {
  * @category error handling
  */
 export declare const catchAllCause: {
+    /**
+     * Returns a new channel that is the same as this one, except if this channel
+     * errors for any typed error, then the returned channel will switch over to
+     * using the fallback channel returned by the specified error handler.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <OutErr, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(f: (cause: Cause.Cause<OutErr>) => Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>): <OutElem, InElem, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem, InElem & InElem1, OutErr1, InErr & InErr1, OutDone1 | OutDone, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel that is the same as this one, except if this channel
+     * errors for any typed error, then the returned channel will switch over to
+     * using the fallback channel returned by the specified error handler.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (cause: Cause.Cause<OutErr>) => Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>): Channel<OutElem | OutElem1, InElem & InElem1, OutErr1, InErr & InErr1, OutDone | OutDone1, InDone & InDone1, Env | Env1>;
 };
 /**
@@ -246,7 +306,25 @@ export declare const concatAllWith: <OutElem, InElem2, OutErr2, InErr2, OutDone,
  * @category utils
  */
 export declare const concatMap: {
+    /**
+     * Returns a new channel whose outputs are fed to the specified factory
+     * function, which creates new channels in response. These new channels are
+     * sequentially concatenated together, and all their outputs appear as outputs
+     * of the newly returned channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, OutElem2, InElem2, OutErr2, InErr2, X, InDone2, Env2>(f: (o: OutElem) => Channel<OutElem2, InElem2, OutErr2, InErr2, X, InDone2, Env2>): <Env, InErr, InElem, InDone, OutErr, OutDone>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem2, InElem & InElem2, OutErr2 | OutErr, InErr & InErr2, unknown, InDone & InDone2, Env2 | Env>;
+    /**
+     * Returns a new channel whose outputs are fed to the specified factory
+     * function, which creates new channels in response. These new channels are
+     * sequentially concatenated together, and all their outputs appear as outputs
+     * of the newly returned channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Env, InErr, InElem, InDone, OutErr, OutDone, OutElem, OutElem2, Env2, InErr2, InElem2, InDone2, OutErr2, X>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (o: OutElem) => Channel<OutElem2, InElem2, OutErr2, InErr2, X, InDone2, Env2>): Channel<OutElem2, InElem & InElem2, OutErr | OutErr2, InErr & InErr2, unknown, InDone & InDone2, Env | Env2>;
 };
 /**
@@ -261,7 +339,29 @@ export declare const concatMap: {
  * @category utils
  */
 export declare const concatMapWith: {
+    /**
+     * Returns a new channel whose outputs are fed to the specified factory
+     * function, which creates new channels in response. These new channels are
+     * sequentially concatenated together, and all their outputs appear as outputs
+     * of the newly returned channel. The provided merging function is used to
+     * merge the terminal values of all channels into the single terminal value of
+     * the returned channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, OutElem2, InElem2, OutErr2, InErr2, OutDone, InDone2, Env2, OutDone2, OutDone3>(f: (o: OutElem) => Channel<OutElem2, InElem2, OutErr2, InErr2, OutDone, InDone2, Env2>, g: (o: OutDone, o1: OutDone) => OutDone, h: (o: OutDone, o2: OutDone2) => OutDone3): <Env, InErr, InElem, InDone, OutErr>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env>) => Channel<OutElem2, InElem & InElem2, OutErr2 | OutErr, InErr & InErr2, OutDone3, InDone & InDone2, Env2 | Env>;
+    /**
+     * Returns a new channel whose outputs are fed to the specified factory
+     * function, which creates new channels in response. These new channels are
+     * sequentially concatenated together, and all their outputs appear as outputs
+     * of the newly returned channel. The provided merging function is used to
+     * merge the terminal values of all channels into the single terminal value of
+     * the returned channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env, OutElem2, InElem2, OutErr2, InErr2, OutDone, InDone2, Env2, OutDone3>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env>, f: (o: OutElem) => Channel<OutElem2, InElem2, OutErr2, InErr2, OutDone, InDone2, Env2>, g: (o: OutDone, o1: OutDone) => OutDone, h: (o: OutDone, o2: OutDone2) => OutDone3): Channel<OutElem2, InElem & InElem2, OutErr | OutErr2, InErr & InErr2, OutDone3, InDone & InDone2, Env | Env2>;
 };
 /**
@@ -276,7 +376,29 @@ export declare const concatMapWith: {
  * @category utils
  */
 export declare const concatMapWithCustom: {
+    /**
+     * Returns a new channel whose outputs are fed to the specified factory
+     * function, which creates new channels in response. These new channels are
+     * sequentially concatenated together, and all their outputs appear as outputs
+     * of the newly returned channel. The provided merging function is used to
+     * merge the terminal values of all channels into the single terminal value of
+     * the returned channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, OutElem2, InElem2, OutErr2, InErr2, OutDone, InDone2, Env2, OutDone2, OutDone3>(f: (o: OutElem) => Channel<OutElem2, InElem2, OutErr2, InErr2, OutDone, InDone2, Env2>, g: (o: OutDone, o1: OutDone) => OutDone, h: (o: OutDone, o2: OutDone2) => OutDone3, onPull: (upstreamPullRequest: UpstreamPullRequest.UpstreamPullRequest<OutElem>) => UpstreamPullStrategy.UpstreamPullStrategy<OutElem2>, onEmit: (elem: OutElem2) => ChildExecutorDecision.ChildExecutorDecision): <Env, InErr, InElem, InDone, OutErr>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env>) => Channel<OutElem2, InElem & InElem2, OutErr2 | OutErr, InErr & InErr2, OutDone3, InDone & InDone2, Env2 | Env>;
+    /**
+     * Returns a new channel whose outputs are fed to the specified factory
+     * function, which creates new channels in response. These new channels are
+     * sequentially concatenated together, and all their outputs appear as outputs
+     * of the newly returned channel. The provided merging function is used to
+     * merge the terminal values of all channels into the single terminal value of
+     * the returned channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env, OutElem2, InElem2, OutErr2, InErr2, OutDone, InDone2, Env2, OutDone3>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env>, f: (o: OutElem) => Channel<OutElem2, InElem2, OutErr2, InErr2, OutDone, InDone2, Env2>, g: (o: OutDone, o1: OutDone) => OutDone, h: (o: OutDone, o2: OutDone2) => OutDone3, onPull: (upstreamPullRequest: UpstreamPullRequest.UpstreamPullRequest<OutElem>) => UpstreamPullStrategy.UpstreamPullStrategy<OutElem2>, onEmit: (elem: OutElem2) => ChildExecutorDecision.ChildExecutorDecision): Channel<OutElem2, InElem & InElem2, OutErr | OutErr2, InErr & InErr2, OutDone3, InDone & InDone2, Env | Env2>;
 };
 /**
@@ -287,7 +409,21 @@ export declare const concatMapWithCustom: {
  * @category utils
  */
 export declare const collect: {
+    /**
+     * Returns a new channel, which is the same as this one, except its outputs
+     * are filtered and transformed by the specified partial function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, OutElem2>(pf: (o: OutElem) => Option.Option<OutElem2>): <InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, unknown, never, unknown, void, unknown, never>) => Channel<OutElem2, InElem, OutErr, InErr, OutDone, InDone, Env>;
+    /**
+     * Returns a new channel, which is the same as this one, except its outputs
+     * are filtered and transformed by the specified partial function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, pf: (o: OutElem) => Option.Option<OutElem2>): Channel<OutElem2, InElem, OutErr, InErr, OutDone, InDone, Env>;
 };
 /**
@@ -307,7 +443,21 @@ export declare const concatOut: <OutElem, InElem, OutErr, InErr, InDone, Env, Ou
  * @category utils
  */
 export declare const mapInput: {
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * function to the input channel's done value.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <InDone0, InDone>(f: (a: InDone0) => InDone): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone0, Env>;
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * function to the input channel's done value.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, InDone0>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (a: InDone0) => InDone): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone0, Env>;
 };
 /**
@@ -318,7 +468,21 @@ export declare const mapInput: {
  * @category utils
  */
 export declare const mapInputEffect: {
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * effectual function to the input channel's done value.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <InDone0, InDone, InErr, Env1>(f: (i: InDone0) => Effect.Effect<InDone, InErr, Env1>): <OutElem, InElem, OutErr, OutDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone0, Env1 | Env>;
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * effectual function to the input channel's done value.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, InDone0, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (i: InDone0) => Effect.Effect<InDone, InErr, Env1>): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone0, Env | Env1>;
 };
 /**
@@ -329,7 +493,21 @@ export declare const mapInputEffect: {
  * @category utils
  */
 export declare const mapInputError: {
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * function to the input channel's error value.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <InErr0, InErr>(f: (a: InErr0) => InErr): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr0, OutDone, InDone, Env>;
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * function to the input channel's error value.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, InErr0>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (a: InErr0) => InErr): Channel<OutElem, InElem, OutErr, InErr0, OutDone, InDone, Env>;
 };
 /**
@@ -340,7 +518,21 @@ export declare const mapInputError: {
  * @category utils
  */
 export declare const mapInputErrorEffect: {
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * effectual function to the input channel's error value.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <InErr0, InDone, InErr, Env1>(f: (error: InErr0) => Effect.Effect<InDone, InErr, Env1>): <OutElem, InElem, OutErr, OutDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr0, OutDone, InDone, Env1 | Env>;
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * effectual function to the input channel's error value.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, InErr0, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (error: InErr0) => Effect.Effect<InDone, InErr, Env1>): Channel<OutElem, InElem, OutErr, InErr0, OutDone, InDone, Env | Env1>;
 };
 /**
@@ -351,7 +543,21 @@ export declare const mapInputErrorEffect: {
  * @category utils
  */
 export declare const mapInputIn: {
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * function to the input channel's output elements.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <InElem0, InElem>(f: (a: InElem0) => InElem): <OutElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem0, OutErr, InErr, OutDone, InDone, Env>;
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * function to the input channel's output elements.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, InElem0>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (a: InElem0) => InElem): Channel<OutElem, InElem0, OutErr, InErr, OutDone, InDone, Env>;
 };
 /**
@@ -362,7 +568,21 @@ export declare const mapInputIn: {
  * @category utils
  */
 export declare const mapInputInEffect: {
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * effectual function to the input channel's output elements.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <InElem0, InElem, InErr, Env1>(f: (a: InElem0) => Effect.Effect<InElem, InErr, Env1>): <OutElem, OutErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem0, OutErr, InErr, OutDone, InDone, Env1 | Env>;
+    /**
+     * Returns a new channel which is the same as this one but applies the given
+     * effectual function to the input channel's output elements.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, InElem0, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (a: InElem0) => Effect.Effect<InElem, InErr, Env1>): Channel<OutElem, InElem0, OutErr, InErr, OutDone, InDone, Env | Env1>;
 };
 /**
@@ -394,7 +614,21 @@ export declare const drain: <OutElem, InElem, OutErr, InErr, OutDone, InDone, En
  * @category utils
  */
 export declare const embedInput: {
+    /**
+     * Returns a new channel which connects the given `AsyncInputProducer` as
+     * this channel's input.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <InErr, InElem, InDone>(input: SingleProducerAsyncInput.AsyncInputProducer<InErr, InElem, InDone>): <OutElem, OutErr, OutDone, Env>(self: Channel<OutElem, unknown, OutErr, unknown, OutDone, unknown, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>;
+    /**
+     * Returns a new channel which connects the given `AsyncInputProducer` as
+     * this channel's input.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, OutErr, OutDone, Env, InErr, InElem, InDone>(self: Channel<OutElem, unknown, OutErr, unknown, OutDone, unknown, Env>, input: SingleProducerAsyncInput.AsyncInputProducer<InErr, InElem, InDone>): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>;
 };
 /**
@@ -414,7 +648,23 @@ export declare const emitCollect: <OutElem, InElem, OutErr, InErr, OutDone, InDo
  * @category utils
  */
 export declare 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).
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Z, Env1>(finalizer: Effect.Effect<Z, never, Env1>): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env1 | 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).
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, Z, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, finalizer: Effect.Effect<Z, never, Env1>): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env | Env1>;
 };
 /**
@@ -426,7 +676,23 @@ export declare const ensuring: {
  * @category utils
  */
 export declare const ensuringWith: {
+    /**
+     * 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).
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutDone, OutErr, Env2>(finalizer: (e: Exit.Exit<OutDone, OutErr>) => Effect.Effect<unknown, never, Env2>): <OutElem, InElem, InErr, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, 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).
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, Env2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, finalizer: (e: Exit.Exit<OutDone, OutErr>) => Effect.Effect<unknown, never, Env2>): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env | Env2>;
 };
 /**
@@ -498,7 +764,27 @@ export declare const failCauseSync: <E>(evaluate: LazyArg<Cause.Cause<E>>) => Ch
  * @category sequencing
  */
 export declare const flatMap: {
+    /**
+     * Returns a new channel, which sequentially combines this channel, together
+     * with the provided factory function, which creates a second channel based on
+     * the terminal value of this channel. The result is a channel that will first
+     * perform the functions of this channel, before performing the functions of
+     * the created channel (including yielding its terminal value).
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <OutDone, OutElem1, InElem1, OutErr1, InErr1, OutDone2, InDone1, Env1>(f: (d: OutDone) => Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone2, InDone1, Env1>): <OutElem, InElem, OutErr, InErr, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem, InElem & InElem1, OutErr1 | OutErr, InErr & InErr1, OutDone2, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel, which sequentially combines this channel, together
+     * with the provided factory function, which creates a second channel based on
+     * the terminal value of this channel. The result is a channel that will first
+     * perform the functions of this channel, before performing the functions of
+     * the created channel (including yielding its terminal value).
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr1, InErr1, OutDone2, InDone1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (d: OutDone) => Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone2, InDone1, Env1>): Channel<OutElem | OutElem1, InElem & InElem1, OutErr | OutErr1, InErr & InErr1, OutDone2, InDone & InDone1, Env | Env1>;
 };
 /**
@@ -517,10 +803,22 @@ export declare const flatten: <OutElem, InElem, OutErr, InErr, OutElem1, InElem1
  * @category utils
  */
 export declare const foldChannel: {
+    /**
+     * Folds over the result of this channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutErr, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1, OutDone, OutElem2, InElem2, OutErr2, InErr2, OutDone2, InDone2, Env2>(options: {
         readonly onFailure: (error: OutErr) => Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>;
         readonly onSuccess: (done: OutDone) => Channel<OutElem2, InElem2, OutErr2, InErr2, OutDone2, InDone2, Env2>;
     }): <Env, InErr, InElem, InDone, OutElem>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem2 | OutElem, InElem & InElem1 & InElem2, OutErr1 | OutErr2, InErr & InErr1 & InErr2, OutDone1 | OutDone2, InDone & InDone1 & InDone2, Env1 | Env2 | Env>;
+    /**
+     * Folds over the result of this channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1, OutElem2, InElem2, OutErr2, InErr2, OutDone2, InDone2, Env2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, options: {
         readonly onFailure: (error: OutErr) => Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>;
         readonly onSuccess: (done: OutDone) => Channel<OutElem2, InElem2, OutErr2, InErr2, OutDone2, InDone2, Env2>;
@@ -533,10 +831,22 @@ export declare const foldChannel: {
  * @category utils
  */
 export declare const foldCauseChannel: {
+    /**
+     * Folds over the result of this channel including any cause of termination.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutErr, OutElem1, InElem1, OutErr2, InErr1, OutDone2, InDone1, Env1, OutDone, OutElem2, InElem2, OutErr3, InErr2, OutDone3, InDone2, Env2>(options: {
         readonly onFailure: (c: Cause.Cause<OutErr>) => Channel<OutElem1, InElem1, OutErr2, InErr1, OutDone2, InDone1, Env1>;
         readonly onSuccess: (o: OutDone) => Channel<OutElem2, InElem2, OutErr3, InErr2, OutDone3, InDone2, Env2>;
     }): <Env, InErr, InElem, InDone, OutElem>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem2 | OutElem, InElem & InElem1 & InElem2, OutErr2 | OutErr3, InErr & InErr1 & InErr2, OutDone2 | OutDone3, InDone & InDone1 & InDone2, Env1 | Env2 | Env>;
+    /**
+     * Folds over the result of this channel including any cause of termination.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr2, InErr1, OutDone2, InDone1, Env1, OutElem2, InElem2, OutErr3, InErr2, OutDone3, InDone2, Env2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, options: {
         readonly onFailure: (c: Cause.Cause<OutErr>) => Channel<OutElem1, InElem1, OutErr2, InErr1, OutDone2, InDone1, Env1>;
         readonly onSuccess: (o: OutDone) => Channel<OutElem2, InElem2, OutErr3, InErr2, OutDone3, InDone2, Env2>;
@@ -609,7 +919,31 @@ export declare const identity: <Elem, Err, Done>() => Channel<Elem, Elem, Err, E
  * @category utils
  */
 export declare 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.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutDone1, OutErr1, Env1>(effect: Effect.Effect<OutDone1, OutErr1, Env1>): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr1 | OutErr, InErr, OutDone1 | OutDone, InDone, Env1 | 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.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutDone1, OutErr1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, effect: Effect.Effect<OutDone1, OutErr1, Env1>): Channel<OutElem, InElem, OutErr | OutErr1, InErr, OutDone | OutDone1, InDone, Env | Env1>;
 };
 /**
@@ -624,7 +958,29 @@ export declare const interruptWhen: {
  * @category utils
  */
 export declare const interruptWhenDeferred: {
+    /**
+     * Returns a new channel, which is the same as this one, except it will be
+     * interrupted when the specified deferred is completed. If the deferred is
+     * completed before the underlying channel is done, then the returned channel
+     * will yield the value of the deferred. Otherwise, if the underlying channel
+     * finishes first, then the returned channel will yield the value of the
+     * underlying channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutDone1, OutErr1>(deferred: Deferred.Deferred<OutDone1, OutErr1>): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr1 | OutErr, InErr, OutDone1 | OutDone, InDone, Env>;
+    /**
+     * Returns a new channel, which is the same as this one, except it will be
+     * interrupted when the specified deferred is completed. If the deferred is
+     * completed before the underlying channel is done, then the returned channel
+     * will yield the value of the deferred. Otherwise, if the underlying channel
+     * finishes first, then the returned channel will yield the value of the
+     * underlying channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutDone1, OutErr1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, deferred: Deferred.Deferred<OutDone1, OutErr1>): Channel<OutElem, InElem, OutErr | OutErr1, InErr, OutDone | OutDone1, InDone, Env>;
 };
 /**
@@ -636,7 +992,23 @@ export declare const interruptWhenDeferred: {
  * @category mapping
  */
 export declare const map: {
+    /**
+     * Returns a new channel, which is the same as this one, except the terminal
+     * value of the returned channel is created by applying the specified function
+     * to the terminal value of this channel.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutDone, OutDone2>(f: (out: OutDone) => OutDone2): <OutElem, InElem, OutErr, InErr, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env>;
+    /**
+     * Returns a new channel, which is the same as this one, except the terminal
+     * value of the returned channel is created by applying the specified function
+     * to the terminal value of this channel.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutDone2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (out: OutDone) => OutDone2): Channel<OutElem, InElem, OutErr, InErr, OutDone2, InDone, Env>;
 };
 /**
@@ -648,7 +1020,23 @@ export declare const map: {
  * @category mapping
  */
 export declare const mapEffect: {
+    /**
+     * Returns a new channel, which is the same as this one, except the terminal
+     * value of the returned channel is created by applying the specified
+     * effectful function to the terminal value of this channel.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutDone, OutDone1, OutErr1, Env1>(f: (o: OutDone) => Effect.Effect<OutDone1, OutErr1, Env1>): <OutElem, InElem, OutErr, InErr, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr1 | OutErr, InErr, OutDone1, InDone, Env1 | Env>;
+    /**
+     * Returns a new channel, which is the same as this one, except the terminal
+     * value of the returned channel is created by applying the specified
+     * effectful function to the terminal value of this channel.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutDone1, OutErr1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (o: OutDone) => Effect.Effect<OutDone1, OutErr1, Env1>): Channel<OutElem, InElem, OutErr | OutErr1, InErr, OutDone1, InDone, Env | Env1>;
 };
 /**
@@ -660,7 +1048,23 @@ export declare const mapEffect: {
  * @category mapping
  */
 export declare const mapError: {
+    /**
+     * Returns a new channel, which is the same as this one, except the failure
+     * value of the returned channel is created by applying the specified function
+     * to the failure value of this channel.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutErr, OutErr2>(f: (err: OutErr) => OutErr2): <OutElem, InElem, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr2, InErr, OutDone, InDone, Env>;
+    /**
+     * Returns a new channel, which is the same as this one, except the failure
+     * value of the returned channel is created by applying the specified function
+     * to the failure value of this channel.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutErr2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (err: OutErr) => OutErr2): Channel<OutElem, InElem, OutErr2, InErr, OutDone, InDone, Env>;
 };
 /**
@@ -671,7 +1075,21 @@ export declare const mapError: {
  * @category mapping
  */
 export declare const mapErrorCause: {
+    /**
+     * A more powerful version of `mapError` which also surfaces the `Cause`
+     * of the channel failure.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutErr, OutErr2>(f: (cause: Cause.Cause<OutErr>) => Cause.Cause<OutErr2>): <OutElem, InElem, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr2, InErr, OutDone, InDone, Env>;
+    /**
+     * A more powerful version of `mapError` which also surfaces the `Cause`
+     * of the channel failure.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutErr2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (cause: Cause.Cause<OutErr>) => Cause.Cause<OutErr2>): Channel<OutElem, InElem, OutErr2, InErr, OutDone, InDone, Env>;
 };
 /**
@@ -681,7 +1099,19 @@ export declare const mapErrorCause: {
  * @category mapping
  */
 export declare const mapOut: {
+    /**
+     * Maps the output of this channel using the specified function.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, OutElem2>(f: (o: OutElem) => OutElem2): <InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem2, InElem, OutErr, InErr, OutDone, InDone, Env>;
+    /**
+     * Maps the output of this channel using the specified function.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (o: OutElem) => OutElem2): Channel<OutElem2, InElem, OutErr, InErr, OutDone, InDone, Env>;
 };
 /**
@@ -692,7 +1122,21 @@ export declare const mapOut: {
  * @category mapping
  */
 export declare const mapOutEffect: {
+    /**
+     * Creates a channel that is like this channel but the given effectful function
+     * gets applied to each emitted output element.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, OutElem1, OutErr1, Env1>(f: (o: OutElem) => Effect.Effect<OutElem1, OutErr1, Env1>): <InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1, InElem, OutErr1 | OutErr, InErr, OutDone, InDone, Env1 | Env>;
+    /**
+     * Creates a channel that is like this channel but the given effectful function
+     * gets applied to each emitted output element.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, OutErr1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (o: OutElem) => Effect.Effect<OutElem1, OutErr1, Env1>): Channel<OutElem1, InElem, OutErr | OutErr1, InErr, OutDone, InDone, Env | Env1>;
 };
 /**
@@ -704,7 +1148,23 @@ export declare const mapOutEffect: {
  * @category mapping
  */
 export declare const mapOutEffectPar: {
+    /**
+     * Creates a channel that is like this channel but the given ZIO function gets
+     * applied to each emitted output element, taking `n` elements at once and
+     * mapping them in parallel.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, OutElem1, OutErr1, Env1>(f: (o: OutElem) => Effect.Effect<OutElem1, OutErr1, Env1>, n: number): <InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1, InElem, OutErr1 | OutErr, InErr, OutDone, InDone, Env1 | Env>;
+    /**
+     * Creates a channel that is like this channel but the given ZIO function gets
+     * applied to each emitted output element, taking `n` elements at once and
+     * mapping them in parallel.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, OutErr1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (o: OutElem) => Effect.Effect<OutElem1, OutErr1, Env1>, n: number): Channel<OutElem1, InElem, OutErr | OutErr1, InErr, OutDone, InDone, Env | Env1>;
 };
 /**
@@ -747,11 +1207,33 @@ export declare const mergeAllWith: ({ bufferSize, concurrency, mergeStrategy }:
  * @category mapping
  */
 export declare const mergeMap: {
+    /**
+     * Returns a new channel which creates a new channel for each emitted element
+     * and merges some of them together. Different merge strategies control what
+     * happens if there are more than the given maximum number of channels gets
+     * created. See `Channel.mergeAll`.
+     *
+     * @param n The maximum number of channels to merge.
+     * @param f The function that creates a new channel from each emitted element.
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, OutElem1, InElem1, OutErr1, InErr1, Z, InDone1, Env1>(f: (outElem: OutElem) => Channel<OutElem1, InElem1, OutErr1, InErr1, Z, InDone1, Env1>, options: {
         readonly concurrency: number | "unbounded";
         readonly bufferSize?: number | undefined;
         readonly mergeStrategy?: MergeStrategy.MergeStrategy | undefined;
     }): <InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1, InElem & InElem1, OutErr1 | OutErr, InErr & InErr1, unknown, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel which creates a new channel for each emitted element
+     * and merges some of them together. Different merge strategies control what
+     * happens if there are more than the given maximum number of channels gets
+     * created. See `Channel.mergeAll`.
+     *
+     * @param n The maximum number of channels to merge.
+     * @param f The function that creates a new channel from each emitted element.
+     * @since 2.0.0
+     * @category mapping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr1, InErr1, Z, InDone1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (outElem: OutElem) => Channel<OutElem1, InElem1, OutErr1, InErr1, Z, InDone1, Env1>, options: {
         readonly concurrency: number | "unbounded";
         readonly bufferSize?: number | undefined;
@@ -766,7 +1248,21 @@ export declare const mergeMap: {
  * @category utils
  */
 export declare const mergeOut: {
+    /**
+     * Returns a new channel which merges a number of channels emitted by this
+     * channel using the back pressuring merge strategy. See `Channel.mergeAll`.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     (n: number): <OutElem1, InElem1, OutErr1, InErr1, Z, InDone1, Env1, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<Channel<OutElem1, InElem1, OutErr1, InErr1, Z, InDone1, Env1>, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1, InElem & InElem1, OutErr1 | OutErr, InErr & InErr1, unknown, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel which merges a number of channels emitted by this
+     * channel using the back pressuring merge strategy. See `Channel.mergeAll`.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem1, InElem1, OutErr1, InErr1, Z, InDone1, Env1, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<Channel<OutElem1, InElem1, OutErr1, InErr1, Z, InDone1, Env1>, InElem, OutErr, InErr, OutDone, InDone, Env>, n: number): Channel<OutElem1, InElem & InElem1, OutErr1 | OutErr, InErr & InErr1, unknown, InDone & InDone1, Env1 | Env>;
 };
 /**
@@ -779,7 +1275,25 @@ export declare const mergeOut: {
  * @category utils
  */
 export declare const mergeOutWith: {
+    /**
+     * Returns a new channel which merges a number of channels emitted by this
+     * channel using the back pressuring merge strategy and uses a given function
+     * to merge each completed subchannel's result value. See
+     * `Channel.mergeAll`.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutDone1>(n: number, f: (o1: OutDone1, o2: OutDone1) => OutDone1): <OutElem1, InElem1, OutErr1, InErr1, InDone1, Env1, InElem, OutErr, InErr, InDone, Env>(self: Channel<Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>, InElem, OutErr, InErr, OutDone1, InDone, Env>) => Channel<OutElem1, InElem & InElem1, OutErr1 | OutErr, InErr & InErr1, OutDone1, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel which merges a number of channels emitted by this
+     * channel using the back pressuring merge strategy and uses a given function
+     * to merge each completed subchannel's result value. See
+     * `Channel.mergeAll`.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1, InElem, OutErr, InErr, InDone, Env>(self: Channel<Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>, InElem, OutErr, InErr, OutDone1, InDone, Env>, n: number, f: (o1: OutDone1, o2: OutDone1) => OutDone1): Channel<OutElem1, InElem & InElem1, OutErr1 | OutErr, InErr & InErr1, OutDone1, InDone & InDone1, Env1 | Env>;
 };
 /**
@@ -792,11 +1306,29 @@ export declare const mergeOutWith: {
  * @category utils
  */
 export declare const mergeWith: {
+    /**
+     * Returns a new channel, which is the merge of this channel and the specified
+     * channel, where the behavior of the returned channel on left or right early
+     * termination is decided by the specified `leftDone` and `rightDone` merge
+     * decisions.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1, OutDone, OutErr, OutErr2, OutDone2, OutErr3, OutDone3>(options: {
         readonly other: Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>;
         readonly onSelfDone: (exit: Exit.Exit<OutDone, OutErr>) => MergeDecision.MergeDecision<Env1, OutErr1, OutDone1, OutErr2, OutDone2>;
         readonly onOtherDone: (ex: Exit.Exit<OutDone1, OutErr1>) => MergeDecision.MergeDecision<Env1, OutErr, OutDone, OutErr3, OutDone3>;
     }): <Env, InErr, InElem, InDone, OutElem>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem, InElem & InElem1, OutErr2 | OutErr3, InErr & InErr1, OutDone2 | OutDone3, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel, which is the merge of this channel and the specified
+     * channel, where the behavior of the returned channel on left or right early
+     * termination is decided by the specified `leftDone` and `rightDone` merge
+     * decisions.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1, OutErr2, OutDone2, OutErr3, OutDone3>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, options: {
         readonly other: Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>;
         readonly onSelfDone: (exit: Exit.Exit<OutDone, OutErr>) => MergeDecision.MergeDecision<Env1, OutErr1, OutDone1, OutErr2, OutDone2>;
@@ -818,7 +1350,21 @@ export declare const never: Channel<never, unknown, never, unknown, never, unkno
  * @category error handling
  */
 export declare const orDie: {
+    /**
+     * Translates channel failure into death of the fiber, making all failures
+     * unchecked and not a part of the type of the channel.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <E>(error: LazyArg<E>): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, never, InErr, OutDone, InDone, Env>;
+    /**
+     * Translates channel failure into death of the fiber, making all failures
+     * unchecked and not a part of the type of the channel.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, E>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, error: LazyArg<E>): Channel<OutElem, InElem, never, InErr, OutDone, InDone, Env>;
 };
 /**
@@ -829,7 +1375,21 @@ export declare const orDie: {
  * @category error handling
  */
 export declare const orDieWith: {
+    /**
+     * Keeps none of the errors, and terminates the fiber with them, using the
+     * specified function to convert the `OutErr` into a defect.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <OutErr>(f: (e: OutErr) => unknown): <OutElem, InElem, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, never, InErr, OutDone, InDone, Env>;
+    /**
+     * Keeps none of the errors, and terminates the fiber with them, using the
+     * specified function to convert the `OutErr` into a defect.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (e: OutErr) => unknown): Channel<OutElem, InElem, never, InErr, OutDone, InDone, Env>;
 };
 /**
@@ -841,7 +1401,23 @@ export declare const orDieWith: {
  * @category error handling
  */
 export declare const orElse: {
+    /**
+     * Returns a new channel that will perform the operations of this one, until
+     * failure, and then it will switch over to the operations of the specified
+     * fallback channel.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(that: LazyArg<Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>>): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem, InElem & InElem1, OutErr1, InErr & InErr1, OutDone1 | OutDone, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel that will perform the operations of this one, until
+     * failure, and then it will switch over to the operations of the specified
+     * fallback channel.
+     *
+     * @since 2.0.0
+     * @category error handling
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, that: LazyArg<Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>>): Channel<OutElem | OutElem1, InElem & InElem1, OutErr1, InErr & InErr1, OutDone | OutDone1, InDone & InDone1, Env | Env1>;
 };
 /**
@@ -854,7 +1430,25 @@ export declare const orElse: {
  * @category utils
  */
 export declare const pipeTo: {
+    /**
+     * Returns a new channel that pipes the output of this channel into the
+     * specified channel. The returned channel has the input type of this channel,
+     * and the output type of the specified channel, terminating with the value of
+     * the specified channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem2, OutElem, OutErr2, OutErr, OutDone2, OutDone, Env2>(that: Channel<OutElem2, OutElem, OutErr2, OutErr, OutDone2, OutDone, Env2>): <InElem, InErr, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem2, InElem, OutErr2, InErr, OutDone2, InDone, Env2 | Env>;
+    /**
+     * Returns a new channel that pipes the output of this channel into the
+     * specified channel. The returned channel has the input type of this channel,
+     * and the output type of the specified channel, terminating with the value of
+     * the specified channel.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem2, OutErr2, OutDone2, Env2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, that: Channel<OutElem2, OutElem, OutErr2, OutErr, OutDone2, OutDone, Env2>): Channel<OutElem2, InElem, OutErr2, InErr, OutDone2, InDone, Env | Env2>;
 };
 /**
@@ -866,7 +1460,23 @@ export declare const pipeTo: {
  * @category utils
  */
 export declare const pipeToOrFail: {
+    /**
+     * Returns a new channel that pipes the output of this channel into the
+     * specified channel and preserves this channel's failures without providing
+     * them to the other channel for observation.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem2, OutElem, OutErr2, OutDone2, OutDone, Env2>(that: Channel<OutElem2, OutElem, OutErr2, never, OutDone2, OutDone, Env2>): <InElem, OutErr, InErr, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem2, InElem, OutErr2 | OutErr, InErr, OutDone2, InDone, Env2 | Env>;
+    /**
+     * Returns a new channel that pipes the output of this channel into the
+     * specified channel and preserves this channel's failures without providing
+     * them to the other channel for observation.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem2, OutErr2, OutDone2, Env2>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, that: Channel<OutElem2, OutElem, OutErr2, never, OutDone2, OutDone, Env2>): Channel<OutElem2, InElem, OutErr | OutErr2, InErr, OutDone2, InDone, Env | Env2>;
 };
 /**
@@ -877,7 +1487,21 @@ export declare const pipeToOrFail: {
  * @category context
  */
 export declare const provideContext: {
+    /**
+     * Provides the channel with its required context, which eliminates its
+     * dependency on `Env`.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <Env>(env: Context.Context<Env>): <OutElem, InElem, OutErr, InErr, OutDone, InDone>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, never>;
+    /**
+     * Provides the channel with its required context, which eliminates its
+     * dependency on `Env`.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, env: Context.Context<Env>): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, never>;
 };
 /**
@@ -887,7 +1511,19 @@ export declare const provideContext: {
  * @category context
  */
 export declare const provideLayer: {
+    /**
+     * Provides a layer to the channel, which translates it to another level.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <Env, OutErr2, Env0>(layer: Layer.Layer<Env, OutErr2, Env0>): <OutElem, InElem, OutErr, InErr, OutDone, InDone>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr2 | OutErr, InErr, OutDone, InDone, Env0>;
+    /**
+     * Provides a layer to the channel, which translates it to another level.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutErr2, Env0>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, layer: Layer.Layer<Env, OutErr2, Env0>): Channel<OutElem, InElem, OutErr | OutErr2, InErr, OutDone, InDone, Env0>;
 };
 /**
@@ -898,7 +1534,21 @@ export declare const provideLayer: {
  * @category context
  */
 export declare const mapInputContext: {
+    /**
+     * Transforms the context being provided to the channel with the specified
+     * function.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <Env0, Env>(f: (env: Context.Context<Env0>) => Context.Context<Env>): <OutElem, InElem, OutErr, InErr, OutDone, InDone>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env0>;
+    /**
+     * Transforms the context being provided to the channel with the specified
+     * function.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, Env0>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, f: (env: Context.Context<Env0>) => Context.Context<Env>): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env0>;
 };
 /**
@@ -909,7 +1559,21 @@ export declare const mapInputContext: {
  * @category context
  */
 export declare const provideSomeLayer: {
+    /**
+     * Splits the context into two parts, providing one part using the
+     * specified layer and leaving the remainder `Env0`.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <R2, OutErr2, Env0>(layer: Layer.Layer<R2, OutErr2, Env0>): <OutElem, InElem, OutErr, InErr, OutDone, InDone, R>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, R>) => Channel<OutElem, InElem, OutErr2 | OutErr, InErr, OutDone, InDone, Env0 | Exclude<R, R2>>;
+    /**
+     * Splits the context into two parts, providing one part using the
+     * specified layer and leaving the remainder `Env0`.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, R, R2, OutErr2, Env0>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, R>, layer: Layer.Layer<R2, OutErr2, Env0>): Channel<OutElem, InElem, OutErr | OutErr2, InErr, OutDone, InDone, Env0 | Exclude<R, R2>>;
 };
 /**
@@ -920,7 +1584,21 @@ export declare const provideSomeLayer: {
  * @category context
  */
 export declare const provideService: {
+    /**
+     * Provides the effect with the single service it requires. If the effect
+     * requires more than one service use `provideContext` instead.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <T extends Context.Tag<any, any>>(tag: T, service: Context.Tag.Service<T>): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Exclude<Env, Context.Tag.Identifier<T>>>;
+    /**
+     * Provides the effect with the single service it requires. If the effect
+     * requires more than one service use `provideContext` instead.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, T extends Context.Tag<any, any>>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, tag: T, service: Context.Tag.Service<T>): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Exclude<Env, Context.Tag.Identifier<T>>>;
 };
 /**
@@ -1083,7 +1761,19 @@ export declare const unwrapScoped: <OutElem, InElem, OutErr, InErr, OutDone, InD
  * @category context
  */
 export declare const updateService: {
+    /**
+     * Updates a service in the context of this channel.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <T extends Context.Tag<any, any>>(tag: T, f: (resource: Context.Tag.Service<T>) => Context.Tag.Service<T>): <OutElem, OutErr, InErr, OutDone, InDone, R>(self: Channel<OutElem, unknown, OutErr, InErr, OutDone, InDone, R>) => Channel<OutElem, unknown, OutErr, InErr, OutDone, InDone, T | R>;
+    /**
+     * Updates a service in the context of this channel.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <OutElem, OutErr, InErr, OutDone, InDone, R, T extends Context.Tag<any, any>>(self: Channel<OutElem, unknown, OutErr, InErr, OutDone, InDone, R>, tag: T, f: (resource: Context.Tag.Service<T>) => Context.Tag.Service<T>): Channel<OutElem, unknown, OutErr, InErr, OutDone, InDone, R | T>;
 };
 /**
@@ -1093,7 +1783,19 @@ export declare const updateService: {
  * @category tracing
  */
 export declare const withSpan: {
+    /**
+     * Wraps the channel with a new span for tracing.
+     *
+     * @since 2.0.0
+     * @category tracing
+     */
     (name: string, options?: Tracer.SpanOptions | undefined): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Exclude<Env, Tracer.ParentSpan>>;
+    /**
+     * Wraps the channel with a new span for tracing.
+     *
+     * @since 2.0.0
+     * @category tracing
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, name: string, options?: Tracer.SpanOptions | undefined): Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Exclude<Env, Tracer.ParentSpan>>;
 };
 /**
@@ -1126,9 +1828,25 @@ export declare const writeChunk: <OutElem>(outs: Chunk.Chunk<OutElem>) => Channe
  * @category zipping
  */
 export declare const zip: {
+    /**
+     * Returns a new channel that is the sequential composition of this channel
+     * and the specified channel. The returned channel terminates with a tuple of
+     * the terminal values of both channels.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(that: Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>, options?: {
         readonly concurrent?: boolean | undefined;
     } | undefined): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem, InElem & InElem1, OutErr1 | OutErr, InErr & InErr1, readonly [OutDone, OutDone1], InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel that is the sequential composition of this channel
+     * and the specified channel. The returned channel terminates with a tuple of
+     * the terminal values of both channels.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, that: Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>, options?: {
         readonly concurrent?: boolean | undefined;
     } | undefined): Channel<OutElem | OutElem1, InElem & InElem1, OutErr | OutErr1, InErr & InErr1, readonly [OutDone, OutDone1], InDone & InDone1, Env | Env1>;
@@ -1142,9 +1860,25 @@ export declare const zip: {
  * @category zipping
  */
 export declare const zipLeft: {
+    /**
+     * Returns a new channel that is the sequential composition of this channel
+     * and the specified channel. The returned channel terminates with the
+     * terminal value of this channel.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(that: Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>, options?: {
         readonly concurrent?: boolean | undefined;
     } | undefined): <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem, InElem & InElem1, OutErr1 | OutErr, InErr & InErr1, OutDone, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel that is the sequential composition of this channel
+     * and the specified channel. The returned channel terminates with the
+     * terminal value of this channel.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <OutElem, InElem, OutErr, InErr, OutDone, InDone, Env, OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, that: Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>, options?: {
         readonly concurrent?: boolean | undefined;
     } | undefined): Channel<OutElem | OutElem1, InElem & InElem1, OutErr | OutErr1, InErr & InErr1, OutDone, InDone & InDone1, Env | Env1>;
@@ -1158,9 +1892,25 @@ export declare const zipLeft: {
  * @category zipping
  */
 export declare const zipRight: {
+    /**
+     * Returns a new channel that is the sequential composition of this channel
+     * and the specified channel. The returned channel terminates with the
+     * terminal value of that channel.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone1>(that: Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>, options?: {
         readonly concurrent?: boolean | undefined;
     }): <Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>) => Channel<OutElem1 | OutElem, InElem & InElem1, OutErr1 | OutErr, InErr & InErr1, OutDone1, InDone & InDone1, Env1 | Env>;
+    /**
+     * Returns a new channel that is the sequential composition of this channel
+     * and the specified channel. The returned channel terminates with the
+     * terminal value of that channel.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <Env, InErr, InElem, InDone, OutErr, OutElem, OutDone, Env1, InErr1, InElem1, InDone1, OutErr1, OutElem1, OutDone1>(self: Channel<OutElem, InElem, OutErr, InErr, OutDone, InDone, Env>, that: Channel<OutElem1, InElem1, OutErr1, InErr1, OutDone1, InDone1, Env1>, options?: {
         readonly concurrent?: boolean | undefined;
     }): Channel<OutElem | OutElem1, InElem & InElem1, OutErr | OutErr1, InErr & InErr1, OutDone1, InDone & InDone1, Env | Env1>;