effect 3.8.4 → 3.9.0

package/dist/dts/Schedule.d.ts

@@ -125,7 +125,21 @@ export declare const makeWithState: <S, In, Out, R = never>(initial: S, step: (n
  * @category utils
  */
 export declare const addDelay: {
+    /**
+     * Returns a new schedule with the given delay added to every interval defined
+     * by this schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out>(f: (out: Out) => Duration.DurationInput): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule with the given delay added to every interval defined
+     * by this schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, f: (out: Out) => Duration.DurationInput): Schedule<Out, In, R>;
 };
 /**
@@ -136,7 +150,21 @@ export declare const addDelay: {
  * @category utils
  */
 export declare const addDelayEffect: {
+    /**
+     * Returns a new schedule with the given effectfully computed delay added to
+     * every interval defined by this schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, R2>(f: (out: Out) => Effect.Effect<Duration.DurationInput, never, R2>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule with the given effectfully computed delay added to
+     * every interval defined by this schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, R2>(self: Schedule<Out, In, R>, f: (out: Out) => Effect.Effect<Duration.DurationInput, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -146,7 +174,19 @@ export declare const addDelayEffect: {
  * @category sequencing
  */
 export declare const andThen: {
+    /**
+     * The same as `andThenEither`, but merges the output.
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out2 | Out, In & In2, R2 | R>;
+    /**
+     * The same as `andThenEither`, but merges the output.
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>): Schedule<Out | Out2, In & In2, R | R2>;
 };
 /**
@@ -157,7 +197,21 @@ export declare const andThen: {
  * @category sequencing
  */
 export declare const andThenEither: {
+    /**
+     * Returns a new schedule that first executes this schedule to completion, and
+     * then executes the specified schedule to completion.
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Either.Either<Out2, Out>, In & In2, R2 | R>;
+    /**
+     * Returns a new schedule that first executes this schedule to completion, and
+     * then executes the specified schedule to completion.
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>): Schedule<Either.Either<Out2, Out>, In & In2, R | R2>;
 };
 /**
@@ -167,7 +221,19 @@ export declare const andThenEither: {
  * @category mapping
  */
 export declare const as: {
+    /**
+     * Returns a new schedule that maps this schedule to a constant output.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out2>(out: Out2): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out2, In, R>;
+    /**
+     * Returns a new schedule that maps this schedule to a constant output.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out, In, R, Out2>(self: Schedule<Out, In, R>, out: Out2): Schedule<Out2, In, R>;
 };
 /**
@@ -185,7 +251,21 @@ export declare const asVoid: <Out, In, R>(self: Schedule<Out, In, R>) => Schedul
  * @category utils
  */
 export declare const bothInOut: {
+    /**
+     * Returns a new schedule that has both the inputs and outputs of this and the
+     * specified schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<[Out, Out2], readonly [In, In2], R2 | R>;
+    /**
+     * Returns a new schedule that has both the inputs and outputs of this and the
+     * specified schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>): Schedule<[Out, Out2], readonly [In, In2], R | R2>;
 };
 /**
@@ -197,7 +277,23 @@ export declare const bothInOut: {
  * @category utils
  */
 export declare const check: {
+    /**
+     * Returns a new schedule that passes each input and output of this schedule
+     * to the specified function, and then determines whether or not to continue
+     * based on the return value of the function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <In, Out>(test: (input: In, output: Out) => boolean): <R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule that passes each input and output of this schedule
+     * to the specified function, and then determines whether or not to continue
+     * based on the return value of the function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, test: (input: In, output: Out) => boolean): Schedule<Out, In, R>;
 };
 /**
@@ -209,7 +305,23 @@ export declare const check: {
  * @category utils
  */
 export declare const checkEffect: {
+    /**
+     * Returns a new schedule that passes each input and output of this schedule
+     * to the specified function, and then determines whether or not to continue
+     * based on the return value of the function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <In, Out, R2>(test: (input: In, output: Out) => Effect.Effect<boolean, never, R2>): <R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule that passes each input and output of this schedule
+     * to the specified function, and then determines whether or not to continue
+     * based on the return value of the function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, R2>(self: Schedule<Out, In, R>, test: (input: In, output: Out) => Effect.Effect<boolean, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -268,7 +380,25 @@ export declare const collectWhileEffect: <A, R>(f: (a: A) => Effect.Effect<boole
  * @category utils
  */
 export declare const compose: {
+    /**
+     * Returns the composition of this schedule and the specified schedule, by
+     * piping the output of this one into the input of the other. Effects
+     * described by this schedule will always be executed before the effects
+     * described by the second schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out2, Out, R2>(that: Schedule<Out2, Out, R2>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out2, In, R2 | R>;
+    /**
+     * Returns the composition of this schedule and the specified schedule, by
+     * piping the output of this one into the input of the other. Effects
+     * described by this schedule will always be executed before the effects
+     * described by the second schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, Out2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, Out, R2>): Schedule<Out2, In, R | R2>;
 };
 /**
@@ -279,7 +409,21 @@ export declare const compose: {
  * @category mapping
  */
 export declare const mapInput: {
+    /**
+     * Returns a new schedule that deals with a narrower class of inputs than this
+     * schedule.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <In, In2>(f: (in2: In2) => In): <Out, R>(self: Schedule<Out, In, R>) => Schedule<Out, In2, R>;
+    /**
+     * Returns a new schedule that deals with a narrower class of inputs than this
+     * schedule.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out, In, R, In2>(self: Schedule<Out, In, R>, f: (in2: In2) => In): Schedule<Out, In2, R>;
 };
 /**
@@ -290,7 +434,21 @@ export declare const mapInput: {
  * @category context
  */
 export declare const mapInputContext: {
+    /**
+     * Transforms the context being provided to this schedule with the
+     * specified function.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <R0, R>(f: (env0: Context.Context<R0>) => Context.Context<R>): <Out, In>(self: Schedule<Out, In, R>) => Schedule<Out, In, R0>;
+    /**
+     * Transforms the context being provided to this schedule with the
+     * specified function.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <Out, In, R, R0>(self: Schedule<Out, In, R>, f: (env0: Context.Context<R0>) => Context.Context<R>): Schedule<Out, In, R0>;
 };
 /**
@@ -301,7 +459,21 @@ export declare const mapInputContext: {
  * @category mapping
  */
 export declare const mapInputEffect: {
+    /**
+     * Returns a new schedule that deals with a narrower class of inputs than this
+     * schedule.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <In2, In, R2>(f: (in2: In2) => Effect.Effect<In, never, R2>): <Out, R>(self: Schedule<Out, In, R>) => Schedule<Out, In2, R2 | R>;
+    /**
+     * Returns a new schedule that deals with a narrower class of inputs than this
+     * schedule.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out, In, R, In2, R2>(self: Schedule<Out, In, R>, f: (in2: In2) => Effect.Effect<In, never, R2>): Schedule<Out, In2, R | R2>;
 };
 /**
@@ -353,7 +525,21 @@ export declare const dayOfWeek: (day: number) => Schedule<number>;
  * @category utils
  */
 export declare const delayed: {
+    /**
+     * Returns a new schedule with the specified effectfully computed delay added
+     * before the start of each interval produced by this schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     (f: (duration: Duration.Duration) => Duration.DurationInput): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule with the specified effectfully computed delay added
+     * before the start of each interval produced by this schedule.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, f: (duration: Duration.Duration) => Duration.DurationInput): Schedule<Out, In, R>;
 };
 /**
@@ -364,7 +550,21 @@ export declare const delayed: {
  * @category constructors
  */
 export declare const delayedEffect: {
+    /**
+     * Returns a new schedule with the specified effectfully computed delay added
+     * before the start of each interval produced by this schedule.
+     *
+     * @since 2.0.0
+     * @category constructors
+     */
     <R2>(f: (duration: Duration.Duration) => Effect.Effect<Duration.DurationInput, never, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule with the specified effectfully computed delay added
+     * before the start of each interval produced by this schedule.
+     *
+     * @since 2.0.0
+     * @category constructors
+     */
     <Out, In, R, R2>(self: Schedule<Out, In, R>, f: (duration: Duration.Duration) => Effect.Effect<Duration.DurationInput, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -389,10 +589,22 @@ export declare const delays: <Out, In, R>(self: Schedule<Out, In, R>) => Schedul
  * @category mapping
  */
 export declare const mapBoth: {
+    /**
+     * Returns a new schedule that maps both the input and output.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <In2, In, Out, Out2>(options: {
         readonly onInput: (in2: In2) => In;
         readonly onOutput: (out: Out) => Out2;
     }): <R>(self: Schedule<Out, In, R>) => Schedule<Out2, In2, R>;
+    /**
+     * Returns a new schedule that maps both the input and output.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out, In, R, In2, Out2>(self: Schedule<Out, In, R>, options: {
         readonly onInput: (in2: In2) => In;
         readonly onOutput: (out: Out) => Out2;
@@ -405,10 +617,22 @@ export declare const mapBoth: {
  * @category mapping
  */
 export declare const mapBothEffect: {
+    /**
+     * Returns a new schedule that maps both the input and output.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <In2, In, R2, Out, R3, Out2>(options: {
         readonly onInput: (input: In2) => Effect.Effect<In, never, R2>;
         readonly onOutput: (out: Out) => Effect.Effect<Out2, never, R3>;
     }): <R>(self: Schedule<Out, In, R>) => Schedule<Out2, In2, R2 | R3 | R>;
+    /**
+     * Returns a new schedule that maps both the input and output.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out, In, R, In2, R2, Out2, R3>(self: Schedule<Out, In, R>, options: {
         readonly onInput: (input: In2) => Effect.Effect<In, never, R2>;
         readonly onOutput: (out: Out) => Effect.Effect<Out2, never, R3>;
@@ -438,7 +662,21 @@ export declare const duration: (duration: Duration.DurationInput) => Schedule<Du
  * @category alternatives
  */
 export declare const either: {
+    /**
+     * Returns a new schedule that performs a geometric union on the intervals
+     * defined by both schedules.
+     *
+     * @since 2.0.0
+     * @category alternatives
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<[Out, Out2], In & In2, R2 | R>;
+    /**
+     * Returns a new schedule that performs a geometric union on the intervals
+     * defined by both schedules.
+     *
+     * @since 2.0.0
+     * @category alternatives
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>): Schedule<[Out, Out2], In & In2, R | R2>;
 };
 /**
@@ -448,7 +686,19 @@ export declare const either: {
  * @category alternatives
  */
 export declare const eitherWith: {
+    /**
+     * The same as `either` followed by `map`.
+     *
+     * @since 2.0.0
+     * @category alternatives
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>, f: (x: Intervals.Intervals, y: Intervals.Intervals) => Intervals.Intervals): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<[Out, Out2], In & In2, R2 | R>;
+    /**
+     * The same as `either` followed by `map`.
+     *
+     * @since 2.0.0
+     * @category alternatives
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>, f: (x: Intervals.Intervals, y: Intervals.Intervals) => Intervals.Intervals): Schedule<[Out, Out2], In & In2, R | R2>;
 };
 /**
@@ -470,7 +720,27 @@ export declare const elapsed: Schedule<Duration.Duration>;
  * @category finalization
  */
 export declare const ensuring: {
+    /**
+     * Returns a new schedule that will run the specified finalizer as soon as the
+     * schedule is complete. Note that unlike `Effect.ensuring`, this method does not
+     * guarantee the finalizer will be run. The `Schedule` may not initialize or
+     * the driver of the schedule may not run to completion. However, if the
+     * `Schedule` ever decides not to continue, then the finalizer will be run.
+     *
+     * @since 2.0.0
+     * @category finalization
+     */
     <X>(finalizer: Effect.Effect<X, never, never>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule that will run the specified finalizer as soon as the
+     * schedule is complete. Note that unlike `Effect.ensuring`, this method does not
+     * guarantee the finalizer will be run. The `Schedule` may not initialize or
+     * the driver of the schedule may not run to completion. However, if the
+     * `Schedule` ever decides not to continue, then the finalizer will be run.
+     *
+     * @since 2.0.0
+     * @category finalization
+     */
     <Out, In, R, X>(self: Schedule<Out, In, R>, finalizer: Effect.Effect<X, never, never>): Schedule<Out, In, R>;
 };
 /**
@@ -563,7 +833,21 @@ export declare const identity: <A>() => Schedule<A, A>;
  * @category utils
  */
 export declare const intersect: {
+    /**
+     * Returns a new schedule that performs a geometric intersection on the
+     * intervals defined by both schedules.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<[Out, Out2], In & In2, R2 | R>;
+    /**
+     * Returns a new schedule that performs a geometric intersection on the
+     * intervals defined by both schedules.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>): Schedule<[Out, Out2], In & In2, R | R2>;
 };
 /**
@@ -575,7 +859,23 @@ export declare const intersect: {
  * @category utils
  */
 export declare const intersectWith: {
+    /**
+     * Returns a new schedule that combines this schedule with the specified
+     * schedule, continuing as long as both schedules want to continue and merging
+     * the next intervals according to the specified merge function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>, f: (x: Intervals.Intervals, y: Intervals.Intervals) => Intervals.Intervals): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<[Out, Out2], In & In2, R2 | R>;
+    /**
+     * Returns a new schedule that combines this schedule with the specified
+     * schedule, continuing as long as both schedules want to continue and merging
+     * the next intervals according to the specified merge function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>, f: (x: Intervals.Intervals, y: Intervals.Intervals) => Intervals.Intervals): Schedule<[Out, Out2], In & In2, R | R2>;
 };
 /**
@@ -602,10 +902,30 @@ export declare const jittered: <Out, In, R>(self: Schedule<Out, In, R>) => Sched
  * @category constructors
  */
 export declare const jitteredWith: {
+    /**
+     * Returns a new schedule that randomly modifies the size of the intervals of
+     * this schedule.
+     *
+     * The new interval size is between `min * old interval size` and `max * old
+     * interval size`.
+     *
+     * @since 2.0.0
+     * @category constructors
+     */
     (options: {
         min?: number | undefined;
         max?: number | undefined;
     }): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule that randomly modifies the size of the intervals of
+     * this schedule.
+     *
+     * The new interval size is between `min * old interval size` and `max * old
+     * interval size`.
+     *
+     * @since 2.0.0
+     * @category constructors
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, options: {
         min?: number | undefined;
         max?: number | undefined;
@@ -628,7 +948,21 @@ export declare const linear: (base: Duration.DurationInput) => Schedule<Duration
  * @category mapping
  */
 export declare const map: {
+    /**
+     * Returns a new schedule that maps the output of this schedule through the
+     * specified function.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out, Out2>(f: (out: Out) => Out2): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out2, In, R>;
+    /**
+     * Returns a new schedule that maps the output of this schedule through the
+     * specified function.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out, In, R, Out2>(self: Schedule<Out, In, R>, f: (out: Out) => Out2): Schedule<Out2, In, R>;
 };
 /**
@@ -639,7 +973,21 @@ export declare const map: {
  * @category mapping
  */
 export declare const mapEffect: {
+    /**
+     * Returns a new schedule that maps the output of this schedule through the
+     * specified effectful function.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out, Out2, R2>(f: (out: Out) => Effect.Effect<Out2, never, R2>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out2, In, R2 | R>;
+    /**
+     * Returns a new schedule that maps the output of this schedule through the
+     * specified effectful function.
+     *
+     * @since 2.0.0
+     * @category mapping
+     */
     <Out, In, R, Out2, R2>(self: Schedule<Out, In, R>, f: (out: Out) => Effect.Effect<Out2, never, R2>): Schedule<Out2, In, R | R2>;
 };
 /**
@@ -661,7 +1009,21 @@ export declare const minuteOfHour: (minute: number) => Schedule<number>;
  * @category utils
  */
 export declare const modifyDelay: {
+    /**
+     * Returns a new schedule that modifies the delay using the specified
+     * function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out>(f: (out: Out, duration: Duration.Duration) => Duration.DurationInput): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule that modifies the delay using the specified
+     * function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, f: (out: Out, duration: Duration.Duration) => Duration.DurationInput): Schedule<Out, In, R>;
 };
 /**
@@ -672,7 +1034,21 @@ export declare const modifyDelay: {
  * @category utils
  */
 export declare const modifyDelayEffect: {
+    /**
+     * Returns a new schedule that modifies the delay using the specified
+     * effectual function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, R2>(f: (out: Out, duration: Duration.Duration) => Effect.Effect<Duration.DurationInput, never, R2>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule that modifies the delay using the specified
+     * effectual function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, R2>(self: Schedule<Out, In, R>, f: (out: Out, duration: Duration.Duration) => Effect.Effect<Duration.DurationInput, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -684,7 +1060,23 @@ export declare const modifyDelayEffect: {
  * @category utils
  */
 export declare const onDecision: {
+    /**
+     * Returns a new schedule that applies the current one but runs the specified
+     * effect for every decision of this schedule. This can be used to create
+     * schedules that log failures, decisions, or computed values.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, X, R2>(f: (out: Out, decision: ScheduleDecision.ScheduleDecision) => Effect.Effect<X, never, R2>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule that applies the current one but runs the specified
+     * effect for every decision of this schedule. This can be used to create
+     * schedules that log failures, decisions, or computed values.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, X, R2>(self: Schedule<Out, In, R>, f: (out: Out, decision: ScheduleDecision.ScheduleDecision) => Effect.Effect<X, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -709,7 +1101,21 @@ export declare const passthrough: <Out, In, R>(self: Schedule<Out, In, R>) => Sc
  * @category context
  */
 export declare const provideContext: {
+    /**
+     * Returns a new schedule with its context provided to it, so the
+     * resulting schedule does not require any context.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <R>(context: Context.Context<R>): <Out, In>(self: Schedule<Out, In, R>) => Schedule<Out, In, never>;
+    /**
+     * Returns a new schedule with its context provided to it, so the
+     * resulting schedule does not require any context.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, context: Context.Context<R>): Schedule<Out, In, never>;
 };
 /**
@@ -721,7 +1127,23 @@ export declare const provideContext: {
  * @category context
  */
 export declare const provideService: {
+    /**
+     * Returns a new schedule with the single service it requires provided to it.
+     * If the schedule requires multiple services use `provideContext`
+     * instead.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <T extends Context.Tag<any, any>>(tag: T, service: Context.Tag.Service<T>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, Exclude<R, Context.Tag.Identifier<T>>>;
+    /**
+     * Returns a new schedule with the single service it requires provided to it.
+     * If the schedule requires multiple services use `provideContext`
+     * instead.
+     *
+     * @since 2.0.0
+     * @category context
+     */
     <Out, In, R, T extends Context.Tag<any, any>>(self: Schedule<Out, In, R>, tag: T, service: Context.Tag.Service<T>): Schedule<Out, In, Exclude<R, Context.Tag.Identifier<T>>>;
 };
 /**
@@ -783,7 +1205,19 @@ export declare const recurs: (n: number) => Schedule<number>;
  * @category folding
  */
 export declare const reduce: {
+    /**
+     * Returns a new schedule that folds over the outputs of this one.
+     *
+     * @since 2.0.0
+     * @category folding
+     */
     <Out, Z>(zero: Z, f: (z: Z, out: Out) => Z): <In, R>(self: Schedule<Out, In, R>) => Schedule<Z, In, R>;
+    /**
+     * Returns a new schedule that folds over the outputs of this one.
+     *
+     * @since 2.0.0
+     * @category folding
+     */
     <Out, In, R, Z>(self: Schedule<Out, In, R>, zero: Z, f: (z: Z, out: Out) => Z): Schedule<Z, In, R>;
 };
 /**
@@ -793,7 +1227,19 @@ export declare const reduce: {
  * @category folding
  */
 export declare const reduceEffect: {
+    /**
+     * Returns a new schedule that effectfully folds over the outputs of this one.
+     *
+     * @since 2.0.0
+     * @category folding
+     */
     <Z, Out, R2>(zero: Z, f: (z: Z, out: Out) => Effect.Effect<Z, never, R2>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Z, In, R2 | R>;
+    /**
+     * Returns a new schedule that effectfully folds over the outputs of this one.
+     *
+     * @since 2.0.0
+     * @category folding
+     */
     <Out, In, R, Z, R2>(self: Schedule<Out, In, R>, zero: Z, f: (z: Z, out: Out) => Effect.Effect<Z, never, R2>): Schedule<Z, In, R | R2>;
 };
 /**
@@ -819,7 +1265,21 @@ export declare const repetitions: <Out, In, R>(self: Schedule<Out, In, R>) => Sc
  * @category utils
  */
 export declare const resetAfter: {
+    /**
+     * Return a new schedule that automatically resets the schedule to its initial
+     * state after some time of inactivity defined by `duration`.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     (duration: Duration.DurationInput): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Return a new schedule that automatically resets the schedule to its initial
+     * state after some time of inactivity defined by `duration`.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, duration: Duration.DurationInput): Schedule<Out, In, R>;
 };
 /**
@@ -830,7 +1290,21 @@ export declare const resetAfter: {
  * @category utils
  */
 export declare const resetWhen: {
+    /**
+     * Resets the schedule when the specified predicate on the schedule output
+     * evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out>(f: Predicate<Out>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Resets the schedule when the specified predicate on the schedule output
+     * evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, f: Predicate<Out>): Schedule<Out, In, R>;
 };
 /**
@@ -840,7 +1314,19 @@ export declare const resetWhen: {
  * @category destructors
  */
 export declare const run: {
+    /**
+     * Runs a schedule using the provided inputs, and collects all outputs.
+     *
+     * @since 2.0.0
+     * @category destructors
+     */
     <In>(now: number, input: Iterable<In>): <Out, R>(self: Schedule<Out, In, R>) => Effect.Effect<Chunk.Chunk<Out>, never, R>;
+    /**
+     * Runs a schedule using the provided inputs, and collects all outputs.
+     *
+     * @since 2.0.0
+     * @category destructors
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, now: number, input: Iterable<In>): Effect.Effect<Chunk.Chunk<Out>, never, R>;
 };
 /**
@@ -893,7 +1379,21 @@ export declare const sync: <A>(evaluate: LazyArg<A>) => Schedule<A>;
  * @category sequencing
  */
 export declare const tapInput: {
+    /**
+     * Returns a new schedule that effectfully processes every input to this
+     * schedule.
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <In2, X, R2>(f: (input: In2) => Effect.Effect<X, never, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In & In2, R2 | R>;
+    /**
+     * Returns a new schedule that effectfully processes every input to this
+     * schedule.
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <Out, In, R, In2, X, R2>(self: Schedule<Out, In, R>, f: (input: In2) => Effect.Effect<X, never, R2>): Schedule<Out, In & In2, R | R2>;
 };
 /**
@@ -904,7 +1404,21 @@ export declare const tapInput: {
  * @category sequencing
  */
 export declare const tapOutput: {
+    /**
+     * Returns a new schedule that effectfully processes every output from this
+     * schedule.
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <XO extends Out, X, R2, Out>(f: (out: XO) => Effect.Effect<X, never, R2>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule that effectfully processes every output from this
+     * schedule.
+     *
+     * @since 2.0.0
+     * @category sequencing
+     */
     <Out, In, R, XO extends Out, X, R2>(self: Schedule<Out, In, R>, f: (out: XO) => Effect.Effect<X, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -923,7 +1437,21 @@ export declare const unfold: <A>(initial: A, f: (a: A) => A) => Schedule<A>;
  * @category utils
  */
 export declare const union: {
+    /**
+     * Returns a new schedule that performs a geometric union on the intervals
+     * defined by both schedules.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<[Out, Out2], In & In2, R2 | R>;
+    /**
+     * Returns a new schedule that performs a geometric union on the intervals
+     * defined by both schedules.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>): Schedule<[Out, Out2], In & In2, R | R2>;
 };
 /**
@@ -935,7 +1463,23 @@ export declare const union: {
  * @category utils
  */
 export declare const unionWith: {
+    /**
+     * Returns a new schedule that combines this schedule with the specified
+     * schedule, continuing as long as either schedule wants to continue and
+     * merging the next intervals according to the specified merge function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>, f: (x: Intervals.Intervals, y: Intervals.Intervals) => Intervals.Intervals): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<[Out, Out2], In & In2, R2 | R>;
+    /**
+     * Returns a new schedule that combines this schedule with the specified
+     * schedule, continuing as long as either schedule wants to continue and
+     * merging the next intervals according to the specified merge function.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>, f: (x: Intervals.Intervals, y: Intervals.Intervals) => Intervals.Intervals): Schedule<[Out, Out2], In & In2, R | R2>;
 };
 /**
@@ -946,7 +1490,21 @@ export declare const unionWith: {
  * @category utils
  */
 export declare const untilInput: {
+    /**
+     * Returns a new schedule that continues until the specified predicate on the
+     * input evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <In>(f: Predicate<In>): <Out, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule that continues until the specified predicate on the
+     * input evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, f: Predicate<In>): Schedule<Out, In, R>;
 };
 /**
@@ -957,7 +1515,21 @@ export declare const untilInput: {
  * @category utils
  */
 export declare const untilInputEffect: {
+    /**
+     * Returns a new schedule that continues until the specified effectful
+     * predicate on the input evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <In, R2>(f: (input: In) => Effect.Effect<boolean, never, R2>): <Out, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule that continues until the specified effectful
+     * predicate on the input evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, R2>(self: Schedule<Out, In, R>, f: (input: In) => Effect.Effect<boolean, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -968,7 +1540,21 @@ export declare const untilInputEffect: {
  * @category utils
  */
 export declare const untilOutput: {
+    /**
+     * Returns a new schedule that continues until the specified predicate on the
+     * output evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out>(f: Predicate<Out>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule that continues until the specified predicate on the
+     * output evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, f: Predicate<Out>): Schedule<Out, In, R>;
 };
 /**
@@ -979,7 +1565,21 @@ export declare const untilOutput: {
  * @category utils
  */
 export declare const untilOutputEffect: {
+    /**
+     * Returns a new schedule that continues until the specified effectful
+     * predicate on the output evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, R2>(f: (out: Out) => Effect.Effect<boolean, never, R2>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule that continues until the specified effectful
+     * predicate on the output evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, R2>(self: Schedule<Out, In, R>, f: (out: Out) => Effect.Effect<boolean, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -989,7 +1589,19 @@ export declare const untilOutputEffect: {
  * @category utils
  */
 export declare const upTo: {
+    /**
+     * A schedule that recurs during the given duration.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     (duration: Duration.DurationInput): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * A schedule that recurs during the given duration.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, duration: Duration.DurationInput): Schedule<Out, In, R>;
 };
 /**
@@ -1000,7 +1612,21 @@ export declare const upTo: {
  * @category utils
  */
 export declare const whileInput: {
+    /**
+     * Returns a new schedule that continues for as long as the specified predicate
+     * on the input evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <In>(f: Predicate<In>): <Out, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule that continues for as long as the specified predicate
+     * on the input evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, f: Predicate<In>): Schedule<Out, In, R>;
 };
 /**
@@ -1011,7 +1637,21 @@ export declare const whileInput: {
  * @category utils
  */
 export declare const whileInputEffect: {
+    /**
+     * Returns a new schedule that continues for as long as the specified effectful
+     * predicate on the input evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <In, R2>(f: (input: In) => Effect.Effect<boolean, never, R2>): <Out, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule that continues for as long as the specified effectful
+     * predicate on the input evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, R2>(self: Schedule<Out, In, R>, f: (input: In) => Effect.Effect<boolean, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -1022,7 +1662,21 @@ export declare const whileInputEffect: {
  * @category utils
  */
 export declare const whileOutput: {
+    /**
+     * Returns a new schedule that continues for as long the specified predicate
+     * on the output evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out>(f: Predicate<Out>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R>;
+    /**
+     * Returns a new schedule that continues for as long the specified predicate
+     * on the output evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R>(self: Schedule<Out, In, R>, f: Predicate<Out>): Schedule<Out, In, R>;
 };
 /**
@@ -1033,7 +1687,21 @@ export declare const whileOutput: {
  * @category utils
  */
 export declare const whileOutputEffect: {
+    /**
+     * Returns a new schedule that continues for as long the specified effectful
+     * predicate on the output evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, R2>(f: (out: Out) => Effect.Effect<boolean, never, R2>): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In, R2 | R>;
+    /**
+     * Returns a new schedule that continues for as long the specified effectful
+     * predicate on the output evaluates to true.
+     *
+     * @since 2.0.0
+     * @category utils
+     */
     <Out, In, R, R2>(self: Schedule<Out, In, R>, f: (out: Out) => Effect.Effect<boolean, never, R2>): Schedule<Out, In, R | R2>;
 };
 /**
@@ -1060,7 +1728,19 @@ export declare const windowed: (interval: Duration.DurationInput) => Schedule<nu
  * @category zipping
  */
 export declare const zipLeft: {
+    /**
+     * The same as `intersect` but ignores the right output.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out, In & In2, R2 | R>;
+    /**
+     * The same as `intersect` but ignores the right output.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>): Schedule<Out, In & In2, R | R2>;
 };
 /**
@@ -1070,7 +1750,19 @@ export declare const zipLeft: {
  * @category zipping
  */
 export declare const zipRight: {
+    /**
+     * The same as `intersect` but ignores the left output.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <Out2, In2, R2>(that: Schedule<Out2, In2, R2>): <Out, In, R>(self: Schedule<Out, In, R>) => Schedule<Out2, In & In2, R2 | R>;
+    /**
+     * The same as `intersect` but ignores the left output.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <Out, In, R, Out2, In2, R2>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>): Schedule<Out2, In & In2, R | R2>;
 };
 /**
@@ -1080,7 +1772,19 @@ export declare const zipRight: {
  * @category zipping
  */
 export declare const zipWith: {
+    /**
+     * Equivalent to `intersect` followed by `map`.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <Out2, In2, R2, Out, Out3>(that: Schedule<Out2, In2, R2>, f: (out: Out, out2: Out2) => Out3): <In, R>(self: Schedule<Out, In, R>) => Schedule<Out3, In & In2, R2 | R>;
+    /**
+     * Equivalent to `intersect` followed by `map`.
+     *
+     * @since 2.0.0
+     * @category zipping
+     */
     <Out, In, R, Out2, In2, R2, Out3>(self: Schedule<Out, In, R>, that: Schedule<Out2, In2, R2>, f: (out: Out, out2: Out2) => Out3): Schedule<Out3, In & In2, R | R2>;
 };
 //# sourceMappingURL=Schedule.d.ts.map