API Reference / Workflow
Class: Workflow<TContext>
Defined in: src/skills/Workflow.ts:14
Type Parameters
TContext
TContext extends Record<string, unknown>
Constructors
Constructor
new Workflow<
TContext>(name?):Workflow<TContext>
Defined in: src/skills/Workflow.ts:17
Parameters
name?
string = "workflow"
Returns
Workflow<TContext>
Properties
name
readonlyname:string="workflow"
Defined in: src/skills/Workflow.ts:17
Accessors
steps
Get Signature
get steps(): readonly
WorkflowStep<TContext>[]
Defined in: src/skills/Workflow.ts:29
Returns
readonly WorkflowStep<TContext>[]
Methods
step()
step(
name,run,priority?):this
Defined in: src/skills/Workflow.ts:20
Appends a step. Lower priority runs earlier; the default is 10.
Parameters
name
string
run
(context) => TContext | Promise<TContext>
priority?
number = 10
Returns
this
call()
call(
context):Promise<TContext>
Defined in: src/skills/Workflow.ts:34
Runs every step in order and returns the final context.
Parameters
context
TContext
Returns
Promise<TContext>
run()
run(
context):Promise<{ok:true;context:TContext;completed:string[]; } | {ok:false;context:TContext;completed:string[];failedStep:string;error:unknown; }>
Defined in: src/skills/Workflow.ts:48
Runs every step, stopping at the first failure and reporting which step failed rather than surfacing a bare error.
Parameters
context
TContext
Returns
Promise<{ ok: true; context: TContext; completed: string[]; } | { ok: false; context: TContext; completed: string[]; failedStep: string; error: unknown; }>