Schedule36

Constructors

cronconstReturns a new Schedule that recurs on the specified Cron schedule and outputs the duration between recurrences.durationconstReturns a schedule that recurs once after the specified duration.duringconstReturns a new Schedule that will always recur, but only during the specified duration of time.exponentialconstSchedule that always recurs, but will wait a certain amount between repetitions, given by base factor.pow(n), where n is the number of repetitions so far.fibonacciconstSchedule that always recurs, increasing delays by summing the preceding two delays (similar to the Fibonacci sequence).fixedconstReturns a Schedule that recurs on the specified fixed interval and outputs the number of repetitions of the schedule so far.foreverconstReturns a new Schedule that will recur forever.fromStepconstCreates a Schedule from a step function that returns a Pull.fromStepWithMetadataconstCreates a Schedule from a step function that receives metadata about the schedule's execution.recursconstReturns a Schedule which can only be stepped the specified number of times before it terminates.spacedconstReturns a schedule that recurs continuously, each repetition spaced the specified duration from the last run.windowedconstSchedule that divides the timeline to interval-long windows, and sleeps until the nearest window boundary every time it recurs.

Models

ScheduleinterfaceA Schedule defines a strategy for repeating or retrying effects based on some policy.

Guards

isScheduleconstType guard that checks if a value is a Schedule.

Mapping

mapconstReturns a new Schedule that maps each schedule decision to a new output using the full schedule metadata.passthroughconstReturns a new Schedule that outputs the inputs of the specified schedule.

Filtering

upToconstReturns a new Schedule that limits an existing schedule by elapsed duration, number of outputs, or both.

Sequencing

andThenconstReturns a schedule that runs self to completion, then runs other, and merges their outputs.andThenResultconstReturns a schedule that runs self to completion, then runs other, and preserves which schedule produced each output.tapconstReturns a new Schedule that allows execution of an effectful function for every decision of the schedule, but does not alter the inputs and outputs of the schedule.

Destructors

toStepconstExtracts the step function from a Schedule.toStepWithMetadataconstExtracts a step function from a Schedule that sleeps for each computed delay and returns metadata for the completed step.toStepWithSleepconstExtracts a step function from a Schedule that automatically handles sleep delays.

Combining

maxconstCombines schedules by recurring while all schedules want to recur, using the maximum delay between recurrences and outputting that maximum delay.minconstCombines schedules by recurring while at least one schedule wants to recur, using the minimum delay between recurrences and outputting that minimum delay.

Delays & Timeouts

addDelayconstReturns a new Schedule that adds the delay computed by the specified effectful function to the next recurrence of the schedule.jitteredconstReturns a new Schedule that randomly adjusts each recurrence delay.modifyDelayconstReturns a new Schedule that modifies the delay of the next recurrence of the schedule using the specified effectful function.

Metadata

CurrentMetadataconstContext reference containing metadata for the currently running schedule step.InputMetadatainterfaceMetadata provided to schedule functions containing timing and input information.MetadatainterfaceExtended metadata that includes both input metadata and the output value from the schedule.

Type Extractors

EnvtypeExtracts the service requirements from a Schedule.ErrortypeExtracts the error type from a Schedule.InputtypeExtracts the input type from a Schedule.OutputtypeExtracts the output type from a Schedule.

Utility Types

setInputTypeconstSets the input type of the provided schedule without altering its behavior.