effect 4.0.0-beta.73 → 4.0.0-beta.74

package/src/Channel.ts

@@ -3521,7 +3521,7 @@ export const flatten = <
  * // Outputs: 1, 2, 3, 4, 5, 6, 7, 8, 9
  * ```
  *
- * @category utils
+ * @category transforming
  * @since 4.0.0
  */
 export const flattenArray = <
@@ -3572,7 +3572,7 @@ export const flattenArray = <
  * Output `Take` values are emitted as non-empty arrays. Failed `Take` values
  * fail the returned channel. Done `Take` values complete the returned channel.
  *
- * @category utils
+ * @category transforming
  * @since 4.0.0
  */
 export const flattenTake = <
@@ -3636,14 +3636,14 @@ export const drain = <
 /**
  * Repeats this channel according to the provided schedule.
  *
- * @category utils
+ * @category repetition
  * @since 4.0.0
  */
 export const repeat: {
   /**
    * Repeats this channel according to the provided schedule.
    *
-   * @category utils
+   * @category repetition
    * @since 4.0.0
    */
   <SO, OutDone, SE, SR>(
@@ -3658,7 +3658,7 @@ export const repeat: {
   /**
    * Repeats this channel according to the provided schedule.
    *
-   * @category utils
+   * @category repetition
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, SO, SE, SR>(
@@ -3708,7 +3708,7 @@ export const repeat: {
 /**
  * Repeats this channel forever.
  *
- * @category utils
+ * @category repetition
  * @since 4.0.0
  */
 export const forever = <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -3726,7 +3726,7 @@ export const forever = <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(
  * fails. If the schedule finishes, the returned channel completes with the
  * schedule output.
  *
- * @category utils
+ * @category sequencing
  * @since 4.0.0
  */
 export const schedule: {
@@ -3741,7 +3741,7 @@ export const schedule: {
    * fails. If the schedule finishes, the returned channel completes with the
    * schedule output.
    *
-   * @category utils
+   * @category sequencing
    * @since 4.0.0
    */
   <SO, OutElem, SE, SR>(schedule: Schedule.Schedule<SO, Types.NoInfer<OutElem>, SE, SR>): <OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -3758,7 +3758,7 @@ export const schedule: {
    * fails. If the schedule finishes, the returned channel completes with the
    * schedule output.
    *
-   * @category utils
+   * @category sequencing
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, SO, SE, SR>(
@@ -7495,7 +7495,7 @@ export const ignoreCause: <
  * Returns a new channel that retries this channel according to the specified
  * schedule whenever it fails.
  *
- * @category utils
+ * @category error handling
  * @since 4.0.0
  */
 export const retry: {
@@ -7503,7 +7503,7 @@ export const retry: {
    * Returns a new channel that retries this channel according to the specified
    * schedule whenever it fails.
    *
-   * @category utils
+   * @category error handling
    * @since 4.0.0
    */
   <SO, OutErr, SE, SR>(
@@ -7521,7 +7521,7 @@ export const retry: {
    * Returns a new channel that retries this channel according to the specified
    * schedule whenever it fails.
    *
-   * @category utils
+   * @category error handling
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, SO, SE, SR>(
@@ -7798,7 +7798,7 @@ export const switchMap: {
  * // Outputs: 1, 2, 3, 4, 5, 6 (order may vary due to concurrency)
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const mergeAll: {
@@ -7830,7 +7830,7 @@ export const mergeAll: {
    * // Outputs: 1, 2, 3, 4, 5, 6 (order may vary due to concurrency)
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   (
@@ -7886,7 +7886,7 @@ export const mergeAll: {
    * // Outputs: 1, 2, 3, 4, 5, 6 (order may vary due to concurrency)
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <OutElem, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1, OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -7976,7 +7976,7 @@ export const mergeAll: {
          * // Outputs: 1, 2, 3, 4, 5, 6 (order may vary due to concurrency)
          * ```
          *
-         * @category utils
+         * @category combining
          * @since 2.0.0
          */
         OutElem, /**
@@ -8007,7 +8007,7 @@ export const mergeAll: {
          * // Outputs: 1, 2, 3, 4, 5, 6 (order may vary due to concurrency)
          * ```
          *
-         * @category utils
+         * @category combining
          * @since 2.0.0
          */
         OutErr | OutErr1 | Cause.Done<OutDone>>(
@@ -8110,7 +8110,7 @@ export type HaltStrategy = "left" | "right" | "both" | "either"
  * // Order may vary: 1, "a", 2, "b", 3, "c"
  * ```
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export const merge: {
@@ -8140,7 +8140,7 @@ export const merge: {
    * // Order may vary: 1, "a", 2, "b", 3, "c"
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 4.0.0
    */
   <OutElem1, OutErr1, OutDone1, InElem1, InErr1, InDone1, Env1>(
@@ -8185,7 +8185,7 @@ export const merge: {
    * // Order may vary: 1, "a", 2, "b", 3, "c"
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 4.0.0
    */
   <
@@ -8276,7 +8276,7 @@ export const merge: {
      * // Order may vary: 1, "a", 2, "b", 3, "c"
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 4.0.0
      */
     OutElem | OutElem1, /**
@@ -8305,7 +8305,7 @@ export const merge: {
      * // Order may vary: 1, "a", 2, "b", 3, "c"
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 4.0.0
      */
     OutErr | OutErr1 | Cause.Done<OutDone | OutDone1>>(0)
@@ -8374,7 +8374,7 @@ export const merge: {
  * The effect's successful value is ignored. If the effect fails while the
  * channel is running, the returned channel fails with that error.
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export const mergeEffect: {
@@ -8387,7 +8387,7 @@ export const mergeEffect: {
    * The effect's successful value is ignored. If the effect fails while the
    * channel is running, the returned channel fails with that error.
    *
-   * @category utils
+   * @category combining
    * @since 4.0.0
    */
   <X, E, R>(effect: Effect.Effect<X, E, R>): <OutElem, OutDone, OutErr, InElem, InErr, InDone, Env>(
@@ -8402,7 +8402,7 @@ export const mergeEffect: {
    * The effect's successful value is ignored. If the effect fails while the
    * channel is running, the returned channel fails with that error.
    *
-   * @category utils
+   * @category combining
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, X, E, R>(
@@ -8628,7 +8628,7 @@ export const encodeText = <Err, Done>(): Channel<
  * // Outputs: 2, 4, 6
  * ```
  *
- * @category utils
+ * @category sequencing
  * @since 2.0.0
  */
 export const pipeTo: {
@@ -8657,7 +8657,7 @@ export const pipeTo: {
    * // Outputs: 2, 4, 6
    * ```
    *
-   * @category utils
+   * @category sequencing
    * @since 2.0.0
    */
   <OutElem2, OutErr2, OutDone2, OutElem, OutErr, OutDone, Env2>(that: Channel<OutElem2, OutErr2, OutDone2, OutElem, OutErr, OutDone, Env2>): <InElem, InErr, InDone, Env>(
@@ -8688,7 +8688,7 @@ export const pipeTo: {
    * // Outputs: 2, 4, 6
    * ```
    *
-   * @category utils
+   * @category sequencing
    * @since 2.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem2, OutErr2, OutDone2, Env2>(
@@ -8730,7 +8730,7 @@ export const pipeTo: {
  * // Source errors are preserved and not sent to transform channel
  * ```
  *
- * @category utils
+ * @category sequencing
  * @since 2.0.0
  */
 export const pipeToOrFail: {
@@ -8758,7 +8758,7 @@ export const pipeToOrFail: {
    * // Source errors are preserved and not sent to transform channel
    * ```
    *
-   * @category utils
+   * @category sequencing
    * @since 2.0.0
    */
   <OutElem2, OutErr2, OutDone2, OutElem, OutDone, Env2>(that: Channel<OutElem2, OutErr2, OutDone2, OutElem, never, OutDone, Env2>): <OutErr, InElem, InErr, InDone, Env>(
@@ -8788,7 +8788,7 @@ export const pipeToOrFail: {
    * // Source errors are preserved and not sent to transform channel
    * ```
    *
-   * @category utils
+   * @category sequencing
    * @since 2.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutElem2, OutErr2, OutDone2, Env2>(
@@ -8867,7 +8867,7 @@ export const unwrap = <OutElem, OutErr, OutDone, InElem, InErr, InDone, R2, E, R
  * Runs a channel with a scope provided for the duration of the channel
  * execution, removing the channel's `Scope` requirement.
  *
- * @category utils
+ * @category resource management
  * @since 2.0.0
  */
 export const scoped = <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -8911,7 +8911,7 @@ export const scoped = <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(
  * )
  * ```
  *
- * @category utils
+ * @category sequencing
  * @since 2.0.0
  */
 export const embedInput: {
@@ -8946,7 +8946,7 @@ export const embedInput: {
    * )
    * ```
    *
-   * @category utils
+   * @category sequencing
    * @since 2.0.0
    */
   <InElem, InErr, InDone, R>(
@@ -8987,7 +8987,7 @@ export const embedInput: {
    * )
    * ```
    *
-   * @category utils
+   * @category sequencing
    * @since 2.0.0
    */
   <OutElem, OutErr, OutDone, Env, InErr, InElem, InDone, R>(
@@ -9314,7 +9314,7 @@ export const bufferArray: {
  * channel's done value. If the channel completes first, the original channel's
  * done value is preserved.
  *
- * @category utils
+ * @category interruption
  * @since 2.0.0
  */
 export const interruptWhen: {
@@ -9332,7 +9332,7 @@ export const interruptWhen: {
    * channel's done value. If the channel completes first, the original channel's
    * done value is preserved.
    *
-   * @category utils
+   * @category interruption
    * @since 2.0.0
    */
   <OutDone2, OutErr2, Env2>(effect: Effect.Effect<OutDone2, OutErr2, Env2>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -9352,7 +9352,7 @@ export const interruptWhen: {
    * channel's done value. If the channel completes first, the original channel's
    * done value is preserved.
    *
-   * @category utils
+   * @category interruption
    * @since 2.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutDone2, OutErr2, Env2>(
@@ -9379,7 +9379,7 @@ export const interruptWhen: {
  * fails with that error. If the channel completes first, the channel's done
  * value is preserved.
  *
- * @category utils
+ * @category interruption
  * @since 4.0.0
  */
 export const haltWhen: {
@@ -9393,7 +9393,7 @@ export const haltWhen: {
    * fails with that error. If the channel completes first, the channel's done
    * value is preserved.
    *
-   * @category utils
+   * @category interruption
    * @since 4.0.0
    */
   <OutDone2, OutErr2, Env2>(effect: Effect.Effect<OutDone2, OutErr2, Env2>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -9409,7 +9409,7 @@ export const haltWhen: {
    * fails with that error. If the channel completes first, the channel's done
    * value is preserved.
    *
-   * @category utils
+   * @category interruption
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, OutDone2, OutErr2, Env2>(
@@ -9443,7 +9443,7 @@ export const haltWhen: {
  * The finalizer receives the failure `Cause`. The original channel failure is
  * preserved. The finalizer itself must not fail.
  *
- * @category utils
+ * @category error handling
  * @since 4.0.0
  */
 export const onError: {
@@ -9455,7 +9455,7 @@ export const onError: {
    * The finalizer receives the failure `Cause`. The original channel failure is
    * preserved. The finalizer itself must not fail.
    *
-   * @category utils
+   * @category error handling
    * @since 4.0.0
    */
   <OutDone, OutErr, Env2>(
@@ -9471,7 +9471,7 @@ export const onError: {
    * The finalizer receives the failure `Cause`. The original channel failure is
    * preserved. The finalizer itself must not fail.
    *
-   * @category utils
+   * @category error handling
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, Env2>(
@@ -9510,7 +9510,7 @@ export const onError: {
  * })
  * ```
  *
- * @category utils
+ * @category resource management
  * @since 4.0.0
  */
 export const onExit: {
@@ -9540,7 +9540,7 @@ export const onExit: {
    * })
    * ```
    *
-   * @category utils
+   * @category resource management
    * @since 4.0.0
    */
   <OutDone, OutErr, Env2>(
@@ -9574,7 +9574,7 @@ export const onExit: {
    * })
    * ```
    *
-   * @category utils
+   * @category resource management
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, Env2>(
@@ -9599,7 +9599,7 @@ export const onExit: {
  * The effect's successful value is ignored. If the effect fails, the returned
  * channel fails before running the source channel.
  *
- * @category utils
+ * @category hooks
  * @since 4.0.0
  */
 export const onStart: {
@@ -9611,7 +9611,7 @@ export const onStart: {
    * The effect's successful value is ignored. If the effect fails, the returned
    * channel fails before running the source channel.
    *
-   * @category utils
+   * @category hooks
    * @since 4.0.0
    */
   <A, E, R>(onStart: Effect.Effect<A, E, R>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -9625,7 +9625,7 @@ export const onStart: {
    * The effect's successful value is ignored. If the effect fails, the returned
    * channel fails before running the source channel.
    *
-   * @category utils
+   * @category hooks
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, A, E, R>(
@@ -9646,7 +9646,7 @@ export const onStart: {
  * emitted unchanged. The effect is not run if the channel completes without
  * emitting an element.
  *
- * @category utils
+ * @category hooks
  * @since 4.0.0
  */
 export const onFirst: {
@@ -9659,7 +9659,7 @@ export const onFirst: {
    * emitted unchanged. The effect is not run if the channel completes without
    * emitting an element.
    *
-   * @category utils
+   * @category hooks
    * @since 4.0.0
    */
   <OutElem, A, E, R>(onFirst: (element: Types.NoInfer<OutElem>) => Effect.Effect<A, E, R>): <OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -9674,7 +9674,7 @@ export const onFirst: {
    * emitted unchanged. The effect is not run if the channel completes without
    * emitting an element.
    *
-   * @category utils
+   * @category hooks
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, A, E, R>(
@@ -9704,7 +9704,7 @@ export const onFirst: {
  * not run when the channel fails. If the effect fails, the returned channel
  * fails with that error.
  *
- * @category utils
+ * @category hooks
  * @since 4.0.0
  */
 export const onEnd: {
@@ -9717,7 +9717,7 @@ export const onEnd: {
    * not run when the channel fails. If the effect fails, the returned channel
    * fails with that error.
    *
-   * @category utils
+   * @category hooks
    * @since 4.0.0
    */
   <A, E, R>(onEnd: Effect.Effect<A, E, R>): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -9732,7 +9732,7 @@ export const onEnd: {
    * not run when the channel fails. If the effect fails, the returned channel
    * fails with that error.
    *
-   * @category utils
+   * @category hooks
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, A, E, R>(
@@ -9772,7 +9772,7 @@ export const onEnd: {
  * )
  * ```
  *
- * @category utils
+ * @category resource management
  * @since 2.0.0
  */
 export const ensuring: {
@@ -9799,7 +9799,7 @@ export const ensuring: {
    * )
    * ```
    *
-   * @category utils
+   * @category resource management
    * @since 2.0.0
    */
   <Env2>(finalizer: Effect.Effect<unknown, never, Env2>): <OutElem, OutDone, OutErr, InElem, InErr, InDone, Env>(
@@ -9828,7 +9828,7 @@ export const ensuring: {
    * )
    * ```
    *
-   * @category utils
+   * @category resource management
    * @since 2.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, Env2>(
@@ -10283,7 +10283,7 @@ const withSpanImpl = <OutElem, OutErr, OutDone, InElem, InErr, InDone, R>(
 /**
  * The starting channel for Do notation, emitting an empty object.
  *
- * @category Do notation
+ * @category do notation
  * @since 4.0.0
  */
 export const Do: Channel<{}> = succeed({})
@@ -10337,7 +10337,7 @@ export {
   /**
    * Adds a computed field to each object emitted by a channel.
    *
-   * @category Do notation
+   * @category do notation
    * @since 4.0.0
    */
   let_ as let
@@ -10353,7 +10353,7 @@ export {
  * channel's output becomes the value of the new field. `options.concurrency`
  * and `options.bufferSize` control how derived channels are flattened.
  *
- * @category Do notation
+ * @category do notation
  * @since 4.0.0
  */
 export const bind: {
@@ -10367,7 +10367,7 @@ export const bind: {
    * channel's output becomes the value of the new field. `options.concurrency`
    * and `options.bufferSize` control how derived channels are flattened.
    *
-   * @category Do notation
+   * @category do notation
    * @since 4.0.0
    */
   <N extends string, OutElem extends object, B, OutErr2, OutDone2, InElem2, InErr2, InDone2, Env2>(
@@ -10398,7 +10398,7 @@ export const bind: {
    * channel's output becomes the value of the new field. `options.concurrency`
    * and `options.bufferSize` control how derived channels are flattened.
    *
-   * @category Do notation
+   * @category do notation
    * @since 4.0.0
    */
   <
@@ -10485,7 +10485,7 @@ export const bind: {
  * @see {@link bind} for adding a field produced by another channel
  * @see {@link let_ let} for adding a computed field
  *
- * @category Do notation
+ * @category do notation
  * @since 4.0.0
  */
 export const bindTo: {
@@ -10501,7 +10501,7 @@ export const bindTo: {
    * @see {@link bind} for adding a field produced by another channel
    * @see {@link let_ let} for adding a computed field
    *
-   * @category Do notation
+   * @category do notation
    * @since 4.0.0
    */
   <N extends string>(name: N): <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env>(
@@ -10527,7 +10527,7 @@ export const bindTo: {
    * @see {@link bind} for adding a field produced by another channel
    * @see {@link let_ let} for adding a computed field
    *
-   * @category Do notation
+   * @category do notation
    * @since 4.0.0
    */
   <OutElem, OutErr, OutDone, InElem, InErr, InDone, Env, N extends string>(