effect 4.0.0-beta.74 → 4.0.0-beta.75

package/src/Schedule.ts

@@ -1376,9 +1376,7 @@ export const andThenResult: {
  *
  * **When to use**
  *
- * Use when the combined schedule should continue only while both
- * schedules still recur. Use `either` when either schedule should be enough to
- * continue.
+ * Use when the combined schedule should continue only while both schedules still recur.
  *
  * **Example** (Combining time and attempt limits)
  *
@@ -1455,9 +1453,7 @@ export const both: {
    *
    * **When to use**
    *
-   * Use when the combined schedule should continue only while both
-   * schedules still recur. Use `either` when either schedule should be enough to
-   * continue.
+   * Use when the combined schedule should continue only while both schedules still recur.
    *
    * **Example** (Combining time and attempt limits)
    *
@@ -1536,9 +1532,7 @@ export const both: {
    *
    * **When to use**
    *
-   * Use when the combined schedule should continue only while both
-   * schedules still recur. Use `either` when either schedule should be enough to
-   * continue.
+   * Use when the combined schedule should continue only while both schedules still recur.
    *
    * **Example** (Combining time and attempt limits)
    *
@@ -1622,6 +1616,11 @@ export const both: {
  * to recur, using the maximum of the two durations between recurrences and
  * outputting the result of the left schedule (i.e. `self`).
  *
+ * **When to use**
+ *
+ * Use when two schedules must both allow recurrence and only the left schedule's
+ * output is needed.
+ *
  * **Example** (Combining schedules and keeping the left output)
  *
  * ```ts
@@ -1655,6 +1654,11 @@ export const bothLeft: {
    * to recur, using the maximum of the two durations between recurrences and
    * outputting the result of the left schedule (i.e. `self`).
    *
+   * **When to use**
+   *
+   * Use when two schedules must both allow recurrence and only the left schedule's
+   * output is needed.
+   *
    * **Example** (Combining schedules and keeping the left output)
    *
    * ```ts
@@ -1690,6 +1694,11 @@ export const bothLeft: {
    * to recur, using the maximum of the two durations between recurrences and
    * outputting the result of the left schedule (i.e. `self`).
    *
+   * **When to use**
+   *
+   * Use when two schedules must both allow recurrence and only the left schedule's
+   * output is needed.
+   *
    * **Example** (Combining schedules and keeping the left output)
    *
    * ```ts
@@ -1731,6 +1740,11 @@ export const bothLeft: {
  * to recur, using the maximum of the two durations between recurrences and
  * outputting the result of the right schedule (i.e. `other`).
  *
+ * **When to use**
+ *
+ * Use when two schedules must both allow recurrence and only the right
+ * schedule's output is needed.
+ *
  * **Example** (Combining schedules and keeping the right output)
  *
  * ```ts
@@ -1766,6 +1780,11 @@ export const bothRight: {
    * to recur, using the maximum of the two durations between recurrences and
    * outputting the result of the right schedule (i.e. `other`).
    *
+   * **When to use**
+   *
+   * Use when two schedules must both allow recurrence and only the right
+   * schedule's output is needed.
+   *
    * **Example** (Combining schedules and keeping the right output)
    *
    * ```ts
@@ -1803,6 +1822,11 @@ export const bothRight: {
    * to recur, using the maximum of the two durations between recurrences and
    * outputting the result of the right schedule (i.e. `other`).
    *
+   * **When to use**
+   *
+   * Use when two schedules must both allow recurrence and only the right
+   * schedule's output is needed.
+   *
    * **Example** (Combining schedules and keeping the right output)
    *
    * ```ts
@@ -1847,6 +1871,11 @@ export const bothRight: {
  * outputting the result of the combination of both schedule outputs using the
  * specified `combine` function.
  *
+ * **When to use**
+ *
+ * Use when two schedules must both allow recurrence and their outputs should be
+ * combined into a custom value.
+ *
  * **Example** (Combining schedule outputs)
  *
  * ```ts
@@ -1887,6 +1916,11 @@ export const bothWith: {
    * outputting the result of the combination of both schedule outputs using the
    * specified `combine` function.
    *
+   * **When to use**
+   *
+   * Use when two schedules must both allow recurrence and their outputs should be
+   * combined into a custom value.
+   *
    * **Example** (Combining schedule outputs)
    *
    * ```ts
@@ -1932,6 +1966,11 @@ export const bothWith: {
    * outputting the result of the combination of both schedule outputs using the
    * specified `combine` function.
    *
+   * **When to use**
+   *
+   * Use when two schedules must both allow recurrence and their outputs should be
+   * combined into a custom value.
+   *
    * **Example** (Combining schedule outputs)
    *
    * ```ts
@@ -2855,8 +2894,7 @@ export const delays = <Out, In, E, R>(self: Schedule<Out, In, E, R>): Schedule<D
  *
  * **When to use**
  *
- * Use when you need one delayed recurrence. Use `during` to keep
- * recurring until a duration has elapsed.
+ * Use when you need a schedule that recurs once after a fixed delay.
  *
  * **Details**
  *
@@ -2894,8 +2932,7 @@ export const duration = (durationInput: Duration.Input): Schedule<Duration.Durat
  *
  * **When to use**
  *
- * Use to bound a repeating or retrying schedule by elapsed time. Use
- * `duration` when you need one delayed recurrence.
+ * Use to bound a repeating or retrying schedule by elapsed time.
  *
  * **Example** (Repeating work during a duration)
  *
@@ -2993,8 +3030,7 @@ export const during = (duration: Duration.Input): Schedule<Duration.Duration> =>
  *
  * **When to use**
  *
- * Use when the combined schedule should continue while at least one
- * schedule still recurs. Use `both` when both schedules must continue.
+ * Use when the combined schedule should continue while at least one schedule still recurs.
  *
  * **Example** (Combining schedules with either semantics)
  *
@@ -3073,8 +3109,7 @@ export const either: {
    *
    * **When to use**
    *
-   * Use when the combined schedule should continue while at least one
-   * schedule still recurs. Use `both` when both schedules must continue.
+   * Use when the combined schedule should continue while at least one schedule still recurs.
    *
    * **Example** (Combining schedules with either semantics)
    *
@@ -3155,8 +3190,7 @@ export const either: {
    *
    * **When to use**
    *
-   * Use when the combined schedule should continue while at least one
-   * schedule still recurs. Use `both` when both schedules must continue.
+   * Use when the combined schedule should continue while at least one schedule still recurs.
    *
    * **Example** (Combining schedules with either semantics)
    *
@@ -3242,6 +3276,11 @@ export const either: {
  * to recur, using the minimum of the two durations between recurrences and
  * outputting the result of the left schedule (i.e. `self`).
  *
+ * **When to use**
+ *
+ * Use when either schedule may keep recurrence going and only the left
+ * schedule's output is needed.
+ *
  * **Example** (Combining either schedules and keeping the left output)
  *
  * ```ts
@@ -3278,6 +3317,11 @@ export const eitherLeft: {
    * to recur, using the minimum of the two durations between recurrences and
    * outputting the result of the left schedule (i.e. `self`).
    *
+   * **When to use**
+   *
+   * Use when either schedule may keep recurrence going and only the left
+   * schedule's output is needed.
+   *
    * **Example** (Combining either schedules and keeping the left output)
    *
    * ```ts
@@ -3316,6 +3360,11 @@ export const eitherLeft: {
    * to recur, using the minimum of the two durations between recurrences and
    * outputting the result of the left schedule (i.e. `self`).
    *
+   * **When to use**
+   *
+   * Use when either schedule may keep recurrence going and only the left
+   * schedule's output is needed.
+   *
    * **Example** (Combining either schedules and keeping the left output)
    *
    * ```ts
@@ -3360,6 +3409,11 @@ export const eitherLeft: {
  * to recur, using the minimum of the two durations between recurrences and
  * outputting the result of the right schedule (i.e. `other`).
  *
+ * **When to use**
+ *
+ * Use when either schedule may keep recurrence going and only the right
+ * schedule's output is needed.
+ *
  * **Example** (Combining either schedules and keeping the right output)
  *
  * ```ts
@@ -3396,6 +3450,11 @@ export const eitherRight: {
    * to recur, using the minimum of the two durations between recurrences and
    * outputting the result of the right schedule (i.e. `other`).
    *
+   * **When to use**
+   *
+   * Use when either schedule may keep recurrence going and only the right
+   * schedule's output is needed.
+   *
    * **Example** (Combining either schedules and keeping the right output)
    *
    * ```ts
@@ -3434,6 +3493,11 @@ export const eitherRight: {
    * to recur, using the minimum of the two durations between recurrences and
    * outputting the result of the right schedule (i.e. `other`).
    *
+   * **When to use**
+   *
+   * Use when either schedule may keep recurrence going and only the right
+   * schedule's output is needed.
+   *
    * **Example** (Combining either schedules and keeping the right output)
    *
    * ```ts
@@ -3479,6 +3543,11 @@ export const eitherRight: {
  * outputting the result of the combination of both schedule outputs using the
  * specified `combine` function.
  *
+ * **When to use**
+ *
+ * Use when either schedule may keep recurrence going and their outputs should be
+ * combined into a custom value.
+ *
  * **Example** (Combining either schedule outputs)
  *
  * ```ts
@@ -3520,6 +3589,11 @@ export const eitherWith: {
    * outputting the result of the combination of both schedule outputs using the
    * specified `combine` function.
    *
+   * **When to use**
+   *
+   * Use when either schedule may keep recurrence going and their outputs should be
+   * combined into a custom value.
+   *
    * **Example** (Combining either schedule outputs)
    *
    * ```ts
@@ -3566,6 +3640,11 @@ export const eitherWith: {
    * outputting the result of the combination of both schedule outputs using the
    * specified `combine` function.
    *
+   * **When to use**
+   *
+   * Use when either schedule may keep recurrence going and their outputs should be
+   * combined into a custom value.
+   *
    * **Example** (Combining either schedule outputs)
    *
    * ```ts
@@ -3629,6 +3708,11 @@ export const eitherWith: {
                * outputting the result of the combination of both schedule outputs using the
                * specified `combine` function.
                *
+               * **When to use**
+               *
+               * Use when either schedule may keep recurrence going and their outputs should be
+               * combined into a custom value.
+               *
                * **Example** (Combining either schedule outputs)
                *
                * ```ts
@@ -3866,8 +3950,7 @@ export const fibonacci = (one: Duration.Input): Schedule<Duration.Duration> => {
  *
  * **When to use**
  *
- * Use when recurrences should stay aligned to a regular cadence. Use
- * `spaced` when each delay should start after the previous action completes.
+ * Use when recurrences should stay aligned to a regular cadence.
  *
  * **Gotchas**
  *
@@ -4369,9 +4452,7 @@ export const passthrough = <Output, Input, Error, Env>(
  *
  * **When to use**
  *
- * Use when you need a counter schedule with no additional delay. Use `take`
- * to limit an existing schedule while preserving its output and delay
- * behavior.
+ * Use when you need a counter schedule with no additional delay.
  *
  * **Gotchas**
  *
@@ -4819,9 +4900,7 @@ export const reduce: {
  *
  * **When to use**
  *
- * Use when each delay should start after the previous action
- * completes. Use `fixed` when recurrences should stay aligned to a regular
- * cadence.
+ * Use when each delay should start after the previous action completes.
  *
  * **Example** (Repeating with fixed spacing)
  *
@@ -5673,9 +5752,7 @@ export const tapOutput: {
  *
  * **When to use**
  *
- * Use to limit an existing schedule while preserving its output and
- * delay behavior. Use `recurs` when you only need an immediate counter
- * schedule.
+ * Use to limit an existing schedule while preserving its output and delay behavior.
  *
  * **Gotchas**
  *
@@ -5769,9 +5846,7 @@ export const take: {
    *
    * **When to use**
    *
-   * Use to limit an existing schedule while preserving its output and
-   * delay behavior. Use `recurs` when you only need an immediate counter
-   * schedule.
+   * Use to limit an existing schedule while preserving its output and delay behavior.
    *
    * **Gotchas**
    *
@@ -5867,9 +5942,7 @@ export const take: {
    *
    * **When to use**
    *
-   * Use to limit an existing schedule while preserving its output and
-   * delay behavior. Use `recurs` when you only need an immediate counter
-   * schedule.
+   * Use to limit an existing schedule while preserving its output and delay behavior.
    *
    * **Gotchas**
    *
@@ -6242,13 +6315,8 @@ export {
  *
  * **When to use**
  *
- * Use to check an existing schedule input type. Use
- * `setInputType` to adapt a schedule that does not depend on its input values.
- *
- * **Details**
- *
- * This helper is checked at compile time and does not change the schedule's
- * runtime behavior.
+ * Use when you need a generic helper to prove that an existing schedule can
+ * consume a required input type without changing runtime behavior.
  *
  * **Example** (Constraining schedule input types)
  *
@@ -6282,8 +6350,7 @@ export const satisfiesInputType = <T>() =>
  *
  * **When to use**
  *
- * Use to adapt a schedule that does not depend on its input
- * values. Use `satisfiesInputType` to check an existing schedule input type.
+ * Use to adapt a schedule that does not depend on its input values.
  *
  * **Details**
  *

package/src/Scheduler.ts

@@ -75,7 +75,8 @@ export interface SchedulerDispatcher {
  *
  * **When to use**
  *
- * Use to provide or override the scheduler used by the Effect runtime.
+ * Use when you need to replace scheduling behavior globally in tests or runtime
+ * setup, such as forcing deterministic task dispatch.
  *
  * **Details**
  *
@@ -179,7 +180,8 @@ export class MixedScheduler implements Scheduler {
    *
    * **When to use**
    *
-   * Use to create a dispatcher for enqueuing work through this scheduler.
+   * Use when you need a standalone dispatcher from a scheduler instance, for
+   * example in tests that enqueue tasks and then flush them deterministically.
    *
    * @since 4.0.0
    */
@@ -250,8 +252,8 @@ class MixedSchedulerDispatcher implements SchedulerDispatcher {
  *
  * **When to use**
  *
- * Use to tune scheduler fairness for CPU-bound fibers by changing the operation
- * budget that triggers a scheduler yield.
+ * Use to tune scheduler fairness for CPU-bound fibers by changing the scheduler
+ * operation budget that triggers a yield.
  *
  * **Details**
  *