ScheduleStep - API reference

API reference › @evolu/common › Schedule › ScheduleStep

Defined in: packages/common/src/Schedule.ts:130

Base interface for schedule-based task helpers.

Used by RetryAttempt, RepeatAttempt, and future schedule-driven helpers.

Extended by

RetryAttempt
RepeatAttempt

Properties

attempt

readonly attempt: number & Brand<"NonNaN"> & Brand<"Finite"> & Brand<"Int"> & Brand<"NonNegative"> & Brand<"Positive">;

Defined in: packages/common/src/Schedule.ts:132

The current attempt.

delay

readonly delay: number & Brand<"NonNaN"> & Brand<"Finite"> & Brand<"Int"> & Brand<"NonNegative"> & Brand<"LessThan281474976710655"> & Brand<"Millis">;

Defined in: packages/common/src/Schedule.ts:138

Delay before the scheduled recurrence executes.

output

readonly output: Output;

Defined in: packages/common/src/Schedule.ts:135

Output from the Schedule step.