effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/Runtime.ts

@@ -68,10 +68,7 @@ import type * as Fiber from "./Fiber.ts"
  * runMain(program, { teardown: customTeardown })
  * ```
  *
- * @param exit - The result of the Effect program execution
- * @param onExit - Callback to execute with the determined exit code
- *
- * @category Model
+ * @category models
  * @since 4.0.0
  */
 export interface Teardown {
@@ -171,9 +168,7 @@ export const defaultTeardown: Teardown = <E, A>(
  * })
  * ```
  *
- * @param f - Function that sets up platform-specific behavior for the running Effect
- *
- * @category Run main
+ * @category running
  * @since 4.0.0
  */
 export const makeRunMain = (

package/src/Schedule.ts

@@ -93,7 +93,7 @@ const randomNext: Effect<number> = random.Random.useSync((random) => random.next
  * })
  * ```
  *
- * @category Models
+ * @category models
  * @since 2.0.0
  */
 export interface Schedule<out Output, in Input = unknown, out Error = never, out Env = never>
@@ -230,7 +230,6 @@ export const CurrentMetadata = Context.Reference<Metadata>("effect/Schedule/Curr
  * })
  * ```
  *
- * @category models
  * @since 2.0.0
  */
 export declare namespace Schedule {
@@ -262,7 +261,7 @@ export declare namespace Schedule {
    * const serviceSchedule = Schedule.spaced("5 seconds")
    * ```
    *
-   * @category Models
+   * @category models
    * @since 2.0.0
    */
   export interface Variance<out Output, in Input, out Error, out Env> {
@@ -277,8 +276,8 @@ export declare namespace Schedule {
    * This interface exists for TypeScript inference and assignability. Users
    * normally do not construct or inspect it directly.
    *
-   * @category Models
-   * @since 2.0.0
+   * @category models
+   * @since 4.0.0
    */
   export interface VarianceStruct<out Output, in Input, out Error, out Env> {
     readonly _Out: Covariant<Output>
@@ -1011,7 +1010,7 @@ export const andThen: {
  * ```
  *
  * @category sequencing
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const andThenResult: {
   /**
@@ -1053,7 +1052,7 @@ export const andThenResult: {
    * ```
    *
    * @category sequencing
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
     self: Schedule<Output, Input, Error, Env>
@@ -1097,7 +1096,7 @@ export const andThenResult: {
    * ```
    *
    * @category sequencing
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
     self: Schedule<Output, Input, Error, Env>,
@@ -1169,7 +1168,7 @@ export const andThenResult: {
          * ```
          *
          * @category sequencing
-         * @since 2.0.0
+         * @since 4.0.0
          */
         Result.Result<Output, Output2>,
         /**
@@ -1211,7 +1210,7 @@ export const andThenResult: {
          * ```
          *
          * @category sequencing
-         * @since 2.0.0
+         * @since 4.0.0
          */
         Input & Input2,
         /**
@@ -1253,7 +1252,7 @@ export const andThenResult: {
          * ```
          *
          * @category sequencing
-         * @since 2.0.0
+         * @since 4.0.0
          */
         Error | Error2,
         /**
@@ -1295,7 +1294,7 @@ export const andThenResult: {
          * ```
          *
          * @category sequencing
-         * @since 2.0.0
+         * @since 4.0.0
          */
         Env | Env2
       >(currentSide === 0 ? left : right).pipe(
@@ -1383,7 +1382,7 @@ export const andThenResult: {
  * // Compare with either which provides union semantics (OR logic)
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const both: {
@@ -1454,7 +1453,7 @@ export const both: {
    * // Compare with either which provides union semantics (OR logic)
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2, Output>(other: Schedule<Output2, Input2, Error2, Env2>): <Input, Error, Env>(
@@ -1527,7 +1526,7 @@ export const both: {
    * // Compare with either which provides union semantics (OR logic)
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -1569,7 +1568,7 @@ export const both: {
  * })
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const bothLeft: {
@@ -1602,7 +1601,7 @@ export const bothLeft: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
@@ -1637,7 +1636,7 @@ export const bothLeft: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -1680,7 +1679,7 @@ export const bothLeft: {
  * })
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const bothRight: {
@@ -1715,7 +1714,7 @@ export const bothRight: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
@@ -1752,7 +1751,7 @@ export const bothRight: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -1800,7 +1799,7 @@ export const bothRight: {
  * })
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const bothWith: {
@@ -1840,7 +1839,7 @@ export const bothWith: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2, Output, Output3>(
@@ -1885,7 +1884,7 @@ export const bothWith: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2, Output3>(
@@ -1952,8 +1951,8 @@ export const bothWith: {
  * })
  * ```
  *
- * @category utilities
- * @since 2.0.0
+ * @category utils
+ * @since 4.0.0
  */
 export const collectInputs = <Output, Input, Error, Env>(
   self: Schedule<Output, Input, Error, Env>
@@ -1988,8 +1987,8 @@ export const collectInputs = <Output, Input, Error, Env>(
  * })
  * ```
  *
- * @category utilities
- * @since 2.0.0
+ * @category utils
+ * @since 4.0.0
  */
 export const collectOutputs = <Output, Input, Error, Env>(
   self: Schedule<Output, Input, Error, Env>
@@ -2075,7 +2074,7 @@ export const collectOutputs = <Output, Input, Error, Env>(
  * })
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const collectWhile: {
@@ -2159,7 +2158,7 @@ export const collectWhile: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Input, Output, Error2 = never, Env2 = never>(
@@ -2249,7 +2248,7 @@ export const collectWhile: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Error2 = never, Env2 = never>(
@@ -2398,7 +2397,7 @@ export const collectWhile: {
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const cron: {
   /**
@@ -2530,7 +2529,7 @@ export const cron: {
    * ```
    *
    * @category constructors
-   * @since 4.0.0
+   * @since 2.0.0
    */
   (expression: Cron.Cron): Schedule<Duration.Duration, unknown, Cron.CronParseError>
   /**
@@ -2662,7 +2661,7 @@ export const cron: {
    * ```
    *
    * @category constructors
-   * @since 4.0.0
+   * @since 2.0.0
    */
   (expression: string, tz?: string | DateTime.TimeZone): Schedule<Duration.Duration, unknown, Cron.CronParseError>
 } = (expression: string | Cron.Cron, tz?: string | DateTime.TimeZone) => {
@@ -2949,7 +2948,7 @@ export const during = (duration: Duration.Input): Schedule<Duration.Duration> =>
  * // Compare with intersect which provides intersection semantics (AND logic)
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const either: {
@@ -3022,7 +3021,7 @@ export const either: {
    * // Compare with intersect which provides intersection semantics (AND logic)
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
@@ -3097,7 +3096,7 @@ export const either: {
    * // Compare with intersect which provides intersection semantics (AND logic)
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -3142,8 +3141,8 @@ export const either: {
  * })
  * ```
  *
- * @category utilities
- * @since 2.0.0
+ * @category utils
+ * @since 4.0.0
  */
 export const eitherLeft: {
   /**
@@ -3178,8 +3177,8 @@ export const eitherLeft: {
    * })
    * ```
    *
-   * @category utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 4.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
     self: Schedule<Output, Input, Error, Env>
@@ -3216,8 +3215,8 @@ export const eitherLeft: {
    * })
    * ```
    *
-   * @category utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 4.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
     self: Schedule<Output, Input, Error, Env>,
@@ -3260,8 +3259,8 @@ export const eitherLeft: {
  * })
  * ```
  *
- * @category utilities
- * @since 2.0.0
+ * @category utils
+ * @since 4.0.0
  */
 export const eitherRight: {
   /**
@@ -3296,8 +3295,8 @@ export const eitherRight: {
    * })
    * ```
    *
-   * @category utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 4.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
     self: Schedule<Output, Input, Error, Env>
@@ -3334,8 +3333,8 @@ export const eitherRight: {
    * })
    * ```
    *
-   * @category utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 4.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
     self: Schedule<Output, Input, Error, Env>,
@@ -3383,7 +3382,7 @@ export const eitherRight: {
  * })
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const eitherWith: {
@@ -3424,7 +3423,7 @@ export const eitherWith: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2, Output, Output3>(
@@ -3470,7 +3469,7 @@ export const eitherWith: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2, Output3>(
@@ -3533,7 +3532,7 @@ export const eitherWith: {
                * })
                * ```
                *
-               * @category utilities
+               * @category utils
                * @since 2.0.0
                */
               [Output3, Duration.Duration]>([
@@ -3562,8 +3561,6 @@ export const eitherWith: {
  * This schedule never stops and outputs the cumulative time that has passed since the schedule
  * started executing. Useful for tracking execution time or implementing time-based logic.
  *
- * @returns A schedule that outputs the elapsed duration and never stops
- *
  * **Example** (Measuring elapsed schedule time)
  *
  * ```ts
@@ -4063,7 +4060,7 @@ export const map: {
  * })
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const modifyDelay: {
@@ -4097,7 +4094,7 @@ export const modifyDelay: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Error2 = never, Env2 = never>(
@@ -4138,7 +4135,7 @@ export const modifyDelay: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Error2 = never, Env2 = never>(
@@ -4166,7 +4163,7 @@ export const modifyDelay: {
  *
  * Delays are jittered between `80%` and `120%` of the original delay.
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const jittered = <Output, Input, Error, Env>(
@@ -4204,7 +4201,7 @@ export const jittered = <Output, Input, Error, Env>(
  * })
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const passthrough = <Output, Input, Error, Env>(
@@ -4386,7 +4383,7 @@ export const recurs = (times: number): Schedule<number> =>
  * })
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const reduce: {
@@ -4499,7 +4496,7 @@ export const reduce: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <State, Output, Error2 = never, Env2 = never>(
@@ -4617,7 +4614,7 @@ export const reduce: {
    * })
    * ```
    *
-   * @category utilities
+   * @category utils
    * @since 2.0.0
    */
   <Output, Input, Error, Env, State, Error2 = never, Env2 = never>(
@@ -5456,8 +5453,8 @@ export const tapOutput: {
  * })
  * ```
  *
- * @category utilities
- * @since 2.0.0
+ * @category utils
+ * @since 4.0.0
  */
 export const take: {
   /**
@@ -5538,8 +5535,8 @@ export const take: {
    * })
    * ```
    *
-   * @category utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 4.0.0
    */
   (n: number): <Output, Input, Error, Env>(
     self: Schedule<Output, Input, Error, Env>
@@ -5622,8 +5619,8 @@ export const take: {
    * })
    * ```
    *
-   * @category utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 4.0.0
    */
   <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>, n: number): Schedule<Output, Input, Error, Env>
 } = dual(2, <Output, Input, Error, Env>(
@@ -5784,8 +5781,8 @@ export {
    * If the `predicate` returns `true`, the schedule will continue, otherwise
    * the schedule will stop.
    *
-   * @category utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 4.0.0
    */
   while_ as while
 }
@@ -5881,7 +5878,7 @@ export {
    * without modification. It effectively acts as a pass-through that simply
    * echoes its input values at each step.
    *
-   * @category Constructors
+   * @category constructors
    * @since 2.0.0
    */
   identity_ as identity
@@ -5911,7 +5908,7 @@ export {
  * ```
  *
  * @category ensuring types
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const satisfiesInputType = <T>() =>
 <Input extends T, Output = never, Error = never, Env = never>(
@@ -5923,7 +5920,7 @@ export const satisfiesInputType = <T>() =>
  * altering the schedule's behavior.
  *
  * @category ensuring types
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const setInputType =
   <T>() => <Output, Error, Env>(self: Schedule<Output, T, Error, Env>): Schedule<Output, T, Error, Env> => self
@@ -5947,7 +5944,7 @@ export const setInputType =
  * ```
  *
  * @category ensuring types
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const satisfiesOutputType = <T>() =>
 <Output extends T, Error = never, Input = unknown, Env = never>(
@@ -5979,7 +5976,7 @@ export const satisfiesOutputType = <T>() =>
  * ```
  *
  * @category ensuring types
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const satisfiesErrorType = <T>() =>
 <Error extends T, Output = never, Input = unknown, Env = never>(
@@ -6015,7 +6012,7 @@ export const satisfiesErrorType = <T>() =>
  * ```
  *
  * @category ensuring types
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const satisfiesServicesType = <T>() =>
 <Env extends T, Output = never, Input = unknown, Error = never>(

package/src/Scheduler.ts

@@ -67,7 +67,7 @@ export interface SchedulerDispatcher {
  * customize execution mode, task dispatching, or yield behavior.
  *
  * @category references
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const Scheduler: Context.Reference<Scheduler> = Context.Reference<Scheduler>("effect/Scheduler", {
   defaultValue: () => new MixedScheduler()
@@ -151,7 +151,7 @@ export class MixedScheduler implements Scheduler {
   /**
    * Creates a dispatcher that schedules work through this scheduler.
    *
-   * @since 2.0.0
+   * @since 4.0.0
    */
   makeDispatcher() {
     return new MixedSchedulerDispatcher(this.setImmediate)