GitHub

API reference for Step.

One step of a plan (Effect's ExecutionPlan.make.Step): run with provide (a layer or a context) up to attempts times, retrying on schedule's delays while while_(error) holds.

Without attempts or schedule the step runs once. attempts must be at least 1 (make checks it).

Attributes

AttributeTypeDescription
provideContext[P_contra] | Layer[P_contra, E_co, R_co]
attemptsint | None = None
while_Predicate[In_contra, E_co, R_co] | None = None
scheduleSchedule[Any, In_contra, E_co, R_co] | None = None

Functions

__init__

__init__(provide, attempts=None, while_=None, schedule=None) -> None
ParameterTypeDescription
provideContext[P_contra] | Layer[P_contra, E_co, R_co]
attemptsint | None = None
while_Predicate[In_contra, E_co, R_co] | None = None
scheduleSchedule[Any, In_contra, E_co, R_co] | None = None