effect 4.0.0-beta.72 → 4.0.0-beta.74

package/dist/Effect.d.ts

@@ -1218,7 +1218,7 @@ export declare const whileLoop: <A, E, R>(options: {
  * ```
  *
  * @see {@link tryPromise} for a version that can handle failures.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const promise: <A>(evaluate: (signal: AbortSignal) => PromiseLike<A>) => Effect<A>;
@@ -1284,7 +1284,7 @@ export declare const promise: <A>(evaluate: (signal: AbortSignal) => PromiseLike
  * ```
  *
  * @see {@link promise} if the effectful computation is asynchronous and does not throw errors.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const tryPromise: <A, E = Cause.UnknownError>(options: {
@@ -1312,7 +1312,7 @@ export declare const tryPromise: <A, E = Cause.UnknownError>(options: {
  * ```
  *
  * @see {@link fail} to create an effect that represents a failure.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const succeed: <A>(value: A) => Effect<A>;
@@ -1330,7 +1330,7 @@ export declare const succeed: <A>(value: A) => Effect<A>;
  * // Output: { _id: 'Option', _tag: 'None' }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const succeedNone: Effect<Option<never>>;
@@ -1348,7 +1348,7 @@ export declare const succeedNone: Effect<Option<never>>;
  * // Output: { _id: 'Option', _tag: 'Some', value: 42 }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const succeedSome: <A>(value: A) => Effect<Option<A>>;
@@ -1435,7 +1435,7 @@ export declare const succeedSome: <A>(value: A) => Effect<Option<A>>;
  *   )
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const suspend: <A, E, R>(effect: LazyArg<Effect<A, E, R>>) => Effect<A, E, R>;
@@ -1471,7 +1471,7 @@ export declare const suspend: <A, E, R>(effect: LazyArg<Effect<A, E, R>>) => Eff
  * ```
  *
  * @see {@link try_ | try} for a version that can handle failures.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const sync: <A>(thunk: LazyArg<A>) => Effect<A>;
@@ -1480,7 +1480,7 @@ export {
 /**
  * Returns an effect that succeeds with `void`.
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 void_ as void };
@@ -1489,7 +1489,7 @@ export {
 /**
  * Returns an effect that succeeds with `undefined`.
  *
- * @category creating effects
+ * @category constructors
  * @since 4.0.0
  */
 undefined_ as undefined };
@@ -1525,7 +1525,7 @@ undefined_ as undefined };
  * const program = delay(1000)
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 4.0.0
  */
 export declare const callback: <A, E = never, R = never>(register: (this: Scheduler, resume: (effect: Effect<A, E, R>) => void, signal: AbortSignal) => void | Effect<void, never, R>) => Effect<A, E, R>;
@@ -1548,7 +1548,7 @@ export declare const callback: <A, E = never, R = never>(register: (this: Schedu
  * const timedProgram = Effect.timeout(program, "1 second")
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const never: Effect<never>;
@@ -1787,7 +1787,7 @@ export declare const bind: {
  * })
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const gen: {
@@ -1839,7 +1839,7 @@ export declare const gen: {
      * })
      * ```
      *
-     * @category creating effects
+     * @category constructors
      * @since 2.0.0
      */
     <Eff extends Effect<any, any, any>, AEff>(f: () => Generator<Eff, AEff, never>): Effect<AEff, [
@@ -1895,7 +1895,7 @@ export declare const gen: {
      * })
      * ```
      *
-     * @category creating effects
+     * @category constructors
      * @since 2.0.0
      */
     <Self, Eff extends Effect<any, any, any>, AEff>(options: {
@@ -1915,7 +1915,7 @@ export declare namespace gen {
     /**
      * Generator return type accepted by `Effect.gen`.
      *
-     * @category creating effects
+     * @category constructors
      * @since 4.0.0
      */
     type Return<A, E = never, R = never> = Generator<Effect<any, E, R>, A, any>;
@@ -1944,7 +1944,7 @@ export declare namespace gen {
  * ```
  *
  * @see {@link succeed} to create an effect that represents a successful value.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const fail: <E>(error: E) => Effect<never, E>;
@@ -1972,7 +1972,7 @@ export declare const fail: <E>(error: E) => Effect<never, E>;
  * // Output: { _id: 'Exit', _tag: 'Failure', cause: ... }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const failSync: <E>(evaluate: LazyArg<E>) => Effect<never, E>;
@@ -1997,7 +1997,7 @@ export declare const failSync: <E>(evaluate: LazyArg<E>) => Effect<never, E>;
  * // Output: { _id: 'Exit', _tag: 'Failure', cause: ... }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const failCause: <E>(cause: Cause.Cause<E>) => Effect<never, E>;
@@ -2025,7 +2025,7 @@ export declare const failCause: <E>(cause: Cause.Cause<E>) => Effect<never, E>;
  * // Output: { _id: 'Exit', _tag: 'Failure', cause: ... }
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const failCauseSync: <E>(evaluate: LazyArg<Cause.Cause<E>>) => Effect<never, E>;
@@ -2066,7 +2066,7 @@ export declare const failCauseSync: <E>(evaluate: LazyArg<Cause.Cause<E>>) => Ef
  * //   ...stack trace...
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const die: (defect: unknown) => Effect<never>;
@@ -2136,7 +2136,7 @@ export {
  *
  * @see {@link sync} if the effectful computation is synchronous and does not
  * throw errors.
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 try_ as try };
@@ -2157,7 +2157,7 @@ try_ as try };
  * Effect.runPromise(program)
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 2.0.0
  */
 export declare const yieldNow: Effect<void>;
@@ -2178,7 +2178,7 @@ export declare const yieldNow: Effect<void>;
  * Effect.runPromise(program)
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 4.0.0
  */
 export declare const yieldNowWith: (priority?: number) => Effect<void>;
@@ -2198,7 +2198,7 @@ export declare const yieldNowWith: (priority?: number) => Effect<void>;
  * // Output: Fiber ID: 1
  * ```
  *
- * @category creating effects
+ * @category constructors
  * @since 4.0.0
  */
 export declare const withFiber: <A, E = never, R = never>(evaluate: (fiber: Fiber<unknown, unknown>) => Effect<A, E, R>) => Effect<A, E, R>;
@@ -6405,7 +6405,7 @@ export declare const tapDefect: {
  * // Ready
  * ```
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export declare const eventually: <A, E, R>(self: Effect<A, E, R>) => Effect<A, never, R>;
@@ -13324,7 +13324,7 @@ export declare namespace Repeat {
     /**
      * Computes the result type of `Effect.repeat` from the original effect and repeat options.
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     type Return<R, E, A, O extends Options<A>> = Effect<O extends {
@@ -13347,7 +13347,7 @@ export declare namespace Repeat {
     /**
      * Options that control whether and how an effect is repeated.
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     interface Options<A> {
@@ -13384,7 +13384,7 @@ export declare namespace Repeat {
  * })
  * ```
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export declare const forever: <Arg extends Effect<any, any, any> | {
@@ -13467,7 +13467,7 @@ export declare const forever: <Arg extends Effect<any, any, any> | {
  * @see {@link retry} for failure-based repetition
  * @see {@link repeatOrElse} for fallback handling when repetition fails
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export declare const repeat: {
@@ -13544,7 +13544,7 @@ export declare const repeat: {
      * @see {@link retry} for failure-based repetition
      * @see {@link repeatOrElse} for fallback handling when repetition fails
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <O extends Repeat.Options<A>, A>(options: O): <E, R>(self: Effect<A, E, R>) => Repeat.Return<R, E, A, O>;
@@ -13621,7 +13621,7 @@ export declare const repeat: {
      * @see {@link retry} for failure-based repetition
      * @see {@link repeatOrElse} for fallback handling when repetition fails
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <Output, Input, Error, Env>(schedule: Schedule<Output, NoInfer<Input>, Error, Env>): <E, R>(self: Effect<Input, E, R>) => Effect<Output, E | Error, R | Env>;
@@ -13698,7 +13698,7 @@ export declare const repeat: {
      * @see {@link retry} for failure-based repetition
      * @see {@link repeatOrElse} for fallback handling when repetition fails
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <Output, Input, Error, Env>(builder: ($: <O, E, R>(_: Schedule<O, NoInfer<Input>, E, R>) => Schedule<O, Input, E, R>) => Schedule<Output, NoInfer<Input>, Error, Env>): <E, R>(self: Effect<Input, E, R>) => Effect<Output, E | Error, R | Env>;
@@ -13775,7 +13775,7 @@ export declare const repeat: {
      * @see {@link retry} for failure-based repetition
      * @see {@link repeatOrElse} for fallback handling when repetition fails
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <A, E, R, O extends Repeat.Options<A>>(self: Effect<A, E, R>, options: O): Repeat.Return<R, E, A, O>;
@@ -13852,7 +13852,7 @@ export declare const repeat: {
      * @see {@link retry} for failure-based repetition
      * @see {@link repeatOrElse} for fallback handling when repetition fails
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <Input, E, R, Output, Error, Env>(self: Effect<Input, E, R>, schedule: Schedule<Output, NoInfer<Input>, Error, Env>): Effect<Output, E | Error, R | Env>;
@@ -13929,7 +13929,7 @@ export declare const repeat: {
      * @see {@link retry} for failure-based repetition
      * @see {@link repeatOrElse} for fallback handling when repetition fails
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <Input, E, R, Output, Error, Env>(self: Effect<Input, E, R>, builder: ($: <O, E, R>(_: Schedule<O, NoInfer<Input>, E, R>) => Schedule<O, Input, E, R>) => Schedule<Output, NoInfer<Input>, Error, Env>): Effect<Output, E | Error, R | Env>;
@@ -13973,7 +13973,7 @@ export declare const repeat: {
  * )
  * ```
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export declare const repeatOrElse: {
@@ -14016,7 +14016,7 @@ export declare const repeatOrElse: {
      * )
      * ```
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <R2, A, B, E, E2, E3, R3>(schedule: Schedule<B, A, E2, R2>, orElse: (error: E | E2, option: Option<B>) => Effect<B, E3, R3>): <R>(self: Effect<A, E, R>) => Effect<B, E3, R | R2 | R3>;
@@ -14059,7 +14059,7 @@ export declare const repeatOrElse: {
      * )
      * ```
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <A, E, R, R2, B, E2, E3, R3>(self: Effect<A, E, R>, schedule: Schedule<B, A, E2, R2>, orElse: (error: E | E2, option: Option<B>) => Effect<B, E3, R3>): Effect<B, E3, R | R2 | R3>;
@@ -14292,7 +14292,7 @@ export declare const replicateEffect: {
  * @see {@link scheduleFrom} for a variant that allows the schedule's decision
  * to depend on the result of this effect.
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export declare const schedule: {
@@ -14340,7 +14340,7 @@ export declare const schedule: {
      * @see {@link scheduleFrom} for a variant that allows the schedule's decision
      * to depend on the result of this effect.
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <Output, Error, Env>(schedule: Schedule<Output, unknown, Error, Env>): <A, E, R>(self: Effect<A, E, R>) => Effect<Output, E, R | Env>;
@@ -14388,7 +14388,7 @@ export declare const schedule: {
      * @see {@link scheduleFrom} for a variant that allows the schedule's decision
      * to depend on the result of this effect.
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <A, E, R, Output, Error, Env>(self: Effect<A, E, R>, schedule: Schedule<Output, unknown, Error, Env>): Effect<Output, E, R | Env>;
@@ -14427,7 +14427,7 @@ export declare const schedule: {
  * // Returns the schedule count
  * ```
  *
- * @category repetition / recursion
+ * @category repetition
  * @since 2.0.0
  */
 export declare const scheduleFrom: {
@@ -14465,7 +14465,7 @@ export declare const scheduleFrom: {
      * // Returns the schedule count
      * ```
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <Input, Output, Error, Env>(initial: Input, schedule: Schedule<Output, Input, Error, Env>): <E, R>(self: Effect<Input, E, R>) => Effect<Output, E, R | Env>;
@@ -14503,7 +14503,7 @@ export declare const scheduleFrom: {
      * // Returns the schedule count
      * ```
      *
-     * @category repetition / recursion
+     * @category repetition
      * @since 2.0.0
      */
     <Input, E, R, Output, Error, Env>(self: Effect<Input, E, R>, initial: Input, schedule: Schedule<Output, Input, Error, Env>): Effect<Output, E, R | Env>;
@@ -16029,7 +16029,7 @@ export declare const fiberId: Effect<number>;
  * @see {@link runPromise} for promise-based running with these options
  * @see {@link runPromiseExit} for promise-based running that returns an `Exit`
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export interface RunOptions {
@@ -16069,7 +16069,7 @@ export interface RunOptions {
  * }, 500)
  * ```
  *
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export declare const runFork: <A, E>(effect: Effect<A, E, never>, options?: RunOptions | undefined) => Fiber<A, E>;
@@ -16100,7 +16100,7 @@ export declare const runFork: <A, E>(effect: Effect<A, E, never>, options?: RunO
  * const fiber = Effect.runForkWith(services)(program)
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export declare const runForkWith: <R>(context: Context.Context<R>) => <A, E>(effect: Effect<A, E, R>, options?: RunOptions | undefined) => Fiber<A, E>;
@@ -16144,7 +16144,7 @@ export declare const runForkWith: <R>(context: Context.Context<R>) => <A, E>(eff
  * interrupt()
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export declare const runCallbackWith: <R>(context: Context.Context<R>) => <A, E>(effect: Effect<A, E, R>, options?: (RunOptions & {
@@ -16187,7 +16187,7 @@ export declare const runCallbackWith: <R>(context: Context.Context<R>) => <A, E>
  * // interrupt() to cancel the fiber if needed
  * ```
  *
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export declare const runCallback: <A, E>(effect: Effect<A, E, never>, options?: (RunOptions & {
@@ -16226,7 +16226,7 @@ export declare const runCallback: <A, E>(effect: Effect<A, E, never>, options?:
  * ```
  *
  * @see {@link runPromiseExit} for a version that returns an `Exit` type instead of rejecting.
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export declare const runPromise: <A, E>(effect: Effect<A, E>, options?: RunOptions | undefined) => Promise<A>;
@@ -16256,7 +16256,7 @@ export declare const runPromise: <A, E>(effect: Effect<A, E>, options?: RunOptio
  * Effect.runPromiseWith(context)(program).then(console.log)
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export declare const runPromiseWith: <R>(context: Context.Context<R>) => <A, E>(effect: Effect<A, E, R>, options?: RunOptions | undefined) => Promise<A>;
@@ -16306,7 +16306,7 @@ export declare const runPromiseWith: <R>(context: Context.Context<R>) => <A, E>(
  *
  * @see {@link runPromise} for a version that rejects on failure.
  *
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export declare const runPromiseExit: <A, E>(effect: Effect<A, E>, options?: RunOptions | undefined) => Promise<Exit.Exit<A, E>>;
@@ -16340,7 +16340,7 @@ export declare const runPromiseExit: <A, E>(effect: Effect<A, E>, options?: RunO
  * })
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export declare const runPromiseExitWith: <R>(context: Context.Context<R>) => <A, E>(effect: Effect<A, E, R>, options?: RunOptions | undefined) => Promise<Exit.Exit<A, E>>;
@@ -16401,7 +16401,7 @@ export declare const runPromiseExitWith: <R>(context: Context.Context<R>) => <A,
  *
  * @see {@link runSyncExit} for a version that returns an `Exit` type instead of
  * throwing an error.
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export declare const runSync: <A, E>(effect: Effect<A, E>) => A;
@@ -16432,7 +16432,7 @@ export declare const runSync: <A, E>(effect: Effect<A, E>) => A;
  * console.log(result) // 5
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export declare const runSyncWith: <R>(context: Context.Context<R>) => <A, E>(effect: Effect<A, E, R>) => A;
@@ -16506,7 +16506,7 @@ export declare const runSyncWith: <R>(context: Context.Context<R>) => <A, E>(eff
  *
  * @see {@link runSync} for a version that throws on failure.
  *
- * @category running effects
+ * @category running
  * @since 2.0.0
  */
 export declare const runSyncExit: <A, E>(effect: Effect<A, E>) => Exit.Exit<A, E>;
@@ -16546,7 +16546,7 @@ export declare const runSyncExit: <A, E>(effect: Effect<A, E>) => Exit.Exit<A, E
  * // Success: 42
  * ```
  *
- * @category running effects
+ * @category running
  * @since 4.0.0
  */
 export declare const runSyncExitWith: <R>(context: Context.Context<R>) => <A, E>(effect: Effect<A, E, R>) => Exit.Exit<A, E>;
@@ -19230,7 +19230,7 @@ export declare namespace Effectify {
     /**
      * Extracts the callback error type from a callback-based function type.
      *
-     * @category utils
+     * @category effectify
      * @since 4.0.0
      */
     type EffectifyError<T> = T extends {