alepha@docs:~/docs/reference/primitives$
cat $workflow.md | pretty1 min read
#$workflow
#Import
typescript
1import { $workflow } from "alepha/api/workflows";#Overview
Declare a durable, multi-step workflow (saga).
Steps run sequentially; each step's result is persisted and passed to
later steps via results. On failure, completed steps are compensated
in reverse order (onError: "compensate", the default) or the
execution is marked failed (onError: "fail").
#Options
| Option | Type | Required | Description |
|---|---|---|---|
schema |
TInput |
Yes | Zod schema for the workflow input payload. |
steps |
Array<WorkflowStep<TInput>> |
Yes | Ordered list of steps |
onError |
"compensate" | "fail" |
No | Error strategy |
timeout |
DurationLike |
No | Maximum total duration for the entire workflow. |
priority |
WorkflowPriority |
No | Priority for the workflow's job dispatches. |
tags |
string[] |
No | Tags for filtering/grouping in admin UI. |
context |
Array<Atom<any>> |
No | Atoms whose current values are captured when an execution starts and restored around every step, when() and compensation handler — on whatever process ends up running them, including recovery-sweep dispatches after a crash |